doc-audit

doc-audit 是对 agent-ready 文档脚手架的维护配套工具：agent-ready 负责搭建文档，doc-audit 负责保持其准确。它通过对比文档与真实代码结构，审计文档的准确性、完整性与新鲜度。\n\n用途与模式：根据用户意图选择模式。audit（默认，只读）用于检查文档健康，触发语如“audit docs”“check documentation”；fix 用于修复问题，触发语如“fix docs”“update documentation”；full 用于完整分析并生成改进路线图。意图不明确时默认只读的 audit，不修改任何文件。\n\n主要能力：审计四个维度——完整性（是否存在预期文档产物，如 AGENTS.md/CLAUDE.md、ARCHITECTURE.md、docs/ 与 ADR）；准确性（文档中的文件路径、端口号、构建/测试/运行命令、依赖与技术引用是否与代码、docker-compose.yml、.env、package.json 等一致）；新鲜度（文档最后修改时间与代码活动的对比）；一致性（断链、重复内容、冲突指令、CLAUDE.md 是否为 AGENTS.md 的符号链接）。先进行侦察，收集项目类型、文档文件、源码、入口点、配置文件与近期 git 变更，并判断是单包还是 monorepo 结构。\n\nfix 模式会执行完整审计后自动修复安全、机械性的问题，例如更新 ARCHITECTURE.md 中已移动的文件路径、增删代码地图条目、修正明显错误的端口号与环境变量名、将磁盘上已有但未列出的 ADR 加入索引、修复因文件移动导致的相对链接、更新表格中的计数，然后提交变更（如 git commit -m "doc-audit: 修复摘要"）。其余需人工判断的问题会单独报告，如结构性重写、内容不清的过时章节、需要领域知识的缺失文档。\n\nfull 模式在 fix 基础上生成优先级路线图：优先级 1 准确性修复、优先级 2 覆盖缺口、优先级 3 结构改进、优先级 4 流程改进（如文档新鲜度 CI 检查、更新触发条件）。\n\n限制：官方资料未提供安装命令、收费或价格、平台支持范围、具体性能或效果数据；脚本 scripts/recon.sh 的可用性取决于插件目录，不可用时使用等效的 inline 命令。实际运行环境与依赖要求暂未提供。