Docs Guard 是一个文档审查技能,用于在生成的或修改过的文档发布前进行守卫式检查,适用于 README、API 参考、docstring、PHPDoc/JSDoc、changelog、教程和文档站点。其核心原则是:文档是对代码库的一组陈述,每一条都可核查。
主要能力按规则划分。准确性(必须修复):每个被引用的符号(函数、方法、类、hook、CLI 命令、flag、端点、配置键、环境变量、文件路径)都要对照源码、CLI 帮助、路由表或 schema 核实,不可验证的引用不得发布;代码示例必须能跑通,导入可解析、API 签名与文档一致;描述代码实际行为而非预期行为,代码与注释冲突时以代码为准并提示用户;性能数字、兼容性矩阵、规模上限等必须有仓库内可验证来源,否则删除。版本与漂移(应修复):版本要显式说明,废弃项要标注替代方案;代码变更需同步更新所有相关文档面。实质内容(应修复):删除纯复述签名的 docstring、重复标题的段落、营销形容词和填充语;不要转述上游文档而应链接;示例需覆盖失败路径。结构(值得注意):标题、目录、内部链接和锚点应一致,不留 TODO 桩。
使用方式分三种模式:守卫模式(推荐),在文档生成或编辑后逐条对照源码验证并运行自检;实时模式,在写文档前先读实现再记录;审查模式,按 references/review-checklist.md 走查并输出带 file:line 证据的发现报告,未经要求不重写。使用前先读项目的 agent 指令(CLAUDE.md、AGENTS.md)和文档风格指南,项目约定优先。
限制:该技能不审查代码本身(属 clean-code-guard 管辖),不从零生成文档策略或信息架构,也不强制某种文风。资料未提供具体命令、安装方式、收费或平台信息。