codegen-doc

---
name: codegen-doc
description: 基于当前项目/代码生成各类文档，支持论文章节、项目梳理、重点问题、简历项目描述四种类型。当用户提到生成论文章节、项目梳理、技术难点、简历项目描述时使用。要给新同事看的上手文档（新人文档、架构文档、代码导读、onboarding）用 project-docs。
---

# 代码生成·项目文档

本 Skill 指导 Agent 基于**当前项目/代码仓库**生成各类文档，支持四种类型：论文章节、项目梳理、重点问题、简历项目描述。

## Step 0：任务识别

| 用户表述 / 关键词 | 执行 |
|------------------|------|
| 论文章节、系统设计、总体设计、详细设计 | `reference/thesis-chapter.md` |
| 项目梳理、项目文档结构、按格式梳理 | `reference/overview.md` |
| 重点问题、技术难点、待解决问题、项目风险 | `reference/key-issues.md` |
| 简历项目描述、项目经历、按简历格式 | `reference/resume-format.md` |

**不属于这四种的情况**：用户要的是给新同事看、能照着上手的项目文档（新人文档、架构文档、代码导读、onboarding），用 **project-docs**。本 Skill 产出的是按对方指定格式写、给导师/评委/HR/领导看的东西。

## 怎么读项目

四种类型都要先读代码。不要试图读完所有源文件，分三步：

1. **看轮廓** —— 目录树（排除 `node_modules` / `build` / `dist` / `vendor`）、构建和依赖文件（`package.json` / `pom.xml` / `requirements.txt` / `go.mod` 等）、README，得出项目干什么、用什么技术栈
2. **看骨架** —— 入口文件、路由或接口定义、配置文件、每个顶层目录一句话职责
3. **按类型补读**
   - 论文章节：部署相关文件、模块之间怎么调用
   - 项目梳理：用户格式里点名要的部分（写「核心接口」就去读路由表）
   - 重点问题：`TODO` / `FIXME`、README 的 Known issues / Limitations、异常处理和兜底逻辑
   - 简历项目描述：可量化的东西（接口数、模块数、测试覆盖），只在真有依据时写

技术栈、模块名、接口名要和代码逐字一致，不要凭印象改写。

## 使用时机

- 用户需要根据当前项目生成论文章节、项目梳理、重点问题清单或简历项目描述
- 用户提到「根据当前项目」「根据代码」「按这个格式……」

## 通用原则

- **不编造**：未在仓库中出现的内容不写入
- **有据可依**：尽量从代码、注释、README、文档中抽取
- **格式遵从**：用户提供格式/模板时，严格按格式组织输出

From xstongxue/best-skills at 9aa4e55, shown as plain text under its license: Apache-2.0 (permissive). The license text is in LICENSE.

• SKILL.md2.7 KB · 6cacf5704372
• reference/
• key-issues.md1.8 KB · a3e120975d81
• overview.md1.4 KB · 5d502bd79bbc
• resume-format.md1.7 KB · 91e87de64cae
• thesis-chapter.md1.8 KB · 27657f1053b3

5 files, 9.4 KB in total. Each file has a sha256 in the pin's manifest; the first 12 characters are shown.