Claude Code 根据源代码审查产品文档
EnglishClaude Code 安装步骤
- 打开 GitHub 固定提交的 `.claude/skills/audit-docs/SKILL.md`,核对内容与使用条件。
- 在自己的项目中创建 `.claude/skills/audit-docs/`,把核对后的文件保存为 `.claude/skills/audit-docs/SKILL.md`。
- 在该项目根目录启动 Claude Code,在斜杠菜单中选择 `/audit-docs`。
中文摘要
逐条核对文档描述与代码,记录按钮、图标、行为和流程的证据,并提出更正内容。
SKILL.md 中文导读
可复现示例
模拟预览功能的文档第 18 行称按钮叫 Download report,前端显示 Export report。样例记录是 `{line:18,claim:'Download report',source:'Export report'}`。工作步骤
- 按文档页逐项提取可核查的按钮、图标和行为描述。
- 以源码证据判断状态,在审阅表给每项差异附上建议文本。
验收方法
在审阅表给第 18 行记录 `{status:'wrong',suggestion:'Export report'}`,同一行列出文档位置、现有说法、实际按钮文本和修改建议。供维护者审阅,当前阶段保持文档文件原样。
GitHub 原文 · 更新日期
适用环境
Claude Code 工作区包含项目源代码和 Markdown 文档。先产出审阅表,由维护者确认。
常见问题
怎么核查文档里的按钮名称是否过时?
把文档页、行号和原句与实现中的显示文本并列。发现差异时提出可直接使用的修订,等待维护者确认。