用途:为几乎没有文档的项目引导生成 docs/ 结构,只根据代码库实际存在的证据来写,避免臆造。
主要能力:生成 docs/architecture.md 与 docs/onboarding.md(始终),内联生成 Nygard 格式的 docs/adr/0001-record-architecture-decisions.md;检测到数据库/ORM 时生成 docs/data-model.md;检测到部署配置(Dockerfile、k8s、CI、IaC)时生成 docs/deployment.md 与 docs/security.md;项目看似协作型(git log 多贡献者、开源许可证、缺少 CONTRIBUTING)时生成 docs/contributing.md 和 docs/rfc/ 目录。
反幻觉规则:每条断言必须来自本次读取或 grep 的内容;引用前先确认文件/目录存在;计数用 ls/find/grep;引用真实函数/类/表名;空目录不算功能;无法验证的断言直接删除。
使用方式:先探索代码库与检测项目特征,再决定生成哪些文档,扫描 docs/ 避免覆盖已有文件(默认仅补缺口),从 assets/templates/ 填充模板并用 grep -oE '{{[A-Z_0-9]+}}' 校验无残留占位符,最后校验 mermaid 图。校验命令示例:npm i -g @mermaid-js/mermaid-cli,或 mmdc() { npx -y -p @mermaid-js/mermaid-cli mmdc "$@"; };沙箱中 Chromium 可用 -p 加 {"args":["--no-sandbox"]} 配置。
适用场景:新项目、缺乏文档的老项目、希望结构化补齐文档并保留 ADR 记录的仓库。
限制:不生成无证据支持的文档类型;已有目标文件不覆盖,需先询问用户;图表校验最多 3 轮,无法安装 mmdc 时改为人工语法审查;用户提供的上下文只用于引导检测,不能替代实际文件验证。具体模板清单、命令细节以官方资料为准,其余未提供。