用途:确保项目拥有完整且最新的文档,通过审计、修复、验证三步走,每次运行都做完整流程,不提供部分模式。
主要能力:审计 README、ARCHITECTURE/CODEBASE_MAP、CONTRIBUTING、.env.example、ADR 目录、API 文档与子目录 README 是否存在;用 find 检查文档是否 90 天以上未更新;用 lychee 检查链接有效性;生成缺失的 README、架构文档、.env.example、CONTRIBUTING 和 ADR 模板;更新过时文档并核对 git log;验证链接、示例语法与文档完整性,失败则回到修复步骤。
使用方式:假设从 master/main 开始,先创建分支 git checkout -b docs/update-$(date +%Y%m%d)。随后执行审计、按项目类型规划优先级、生成或更新文档、验证结果。生成 README 等可用 codex exec 委派,架构文档通过 /cartographer 生成,链接检查用 lychee --offline,示例可用 pnpm tsc --noEmit 检查。
适用场景:普通项目、应用、库、monorepo 和开源项目,分别对应 README、.env.example、架构文档、ADR、API 文档、CONTRIBUTING、子目录 README 等必要文档。
限制:资料中未说明具体收费、价格、平台支持和效果数据;部分工具(lychee、Vale、Cartographer、Codex)需另行安装或可用,缺失时仅能退化处理或提示安装。