---
id: xstongxue/best-skills/codegen-doc
version: "ba087ed0"
license: Apache-2.0
install: manual
updated: 2026-07-19
---

# codegen-doc — Codegen-doc guides your agent to produce structured documentation directly from project code and repositories. It supports four document types—thesis chapters, project overviews, key technical issues, and resume project descriptions—automatically triggering when you mention these formats.

Publisher: xstongxue · Stars: 2407 · Updated: 2026-07-19

Install (manual): `git clone https://github.com/xstongxue/best-skills`

## SKILL.md

# 代码生成·项目文档

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

## Step 0：任务识别

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

## 使用时机

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

## 通用原则

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

[View on SkillFed](https://skillfed.io/xstongxue/best-skills/codegen-doc) · [View on GitHub](https://github.com/xstongxue/best-skills)