Codegen Doc

代码生成·项目文档

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

Step 0：任务识别

使用时机

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

通用原则

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

项目重点问题

基于当前项目代码与文档，识别并整理项目的「重点问题」：技术难点、设计决策、待解决问题、风险点或核心议题等。

使用时机

• 用户希望梳理「重点问题」「技术难点」「待解决问题」「项目风险」「设计中的关键决策」
• 用户提供格式（如「问题/影响/解决方案」表格、Q&A、P0/P1/P2 分级），希望按格式生成
• 用于毕设答辩「存在的问题与改进」、项目汇报「风险与难点」、技术文档「已知问题」

总体思路

1. 明确范畴：技术难点、设计权衡、已知 Bug/限制、性能风险、安全考虑，或待讨论核心议题 2. 从项目中识别依据：代码、注释、README、TODO/FIXME、Issue、文档 3. 按用户格式组织：表格、Q&A、分级，或默认分块列表

工作流程

1. 确认范围与格式：解析用户口径（只要技术难点/待解决 Bug/含设计决策）及格式 2. 从仓库识别：TODO/FIXME、Known issues、Limitations、Future work、设计说明、非常规依赖、单点瓶颈等 3. 分类与归纳：技术难点、设计决策、待解决问题、风险与限制；合并重复，每类 3–7 条 4. 按格式生成：表格按列填写、Q&A 格式、分级归入 P0/P1/P2，或分块列表 5. 注明依据：说明信息来自哪些位置，不虚构无依据的「问题」

注意事项

• 有据可依：每条尽量能在代码/注释/文档中找到对应
• 表述客观：使用「当前实现存在……」「README 中标注了……」等
• 与「项目整体梳理」区别：本 Skill 聚焦问题/难点/风险/决策；整体梳理侧重概述、模块、技术选型

项目整体梳理

按用户提供的「项目梳理格式」或文档结构，基于当前项目代码与仓库信息生成项目整体梳理内容。

使用时机

• 用户提供一份「项目梳理」的格式、大纲或模板（如「一、项目概述 二、模块划分 三、技术选型 四、目录结构 五、核心接口」）
• 用户提到「项目整体梳理」「按这个格式梳理我们项目」「生成项目文档结构」
• 需要将代码仓库整理成结构化的项目说明（课程作业、毕设、内部文档）

总体思路

1. 解析用户格式：识别一级/二级标题、表格、每部分期望深度 2. 从当前项目抽取：README、目录、配置、入口、路由/API 等 3. 按格式组织：严格按用户标题顺序填写，缺失部分标注「暂无」或「需补充」

工作流程

1. 读取并解析梳理格式：大纲或示例文档，提取结构、表格列名、粒度 2. 从仓库抽取：项目概述、功能模块、技术选型、目录说明、核心接口、运行方式等 3. 按格式生成：遵循标题层级与顺序，表格按实际数量填写，不虚构 4. 输出与补充建议：完整正文，未填项注明「需补充」

注意事项

• 不编造：未在仓库出现的模块、接口、技术不写入
• 结构以用户格式为准：不随意增加用户未要求的大节

简历项目描述

按用户提供的简历/项目经历格式，基于当前项目代码与仓库信息生成对应的「项目描述」或「经历条目」。

使用时机

• 用户提供简历格式示例或模板（如「项目名称/时间/技术栈/描述/职责/成果」），希望按格式为当前项目生成「项目经历」
• 用户提到「按简历格式写这个项目」「把当前项目写成简历里的项目描述」
• 需要将 GitHub 项目、课程项目、毕设项目整理成简历可用的表述

总体思路

1. 解析用户格式：识别字段（项目名、时间、角色、技术栈、描述、职责、成果、亮点）及写法、长度、语气 2. 从当前项目抽取：README、package.json、目录结构、关键代码中的项目名、技术栈、功能点、可量化信息 3. 按格式填充并润色：将抽取内容填入格式，保持与示例一致风格与长度

工作流程

1. 读取并解析格式：从示例/模板识别固定字段、写作风格（动词开头、分号分隔、是否带数据） 2. 从仓库抽取：项目名称与简介、技术栈、功能与模块、可量化信息（接口数、模块数等，仅在有依据时写） 3. 按格式生成：严格按字段顺序、分段方式、标点习惯；占位符（时间、公司、角色）标注「请自行替换」 4. 输出与占位说明：完整一条或一段，注明需用户替换的占位项

注意事项

• 不虚构：未在仓库或 README 中出现的技术、功能、数据不写入
• 不夸大：避免「主导」「独立完成整个系统」；优先用「参与」「负责」「实现」等可证实表述

硕士论文章节生成（系统设计向）

根据用户提供的章节大纲和当前项目代码/需求文档，自动撰写整章内容（含系统架构与系统流程），输出适配 Word 的中文学术文风文本。

使用时机

• 用户希望「根据章节大纲生成硕士论文章节内容」
• 用户提到「系统设计」「总体设计」「详细设计」「系统实现」「系统架构图」「系统流程图」
• 需要围绕当前项目生成结构化的论文文字说明

总体原则

• 面向具体项目：从代码结构、模块划分、配置文件、文档中抽取信息，不凭空泛写
• 中文学术风格：客观、克制，多用「本课题」「本系统」「本章」，避免「我们」
• 去 AI 化：避免「显著提升」「极大增强」「卓越表现」等 AIGC 痕迹词汇
• Word 适配：禁止 Markdown、全角中文标点、中英文间加空格

工作流程

1. 明确输入：章节名称、大纲、项目背景、字数范围 2. 收集项目上下文：README、入口、配置、部署相关文件 3. 抽取系统架构：子系统/模块、职责、部署形态、关键组件 4. 设计系统流程：1–3 个典型流程（用户操作、数据处理、服务调用） 5. 组织章节：总-分-总，章节引言、系统概述、总体设计、流程设计、关键技术、本章小结 6. 输出格式：无 Markdown，普通段落，可分段首用「（一）」「1）」等序号

结构要点

• 系统架构：给出「图 x.x 系统总体架构图」的文字说明及分层说明
• 系统流程：流程概述 + 步骤描述 + 可选「节点-连线」清单供绘图
• 关键技术与实现：选取与项目强相关的技术点，适度提及类/模块名