项目文档生成器

解决的具体问题

很多项目能跑，但交接成本高：目录结构、模块关系、接口参数、数据库字段和部署步骤分散在代码里。人工补文档容易漏掉边界条件和版本变更。

工作方式

该技能以项目代码为输入，先分析目录结构、核心代码、领域模型、数据仓储、业务逻辑、设计模式和架构，再生成中英文文档。它会检查 Git 状态，用 git rev-list --count HEAD 等命令生成版本信息；作者按当前用户、最近 Git 提交作者、留空三级优先级填写。文档通常写入 Doc/cn/ 和 Doc/en/，并覆盖 需求规格、概要设计、详细设计、数据库设计、API 文档、测试计划、部署与用户手册。

适用边界

它适合有可分析代码库、需要快速形成完整文档套件的场景；对仅口述需求、代码不可读或强依赖私有上下文的项目，仍需人工补全业务背景。文档中的接口、表结构和部署步骤应结合真实环境复核后再用于发布。