用途:在文档由 docs-pr-write 或其他流程创建或更新后、提交前进行质量评审。需提供待评审的文件路径,以及写作阶段遗留的待办项或不确定的技术声明。
开始前:按 ../shared/load-context.md 加载本地上下文;若需区分自动生成页面与手工编写页面而无本地上下文文件,先询问用户。阅读 ../shared/style-guide.md 并在全程应用其规则。
主要步骤:
- 校验输入并分类改动。确认每个待评审文件路径存在且非空,否则停止并报告;分类为风格/编辑类(a)或技术内容类(b),无法确定时归为 b,技术内容需阅读 references/technical-verification.md 并同步执行核对。
- 运行 Vale 散文检查器(安装见 https://vale.sh/docs/install/)。配置与自定义规则位于 writers-toolkit 仓库:配置 https://github.com/grafana/writers-toolkit/blob/main/.vale.ini,规则 https://github.com/grafana/writers-toolkit/tree/main/vale/Grafana。已安装时运行:bash .claude/skills/shared/vale-compact.bash <file_path>;未安装则手动按风格指南检查。
- 检查 frontmatter:title 与 description 是否存在、aliases 是否正确(尤其文件移动后)、字段是否符合风格指南的 topicType 模板。
- 检查风格:现在时、主动语态、第二人称;标题用句首大写;链接用“refer to”而非“see”;内部链接以“/”结尾;慎用提示块。
- 扫描敏感数据:凭证、API 密钥、令牌、密码、内部主机名、真实用户数据(邮箱、IP)、私有 URL。真实密钥或用户数据应停止并升级为高优先级发现,提示其可能已提交并留存于 git 历史,需在源头轮换或失效,替换页面内容不等于修复泄露;明显示例值规范为标准占位符并记录。占位符目录参见 ../shared/handling-pr-content.md。
- 检查链接:验证内部链接指向已存在页面,并确认相关页面间存在有用的交叉链接。
- 修复并复查:修复问题,重跑 Vale 直至通过,重读改动部分确认未引入新问题。
- 输出结果:按文件给出分类、风格与技术准确性问题、敏感数据发现与替换、frontmatter 与链接检查结果、改动摘要;技术评审需列出已对照代码验证的声明及分歧。最后询问:是否创建 PR,还是先在本地审阅改动。
注意事项:既有文档中的 Vale 指令常为有意的抑制,无理由不要删除;生成参考页除非本地上下文另有说明,否则不要手工编辑;发布说明按惯例可在文件顶部使用 Vale 抑制;风格指南要求“refer to”而非“see”,但 Next Steps 中的链接文本可直接使用链接文字。
参考资料:../shared/style-guide.md、../shared/handling-pr-content.md、references/technical-verification.md、../shared/verification-checklist.md、../shared/docs-context-guide.md。