hylarucoder/skills-for-vibe-coder/doc-consistency-reviewer

Claude Code and agent skill by hylarucoder/skills-for-vibe-coder

Trust tier 2
  • community
LLM review pending
Source check pending

Checking that the SKILL.md file is still in the repository.

文档一致性审核官，检查代码实现与文档说明的一致性。当用户请求审查文档与代码的一致性、检查 README/docs 是否过时、验证 API 文档准确性时使用此技能。适用于：(1) 审查 README 与实现一致性 (2) 检查 docs/ 目录文档是否过时 (3) 验证 API/配置文档准确性 (4) 生成文档一致性报告。触发词包括：文档审查、doc review、文档一致性、documentation consistency、检查文档过时、verify docs。

Install

npx vskill@latest install hylarucoder/skills-for-vibe-coder/doc-consistency-reviewer

SKILL.md

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

严重级别

级别定义示例
P0安全问题/严重误导文档称已启用沙箱但代码未启用
P1核心功能不一致按文档操作会失败
P2示例不完整/命名不一致不直接阻断使用
P3措辞/格式/链接小问题不影响功能
待证据补充有怀疑但证据不足需进一步调查

输出格式

详细模板见 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 报告文件。

Security

  • Security scanPassed, 100 of 100Pattern checks on the skill's files.
  • Model reviewNot runA model review is scheduled for the next rescan.

See the full security report

Quality evaluation

  • Task evaluationNot runNo evaluation yet. Run one in Skill Studio.

See evaluation results

Source

Popularity

Repository stars
53
Repository forks
5
7-day trend score
20

Stars and forks are for the whole GitHub repository, not this skill alone. Refreshed 30 Mar 2026, 7 months ago.

Works with

Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.

  • Claude Code
  • Cursor
  • GitHub Copilot
  • Windsurf
  • Codex
  • Gemini CLI
  • Cline
  • Amp
  • Roo Code
  • Goose
  • Continue
  • Kilo Code
  • Junie
  • Trae
  • OpenHands
  • Qwen Code
  • AI Agent
  • Tabnine Chat
  • Sourcegraph Cody
  • Amazon Q
  • Firebase Genkit
  • Sweep
  • Devin
  • Phind
  • Mentat
  • Claude Desktop
  • Aider
  • GPT Pilot
  • Plandex
  • bolt.new
  • v0
  • Replit Agent
  • Anse
  • TypingMind
  • BetterChatGPT
  • LibreChat
  • Warp AI
  • Pieces
  • Fig AI
Embed badge
vskill VERIFIED badge
[![vskill VERIFIED](https://verified-skill.com/api/v1/skills/hylarucoder/skills-for-vibe-coder/doc-consistency-reviewer/badge)](https://verified-skill.com/skills/hylarucoder/skills-for-vibe-coder/doc-consistency-reviewer)

Something wrong with this skill or its page? Tell us.