codegen-doc
Installation
SKILL.md
代码生成·项目文档
本 Skill 指导 Agent 基于当前项目/代码仓库生成各类文档,支持四种类型:论文章节、项目梳理、重点问题、简历项目描述。
Step 0:任务识别
| 用户表述 / 关键词 | 执行 |
|---|---|
| 论文章节、系统设计、总体设计、详细设计 | reference/thesis-chapter.md |
| 项目梳理、项目文档结构、按格式梳理 | reference/overview.md |
| 重点问题、技术难点、待解决问题、项目风险 | reference/key-issues.md |
| 简历项目描述、项目经历、按简历格式 | reference/resume-format.md |
不属于这四种的情况:用户要的是给新同事看、能照着上手的项目文档(新人文档、架构文档、代码导读、onboarding),用 project-docs。本 Skill 产出的是按对方指定格式写、给导师/评委/HR/领导看的东西。
怎么读项目
四种类型都要先读代码。不要试图读完所有源文件,分三步: