Agent skill · writing content · aiskillstore
doc-consistency-reviewer
文档一致性审核官，检查代码实现与文档说明的一致性。当用户请求审查文档与代码的一致性、检查 README/docs 是否过时、验证 API 文档准确性时使用此技能。适用于：(1) 审查 README 与实现一致性 (2) 检查 docs/ 目录文档是否过时 (3) 验证 API/配置文档准确性 (4) 生成文档一致性报告。触发词包括：文档审查、doc review、文档一致性、documentation consistency、检查文档过时、verify docs。
Why this skill is useful
Provides a systematic approach to document consistency checks that the AI wouldn't reliably generate on its own.
What it needs
About 1k tokens when loaded. Last updated 2026-08-07. 405 stars on the source repository.
What this skill does
Documentation Consistency Reviewer 目标 系统性找出 README + docs/ 中所有「过时」或「与实现不一致」的描述，输出 ≥30 条问题项。 核心原则 1. 以代码为真 - 文档与代码冲突时，以源码/配置/合同文件为准 2. 有证据再下结论 - 每条问题必须引用代码/配置位置作为依据 3. 合同优先 - OpenAPI/proto/schema/TS types 视为 SSOT 4. 安全默认收紧 - 安全相关不一致优先标记为高严重级别 审核流程 1. 文档枚举 2. 逐文档审阅 对每份文档： 1. 列出关键声明/承诺/配置/接口条目 2. 在代码中搜索对应实现 3. 对比差异：缺失/重命名/行为不一致/默认值不一致 4. 按模板记录问题项 3. 横向交叉检查 从合同文件反向检查文档 从配置文件反查文档 详细检查清单见 references/checklist.md 严重级别 级别 定义 示例 ------ ------ ------ P0 安全问题/严重误导 文档称已启用沙箱但代码未启用 P1 核心功能不一致 按文档操作会失败 P2 示例不完整/命名不一致 不直接阻断使用 P3 措辞/格式/链接小问题 不影响功能 待证据补充 有怀疑但证据不足 需进一步调查 输出格式 详细模板见 references/output-format.md 单个问题项 审核结论 多 Agent 并行 如需加速，可按以下维度拆分给多个 agent 并行执行： 1. 按文档类型拆分 - README、API 文档、开发指南各一个 agent 2. 按模块拆分 - 不同功能模块的文档各一个 agent 3. 按检查方向拆分 - 一个从文档查代码，一个从代码查文档 汇总时需去重和统一严重级别。 执行 审阅完成后，输出 doc-consistency.md 报告文件。
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aiskillstore/doc-consistency-reviewer