关于 review-docs
review-docs 是一项文档审查技能,指导 Agent 使用相应的写作与风格技能检查文件。它按内容类型安排并行审查,并要求汇总带行号的问题清单。
主要功能
- 01并行审查任务清单
- 02按文档类型选择检查项
- 03语气与组件审查提示
- 04适用文件的 Sandpack 审查
- 05汇总带行号的发现
适用场景
- 01审查已修改的文档文件
- 02检查学习、参考或博客内容
- 03核对文档语气与组件使用
- 04整理问题以制定修复计划
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ reactjs/ react.dev --skill review-docs安装后在 Claude Code 中输入/review-docs确认已加载。
详细介绍
重要:请勿自行加载这些技能。
针对给定文件并行运行以下任务。每个 Agent 检查不同方面——并非每项都适用于每个文件:
- 请 docs-reviewer Agent 使用 docs-writer-learn 检查 {files}(仅适用于 src/content/learn/ 中的文件)。
- 请 docs-reviewer Agent 使用 docs-writer-reference 检查 {files}(仅适用于 src/content/reference/ 中的文件)。
- 请 docs-reviewer Agent 使用 docs-writer-blog 检查 {files}(仅适用于 src/content/blog/ 中的文件)。
- 请 docs-reviewer Agent 使用 docs-voice 检查 {files}(适用于所有文档文件)。
- 请 docs-reviewer Agent 使用 docs-components 检查 {files}(适用于所有文档文件)。
- 请 docs-reviewer Agent 使用 docs-sandpack 检查 {files}(适用于包含 Sandpack 示例的文件)。
如果未指定文件,请检查 git status,查找 src/content/ 中已修改的 MDX 文件。
docs-reviewer 将返回一份列出所发现问题的清单。请提供所有 Agent 返回的完整清单及行号,并提示用户制定计划来修复这些问题。
评论
支持 Markdown