Agent Skills › videojs/video.js › review-docs

review-docs

GitHub

用于审查 Video.js 文档的准确性、结构、语气及 MDX 规范，不直接编辑。通过验证声明与代码一致性，识别内容错配并报告修复建议，确保读者体验和文档质量。

.agents/skills/review-docs/SKILL.md videojs/video.js

触发场景

审查文档准确性检查文档结构与规范

安装

npx skills add videojs/video.js --skill review-docs -g -y

更多选项

非标准路径

npx skills add https://github.com/videojs/video.js/tree/main/.agents/skills/review-docs -g -y

不安装直接使用

npx skills use videojs/video.js@review-docs

指定 Agent (Claude Code)

npx skills add videojs/video.js --skill review-docs -a claude-code -g -y

安装 repo 全部 skill

npx skills add videojs/video.js --all -g -y

预览 repo 内 skill

npx skills add videojs/video.js --list

SKILL.md

Frontmatter

{
    "name": "review-docs",
    "description": "Review Video.js documentation without editing it. Use for accuracy, reader outcomes, structure, voice, examples, MDX, READMEs, or docs diffs."
}

Documentation review

Treat implementation, types, tests, schemas, and generated output as factual sources.

Identify the audience, intended outcome, artifact type, and owning source files.
For site guides and concepts, read site/src/content/docs/writing-style/write-guides.mdx. For generated reference pages, read site/src/content/docs/writing-style/write-references.mdx. Use neighboring docs for other artifact types.
Verify claims and examples against current code before reviewing voice, structure, examples, MDX conventions, and reader outcomes against the owning guide.
For every site page, state which shape it claims (how-to, concept, or reference) and whether its prose reads that way, using .agents/skills/write-docs/references/diataxis.md. Task headings, install commands, or numbered steps on a concept; how-to sections, opinion, or persuasion on a reference; teaching beyond "How it works" on a how-to. Report a mismatch as a finding even when the prose is otherwise good.
Render affected MDX, run examples where practical, and run pnpm -F site test diataxis for site content.

Report broken or misleading content first. For each finding, give the location, reader impact, evidence, and concise fix. Keep stylistic preferences separate from correctness issues.