Back to Details

codegen-doc

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

代码生成·项目文档

Code Generation · Project Documentation

本 Skill 指导 Agent 基于当前项目/代码仓库生成各类文档，支持四种类型：论文章节、项目梳理、重点问题、简历项目描述。
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：任务识别

Step 0: Task Identification

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

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