doc-consistency-reviewer
文档一致性审核官，检查代码实现与文档说明的一致性。当用户请求审查文档与代码的一致性、检查 README/docs 是否过时、验证 API 文档准确性时使用此技能。适用于：(1) 审查 README 与实现一致性 (2) 检查 docs/ 目录文档是否过时 (3) 验证 API/配置文档准确性 (4) 生成文档一致性报告。触发词包括：文档审查、doc review、文档一致性、documentation consistency、检查文档过时、verify docs。
Best use case
doc-consistency-reviewer is best used when you need a repeatable AI agent workflow instead of a one-off prompt. It is especially useful for teams working in multi. 文档一致性审核官，检查代码实现与文档说明的一致性。当用户请求审查文档与代码的一致性、检查 README/docs 是否过时、验证 API 文档准确性时使用此技能。适用于：(1) 审查 README 与实现一致性 (2) 检查 docs/ 目录文档是否过时 (3) 验证 API/配置文档准确性 (4) 生成文档一致性报告。触发词包括：文档审查、doc review、文档一致性、documentation consistency、检查文档过时、verify docs。
文档一致性审核官，检查代码实现与文档说明的一致性。当用户请求审查文档与代码的一致性、检查 README/docs 是否过时、验证 API 文档准确性时使用此技能。适用于：(1) 审查 README 与实现一致性 (2) 检查 docs/ 目录文档是否过时 (3) 验证 API/配置文档准确性 (4) 生成文档一致性报告。触发词包括：文档审查、doc review、文档一致性、documentation consistency、检查文档过时、verify docs。
Users should expect a more consistent workflow output, faster repeated execution, and less time spent rewriting prompts from scratch.
Practical example
Example input
Use the "doc-consistency-reviewer" skill to help with this workflow task. Context: 文档一致性审核官，检查代码实现与文档说明的一致性。当用户请求审查文档与代码的一致性、检查 README/docs 是否过时、验证 API 文档准确性时使用此技能。适用于：(1) 审查 README 与实现一致性 (2) 检查 docs/ 目录文档是否过时 (3) 验证 API/配置文档准确性 (4) 生成文档一致性报告。触发词包括：文档审查、doc review、文档一致性、documentation consistency、检查文档过时、verify docs。
Example output
A structured workflow result with clearer steps, more consistent formatting, and an output that is easier to reuse in the next run.
When to use this skill
- Use this skill when you want a reusable workflow rather than writing the same prompt again and again.
When not to use this skill
- Do not use this when you only need a one-off answer and do not need a reusable workflow.
- Do not use it if you cannot install or maintain the related files, repository context, or supporting tools.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/doc-consistency-reviewer/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How doc-consistency-reviewer Compares
| Feature / Agent | doc-consistency-reviewer | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
文档一致性审核官，检查代码实现与文档说明的一致性。当用户请求审查文档与代码的一致性、检查 README/docs 是否过时、验证 API 文档准确性时使用此技能。适用于：(1) 审查 README 与实现一致性 (2) 检查 docs/ 目录文档是否过时 (3) 验证 API/配置文档准确性 (4) 生成文档一致性报告。触发词包括：文档审查、doc review、文档一致性、documentation consistency、检查文档过时、verify docs。
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
Related Guides
SKILL.md Source
# Documentation Consistency Reviewer ## 目标 系统性找出 README + docs/ 中所有「过时」或「与实现不一致」的描述，输出 ≥30 条问题项。 ## 核心原则 1. **以代码为真** - 文档与代码冲突时，以源码/配置/合同文件为准 2. **有证据再下结论** - 每条问题必须引用代码/配置位置作为依据 3. **合同优先** - OpenAPI/proto/schema/TS types 视为 SSOT 4. **安全默认收紧** - 安全相关不一致优先标记为高严重级别 ## 审核流程 ### 1. 文档枚举 ```bash # 扫描范围 - README.md (根目录) - docs/**/*.md (所有文档) - 合同文件: OpenAPI/proto/GraphQL schema/TS types ``` ### 2. 逐文档审阅 对每份文档： 1. 列出关键声明/承诺/配置/接口条目 2. 在代码中搜索对应实现 3. 对比差异：缺失/重命名/行为不一致/默认值不一致 4. 按模板记录问题项 ### 3. 横向交叉检查 - 从合同文件反向检查文档 - 从配置文件反查文档 详细检查清单见 [references/checklist.md](references/checklist.md) ## 严重级别 | 级别 | 定义 | 示例 | |------|------|------| | P0 | 安全问题/严重误导 | 文档称已启用沙箱但代码未启用 | | P1 | 核心功能不一致 | 按文档操作会失败 | | P2 | 示例不完整/命名不一致 | 不直接阻断使用 | | P3 | 措辞/格式/链接小问题 | 不影响功能 | | 待证据补充 | 有怀疑但证据不足 | 需进一步调查 | ## 输出格式 详细模板见 [references/output-format.md](references/output-format.md) ### 单个问题项 ```markdown ### [标题] - **严重级别**: P0/P1/P2/P3/待证据补充 - **位置**: `<文件路径>:<行号>` - **证据**: - 文档: [引用] - 代码: [引用] - **影响**: [误导后果] - **建议**: [最小修正] - **关联原则**: 以代码为真/合同优先/安全默认收紧/... ``` ### 审核结论 ```markdown ## 审核结论 - **结论**: 通过/有条件通过/不通过 - **汇总**: P0:x P1:x P2:x P3:x 待补充:x - **修复优先级**: P0 → P1 → P2 → P3 ``` ## 多 Agent 并行 如需加速，可按以下维度拆分给多个 agent 并行执行： 1. **按文档类型拆分** - README、API 文档、开发指南各一个 agent 2. **按模块拆分** - 不同功能模块的文档各一个 agent 3. **按检查方向拆分** - 一个从文档查代码，一个从代码查文档 汇总时需去重和统一严重级别。 ## 执行 审阅完成后，输出 `doc-consistency.md` 报告文件。
Related Skills
clean-code-reviewer
Analyze code quality based on "Clean Code" principles. Identify naming, function size, duplication, over-engineering, and magic number issues with severity ratings and refactoring suggestions. Use when the user requests code review, quality check, refactoring advice, Clean Code analysis, code smell detection, or mentions terms like 代码体检, 代码质量, 重构检查.
examples-code-reviewer
AI-powered code review tool that analyzes code for bugs, style issues, and improvements
business-consistency
Maintain NAP (Name, Address, Phone) consistency across all platforms. Use when managing citations, updating business info, or generating schema markup.
code-consistency-validator
Validates type consistency across Rust, TypeScript, PostgreSQL boundaries. Use when reviewing code, debugging type mismatches, or validating API contracts. Triggers on: check consistency, validate types, find mismatches, cross-language.
quality-reviewer
Deep code review with web research to verify against latest ecosystem. Use when user says 'double check against latest', 'verify versions', 'check security', 'review against docs', or needs deep analysis beyond automatic quality hook.
plot-consistency-checker
Analyzes narrative plot points, timelines, and story events to identify inconsistencies, plot holes, continuity errors, and pacing issues. Use when the user needs help ensuring their story remains logically consistent and well-paced.
code-reviewer
Use when asked to review MERN stack code - comprehensive code reviewer that checks project health, security, maintainability, performance, testing, and architecture. Combines general code quality analysis with MERN-specific expertise.
azure-quotas
Check/manage Azure quotas and usage across providers. For deployment planning, capacity validation, region selection. WHEN: "check quotas", "service limits", "current usage", "request quota increase", "quota exceeded", "validate capacity", "regional availability", "provisioning limits", "vCPU limit", "how many vCPUs available in my subscription".
raindrop-io
Manage Raindrop.io bookmarks with AI assistance. Save and organize bookmarks, search your collection, manage reading lists, and organize research materials. Use when working with bookmarks, web research, reading lists, or when user mentions Raindrop.io.
zlibrary-to-notebooklm
自动从 Z-Library 下载书籍并上传到 Google NotebookLM。支持 PDF/EPUB 格式，自动转换，一键创建知识库。
discover-skills
当你发现当前可用的技能都不够合适（或用户明确要求你寻找技能）时使用。本技能会基于任务目标和约束，给出一份精简的候选技能清单，帮助你选出最适配当前任务的技能。
web-performance-seo
Fix PageSpeed Insights/Lighthouse accessibility "!" errors caused by contrast audit failures (CSS filters, OKLCH/OKLAB, low opacity, gradient text, image backgrounds). Use for accessibility-driven SEO/performance debugging and remediation.