用途:对照当前代码库审计文档质量,检测过时内容、缺失章节、失效链接和与代码不符的“幻觉”声明。全程只读,绝不编辑或写入任何文档文件。
主要能力:反幻觉检测,逐条核对文档声明与真实代码,包括组件/服务名称、数量(如文档称“5 个服务”则实际计数)、文件路径引用、Mermaid 图实体、技术栈与关系声明。验证类别涵盖名称、数字、图表实体、路径、技术声明和关系声明。
使用方式:扫描 docs/、docs/adr/、docs/rfc/、顶层 README.md、CONTRIBUTING.md 等文档,按文件名推断分类;从代码库检测技术栈、数据库、部署配置和项目类型。可传入可选焦点关键词匹配分类,无参数则检查全部。小文档集直接内联用 Read/Grep/Glob/git 验证;大型多文档审计可为每份文档或逻辑章节启动一个 Explore 子代理独立验证,无 Task 工具时改为顺序内联处理。
校验与评级:检查相关性、新鲜度(git log 最后修改日期对比相关代码变更)、完整性(必需章节、未替换的 {{PLACEHOLDER}}、图表)、质量(Mermaid 语法、内部链接、空章节)。Mermaid 通过渲染验证,需 mmdc:npm i -g @mermaid-js/mermaid-cli,或临时定义 mmdc() { npx -y -p @mermaid-js/mermaid-cli mmdc "$@"; };沙箱中 Chromium 无法启动时加 -p 传入 {"args":["--no-sandbox"]} 的 puppeteer 配置。每份文档给出粗粒度评级:Good、Stale、Broken、Missing,不做 0-100 数值评分。
输出:状态摘要与各评级计数、按评级分组的文档、幻觉报告(含证据)、带 file:line 的质量问题,以及命名具体后续命令(docs-update、docs-diagram)的可执行建议。
适用场景:新成员入职前、文档评审、重大重构后、发布前检查清单、文档感觉过时时。
限制:非破坏性,只读不改;所有报告的数字(计数、日期、过时天数)必须来自本次会话实际运行的命令,不得估算;修复建议指向 docs-update 或 docs-diagram,本技能只报告。若 mmdc 无法安装,需在报告中说明并改为人工检查语法,标记为未验证。更多细节见 references/verification-patterns.md 与 references/scoring-criteria.md。