codegen-doc

1# 代码生成·项目文档
2 
3本 Skill 指导 Agent 基于**当前项目/代码仓库**生成各类文档，支持四种类型：论文章节、项目梳理、重点问题、简历项目描述。
4 
5## Step 0：任务识别
6 
7| 用户表述 / 关键词 | 执行 |
8|------------------|------|
9| 论文章节、系统设计、总体设计、详细设计 | `reference/thesis-chapter.md` |
10| 项目梳理、项目文档结构、按格式梳理 | `reference/overview.md` |
11| 重点问题、技术难点、待解决问题、项目风险 | `reference/key-issues.md` |
12| 简历项目描述、项目经历、按简历格式 | `reference/resume-format.md` |
13 
14**不属于这四种的情况**：用户要的是给新同事看、能照着上手的项目文档（新人文档、架构文档、代码导读、onboarding），用 **project-docs**。本 Skill 产出的是按对方指定格式写、给导师/评委/HR/领导看的东西。
15 
16## 怎么读项目
17 
18四种类型都要先读代码。不要试图读完所有源文件，分三步：
19 
201. **看轮廓** —— 目录树（排除 `node_modules` / `build` / `dist` / `vendor`）、构建和依赖文件（`package.json` / `pom.xml` / `requirements.txt` / `go.mod` 等）、README，得出项目干什么、用什么技术栈
212. **看骨架** —— 入口文件、路由或接口定义、配置文件、每个顶层目录一句话职责
223. **按类型补读**
23   - 论文章节：部署相关文件、模块之间怎么调用
24   - 项目梳理：用户格式里点名要的部分（写「核心接口」就去读路由表）
25   - 重点问题：`TODO` / `FIXME`、README 的 Known issues / Limitations、异常处理和兜底逻辑
26   - 简历项目描述：可量化的东西（接口数、模块数、测试覆盖），只在真有依据时写
27 
28技术栈、模块名、接口名要和代码逐字一致，不要凭印象改写。
29 
30## 使用时机
31 
32- 用户需要根据当前项目生成论文章节、项目梳理、重点问题清单或简历项目描述
33- 用户提到「根据当前项目」「根据代码」「按这个格式……」
34 
35## 通用原则
36 
37- **不编造**：未在仓库中出现的内容不写入
38- **有据可依**：尽量从代码、注释、README、文档中抽取
39- **格式遵从**：用户提供格式/模板时，严格按格式组织输出