用途:审计文档与代码的一致性,找出 README 与文档中已过期或与实现不符的陈述,每条都需有来源证据。审计双向进行,即文档到代码、代码到文档,结果以严重度排序列表呈现而非散文叙述。
主要能力:以代码为真相来源,文档与实现冲突时以源码、配置和契约文件为准;优先采用 OpenAPI、protobuf、GraphQL schema、数据库 schema 和 TypeScript 类型等契约作为强真相来源;安全、权限、沙箱、隐私、计费与破坏性操作的错误声明会被提升严重度。
严重度:P0 安全问题或严重误导性声明;P1 核心流程不符,照文档操作会导致安装、API 使用或执行失败;P2 示例不完整、命名不符或过期非阻塞细节;P3 细小措辞、格式或链接问题;另有“需补充证据”一档表示证据不足的怀疑。
使用方式:先枚举文档范围,用户指定则仅审计指定文件,未指定时默认根 README、docs/**/*.md、API 文档、示例、安装指南与生成文档;再定义 3-8 个具体场景并分主题归类;按 references/checklist.md 逐篇审查文档并搜索对应实现,分类为缺失功能、概念改名、行为变更、默认值过期、命令失效、示例过期、API 形状错误或不受支持声明;随后反向核对实现是否被文档遗漏或误述;最后按 references/output-template.md 组装报告。每条问题包含严重度、文档位置、实现/配置/契约证据、影响、最小建议修复、修复价值与相关原则,结尾给出通过/有条件通过/不通过的总评、各严重度计数和建议修复顺序。范围大时可按文档类型、模块或方向并行,合并时去重并统一严重度。
限制:无代码库作为真相来源的文档间比较、实体/数据模型字段审计、以及按讨论结论重写文档等场景不适用,分别应使用其他技能。中文读者可参考 SKILL.zh_CN.md,但英文 SKILL.md 是执行真相来源。