用途:为任意 git 仓库或代码目录生成结构化、分层的文档,优先供 AI 智能体消费,其次供开发者阅读。触发场景包括:为代码库生成文档、回答“这个项目做什么”、编写新人上手文档、生成 AI 可读文档、基于已有文档回答代码库问题、代码变更后更新文档、只记录某个模块或子目录、按 git 提交或 diff 刷新文档。不适用于独立技术文档(RFC、ADR、runbook)、面向外部消费者的 API 参考文档、开源打包用 README。
主要能力:输出固定结构,包含 OVERVIEW.md(架构、技术栈、项目结构树、模块地图)、GETTING_STARTED.md(本地开发指南,含可运行命令)、INDEX.md(文件到模块的查找表)、modules/(每个主要代码模块一个 markdown,大模块可拆子模块)、patterns/(跨领域关注点文档)、.codedocs.json 清单(记录模块、源路径、git SHA、覆盖率、时间戳)。提供四个子命令:generate 生成全量或限定范围文档;ask 基于文档优先问答;update 增量刷新;status 覆盖率报告。
使用方式:codedocs:generate [path] [--output docs/];codedocs:ask "<question>";codedocs:update --scope path/to/module;codedocs:update --diff [base..head];codedocs:status。生成前先做发现阶段:扫描目录树、从清单文件识别技术栈、映射模块边界、检测跨领域模式,并先给出计划与覆盖率再确认。
限制与注意:文档优先回答,仅在文档缺失、过时或不足时才读源码;覆盖率按源文件数而非行数计算,目标 70%+;模块含 15+ 源文件需拆子模块;清单 SHA 漂移会导致误判过时,建议在干净工作区运行;多语言仓库可能混淆模块边界;GETTING_STARTED.md 需交叉核对 package.json、Makefile 与 CI 配置,不能只抄 README。具体收费、价格、平台与效果资料暂未提供。