codegen-doc

Original：🇨🇳 Chinese
Translated

Generate various types of documents based on the current project/code, supporting four types: thesis chapters, project sorting, key issues, and resume project descriptions. Use this when the user mentions generating thesis chapters, project sorting, technical difficulties, or resume project descriptions.

8installs
Sourcexstongxue/best-skills
Added on

NPX Install

npx skill4agent add xstongxue/best-skills codegen-doc

Tags

Translated version includes tags in frontmatter
document-generationproject-documentationthesis-chapter-creationresume-project-descriptioncode-based-documentation

SKILL.md Content (Chinese)

View Translation Comparison →

Code Generation · Project Documentation

This Skill guides the Agent to generate various types of documents based on the current project/code repository, supporting four types: thesis chapters, project sorting, key issues, and resume project descriptions.

Step 0: Task Identification

User Expression / KeywordsExecution
Thesis chapter, system design, overall design, detailed design
reference/thesis-chapter.md
Project sorting, project document structure, sort by format
reference/overview.md
Key issues, technical difficulties, pending issues, project risks
reference/key-issues.md
Resume project description, project experience, in resume format
reference/resume-format.md

Usage Timing

  • When the user needs to generate thesis chapters, project sorting, key issue lists, or resume project descriptions based on the current project
  • When the user mentions "based on the current project", "based on the code", "follow this format..."

General Principles

  • No Fabrication: Do not include content that does not appear in the repository
  • Evidence-Based: Extract content as much as possible from code, comments, README, and documents
  • Format Compliance: Strictly organize the output according to the format/template provided by the user