用途:在代码变更后审查文档是否同步,防止文档腐化,检查项目内各类文档与 AI 配置文件的准确性与一致性。
主要能力:按七类清单核查。一、README 准确性,如行为描述、安装步骤、示例、依赖与功能列表是否仍有效;二、注释新鲜度,包括注释与代码是否一致、TODO 是否仍有效、函数注释与签名是否匹配;三、API 文档,检查公共接口的文档注释、参数类型与约束、返回值、异常及复杂 API 示例;四、变更日志,是否记录破坏性变更、新功能、修复及迁移说明;五、注释质量,是否解释非显而易见的信息,是否用与代码不同的措辞解释 why 而非 what;六、缺失文档,新的公共 API、配置项、环境变量、CLI 参数是否已记录;七、AI 文档,检查项目中存在的 CLAUDE.md、.cursorrules / .cursorignore、.github/copilot-instructions.md、AGENTS.md、.windsurfrules、.aider.conf.yml、.continue/config.json、.clinerules、.roomodes、CONVENTIONS.md 等文件是否反映当前架构、描述是否准确、彼此是否一致、版本号是否同步。
使用方式:将其作为提交前的文档门禁,在代码改动后逐项核对清单;若发现文档需要代码改动则返回实现阶段,验证通过后结束。资料未提供具体安装或调用命令。
限制:资料仅给出检查框架与严重度分级(如 README 与实际行为矛盾、API 返回值类型错误、陈旧注释引发风险、AI 文档描述已删除文件为 CRITICAL;新公共 API 未记录、破坏性变更未入变更日志、AI 文档版本不一致为 IMPORTANT;陈旧 TODO、可补充注释、README 小改为 SUGGESTION),未提供自动检测机制、支持的平台范围或收费信息。