项目文档生成器
根据项目代码自动生成完整的项目文档套件。
工作流程
1. 理解项目代码
- 分析项目目录结构
- 读取核心代码文件
- 理解领域模型、数据仓储、业务逻辑
- 识别设计模式和架构
2. 版本信息获取
- 检查项目是否使用 Git 版本控制
- 提取 Git 提交记录和提交次数
- 根据当前日期生成版本号：
- 有 Git：版本号格式为
1.{yy}.{Mdd}.{git提交次数}{yy}：年份后两位（如 2026 年为 26）{Mdd}：月份和日期（如 5月9日 为 509）{git提交次数}：通过git rev-list --count HEAD获取- 示例：
1.26.509.1234（2026年5月9日，第1234次提交）
- 无 Git：版本号格式为
1.{yy}.{Mdd}.{hmm}{hmm}：小时和分钟（如 14:30 为 1430）- 示例：
1.26.509.1430（2026年5月9日 14:30）
3. 作者信息获取
生成文档时，作者字段按以下三级优先级获取：
- 第1优先级 — 当前用户：获取调用 Skill 的用户标识（PowerShell: $env:USERNAME，Linux/macOS: whoami）
- 第2优先级 — Git 提交作者：从目标项目的 Git 最近一次提交中提取作者名（git log -1 --format=%an）
- 第3优先级 — 置空：若以上均无法获取，作者字段留空（作者： / Author:）
4. 创建文档目录
在项目根目录下创建 Doc/<项目名称>/cn/（中文）和 Doc/<项目名称>/en/（英文）子目录（如已存在则检阅现有文档作为参考）
5. 生成文档套件
按顺序生成以下文档：
| 序号 | 中文文档 (Doc/cn/) | 英文文档 (Doc/en/) | 内容要点 |
|---|---|---|---|
| 01 | 需求规格.md | 01-Requirement Specification.md | 功能概述、功能需求清单、业务规则需求、非功能需求 |
| 02 | 概要设计.md | 02-Overview Design.md | 系统架构、模块划分、类图关系、核心流程概要、依赖关系 |
| 03 | 详细设计.md | 03-Detailed Design.md | 每个方法的算法流程、分支逻辑、关键实现细节 |
| 04 | 数据库设计.md | 04-Database Design.md | 数据表结构、字段定义、表间关系、索引建议 |
| 05 | API文档.md | 05-API Documentation.md | 接口清单、入参出参、调用示例、异常场景 |
| 06 | 测试计划.md | 06-Test Plan.md | 单元测试用例、边界条件、并发测试、测试数据准备 |
| 07 | 部署手册与用户手册.md | 07-Deployment & User Manual.md | 环境要求、配置项、部署步骤、操作指南、常见问题 |
6. 版本管理
版本号规则
- 有 Git 版本控制：版本号格式为
1.{yy}.{Mdd}.{git提交次数} {yy}：年份后两位（如 2026 年为 26）{Mdd}：月份和日期（如 5月9日 为 509）{git提交次数}：通过git rev-list --count HEAD获取- 示例：
1.26.509.1234（2026年5月9日，第1234次提交） - 无 Git 版本控制：版本号格式为
1.{yy}.{Mdd}.{hmm} {hmm}：小时和分钟（如 14:30 为 1430）- 示例：
1.26.509.1430（2026年5月9日 14:30）
Git 提交记录提取
- 使用
git rev-list --count HEAD获取总提交次数 - 使用
git log --pretty=format:"%h - %s (%an, %ar)" --date=short获取最近提交记录 - 提交记录用于生成变更日志和版本历史
变更日志格式
在每个文档头部包含变更日志：
## 变更日志
| 版本 | 日期 | 作者 | 变更内容 |
|------|------|------|----------|
| 1.26.509.1234 | 2026-05-09 | <动态获取> | 初始版本 |
| 1.26.510.1250 | 2026-05-10 | <动态获取> | 新增XXX章节，修正XXX描述 |
7. 文档头部信息
每个文档必须包含：
# 文档标题
**项目名称**：XXX项目
**作者**：<动态获取>
**日期**：2026-05-09
**版本**：1.26.509.1234
## 变更日志
...
> 说明：作者字段通过"3. 作者信息获取"中定义的三级优先级动态获取，不再使用硬编码的固定作者名。
文档模板参考
详细的文档模板结构请参阅：
- 中文模板：references/cn/document-templates.md
- 英文模板：references/en/document-templates.md
执行检查清单
- [ ] 项目代码已理解
- [ ] 版本信息已获取（Git提交次数或时间戳）
- [ ] Doc/<项目名称>/cn/ 目录已创建
- [ ] Doc/<项目名称>/en/ 目录已创建
- [ ] 01-需求规格.md 已生成
- [ ] 02-概要设计.md 已生成
- [ ] 03-详细设计.md 已生成
- [ ] 04-数据库设计.md 已生成
- [ ] 05-API文档.md 已生成
- [ ] 06-测试计划.md 已生成
- [ ] 07-部署手册与用户手册.md 已生成
- [ ] 所有中文文档包含作者（动态获取）、日期、版本号
- [ ] 所有中文文档包含变更日志
- [ ] 01-Requirement Specification.md 已生成
- [ ] 02-Overview Design.md 已生成
- [ ] 03-Detailed Design.md 已生成
- [ ] 04-Database Design.md 已生成
- [ ] 05-API Documentation.md 已生成
- [ ] 06-Test Plan.md 已生成
- [ ] 07-Deployment & User Manual.md 已生成
- [ ] 所有英文文档包含作者、日期、版本号（新格式）
- [ ] 所有英文文档包含变更日志
