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.
Codegen-doc generates thesis chapters, project overviews, technical issues, and resume descriptions from your codebase.
AI-generated summary based on this skill's SKILL.md
Install
xstongxue/best-skills/codegen-doc · repository language: JavaScript
git clone https://github.com/xstongxue/best-skills
cp -r best-skills/skills/codegen-doc ~/.claude/skills/codegen-docFrequently asked questions
AI-generated answers based on this skill's SKILL.md and metadata
Can codegen-doc generate documentation from my code?
Yes. Codegen-doc analyzes your existing codebase and project files to produce structured documentation automatically. It extracts key information from your repository and formats it into coherent technical documentation without manual rewriting.
What document types does codegen-doc support?
Codegen-doc supports four primary formats: thesis or academic paper chapters, project overviews, resume project descriptions, and technical issue documentation. The skill automatically detects which format you need based on your request and generates appropriately structured output.
How can I create a resume project description using codegen-doc?
Codegen-doc analyzes your project code and automatically generates concise, professional descriptions suitable for resumes and CVs. It extracts the most relevant technical accomplishments and project scope from your codebase, saving you time on manual summarization.
Can codegen-doc extract and document technical challenges?
Yes. Codegen-doc identifies and documents key technical challenges, risks, and issues present in your codebase. It analyzes your project structure to surface problems and design decisions, helping you create comprehensive technical documentation of obstacles and solutions.
How does codegen-doc organize project structure into documentation?
Codegen-doc scans your repository organization and transforms it into formatted, readable documentation. It maps your project's architecture and components into structured sections, making it easy to understand system design and component relationships at a glance.
Can codegen-doc generate academic paper sections from my project?
Yes. Codegen-doc creates thesis or academic paper chapters directly from your project repository. It extracts technical details, methodology, and results from your code to produce publication-ready sections for academic work.
SKILL.md
rendered from the published skill — quoted content, verbatim
代码生成·项目文档
本 Skill 指导 Agent 基于当前项目/代码仓库生成各类文档，支持四种类型：论文章节、项目梳理、重点问题、简历项目描述。
Step 0：任务识别
| 用户表述 / 关键词 | 执行 |
|---|---|
| 论文章节、系统设计、总体设计、详细设计 | reference/thesis-chapter.md |
| 项目梳理、项目文档结构、按格式梳理 | reference/overview.md |
| 重点问题、技术难点、待解决问题、项目风险 | reference/key-issues.md |
| 简历项目描述、项目经历、按简历格式 | reference/resume-format.md |
使用时机
- 用户需要根据当前项目生成论文章节、项目梳理、重点问题清单或简历项目描述
- 用户提到「根据当前项目」「根据代码」「按这个格式……」
通用原则
- 不编造：未在仓库中出现的内容不写入
- 有据可依：尽量从代码、注释、README、文档中抽取
- 格式遵从：用户提供格式/模板时，严格按格式组织输出
Read as markdown · JSON record · Browse the source repository
File tree — 5 files
skills/codegen-doc/SKILL.md
skills/codegen-doc/reference/key-issues.md
skills/codegen-doc/reference/overview.md
skills/codegen-doc/reference/resume-format.md
skills/codegen-doc/reference/thesis-chapter.md