关于 review-doc-consistency
用于核对 README 和文档与实现及契约文件是否一致的技能。它会输出带证据和严重级别的问题，并生成结构化审查报告。
主要功能
- 01对照源代码和契约检查文档
- 02核查功能描述与配置值
- 03优先处理安全相关的不一致
- 04按严重程度分级问题
- 05生成 Markdown 和 JSON 报告
适用场景
- 01核对 README 描述与实际实现
- 02查找过时的 API 或配置说明
- 03检查文档中的安全相关偏差
- 04生成结构化文档审查报告
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/review-doc-consistency确认已加载。
附带文件checklist.mdoutput-format.md
详细介绍
文档一致性审查员
目标
系统地找出 README + docs/ 中所有“过时”或“与实现不一致”的描述，并输出 ≥30 个问题项。
核心原则
- 代码即事实 - 当文档与代码冲突时，以源代码/配置/契约文件为准
- 先证据，后结论 - 每个问题都必须引用代码/配置位置作为证据
- 契约优先 - OpenAPI/proto/schema/TS 类型视为 SSOT（单一事实来源）
- 默认收紧安全要求 - 优先处理与安全相关的不一致，严重性设为高
审查流程
1. 文档枚举
# Scan scope
- README.md (root directory)
- docs/**/*.md (all documentation)
- Contract files: OpenAPI/proto/GraphQL schema/TS types
2. 逐文档审查
对于每份文档：
- 列出关键声明/承诺/配置/接口项
- 在代码中查找对应实现
- 对比差异：缺失/重命名/行为不匹配/默认值不匹配
- 使用模板记录问题
3. 交叉核对
- 根据契约文件反向核对文档
- 根据配置文件反向核对文档
详细审查清单请参见 checklist.md。
严重性级别
| 级别 | 定义 | 示例 |
|---|---|---|
| P0 | 安全问题/严重误导 | 文档称已启用沙箱，但代码并未启用 |
| P1 | 核心功能不一致 | 按照文档操作会导致失败 |
| P2 | 示例不完整/命名不一致 | 不会直接阻碍使用 |
| P3 | 措辞/格式/链接方面的小问题 | 不影响功能 |
| 待补充证据 | 有疑点但证据不足 | 需要进一步调查 |
输出格式
详细模板请参见 output-format.md。
单个问题项
### [Title]
- **Severity**: P0/P1/P2/P3/Pending Evidence
- **Location**: `<file_path>:<line_number>`
- **Evidence**:
- Documentation: [quote]
- Code: [quote]
- **Impact**: [Misleading consequences]
- **Suggestion**: [Minimal fix]
- **Related Principle**: Code is truth/Contracts first/Security default tightening/...
审查结论
## Review Conclusion
- **Verdict**: Pass/Conditional Pass/Fail
- **Summary**: P0:x P1:x P2:x P3:x Pending:x
- **Fix Priority**: P0 → P1 → P2 → P3
多 Agent 并行
为提高效率，可按以下维度拆分任务，交由多个 Agent 并行执行：
- 按文档类型 - 每个 Agent 分别负责 README、API 文档、开发指南
- 按模块 - 每个 Agent 负责一个功能模块的文档
- 按检查方向 - 一个 Agent 检查文档与代码是否一致，另一个检查代码与文档是否一致
汇总时需要去重并统一评定严重性。
执行
审查完成后，输出 doc-consistency.md 报告文件，并同时输出 doc-consistency.json（用于汇总/去重/统计的结构化问题列表）。
评论
支持 Markdown