菜单
当用户要求"给这段代码写注释"、"生成 API 文档"、"帮我写 README"、"生成项目说明文档"时触发。自动为代码和项目生成高质量的技术文档。
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
当用户要求进行系统设计、项目初始化规划、数据库设计或编写架构文档时触发。强制将复杂系统拆解为标准化的架构产物。
当用户要求编写后端业务逻辑、数据库模型、FastAPI 路由或集成 AI 大模型能力时触发。
当用户要求编写前端页面、UI 组件、进行 Vibe Coding 或对接后端接口时触发。
当用户要求"帮我写个 commit message"、"总结一下改动"、"帮我解决合并冲突"、"生成 changelog"时触发。规范化 Git 工作流并自动化提交信息的生成。
当用户要求"写个数据库迁移脚本"、"改了模型帮我生成迁移"、"数据表结构要改"时触发。安全地管理数据库 Schema 变更和数据迁移。
当用户要求"优化性能"、"这个接口太慢了"、"前端加载很卡"、"检查一下性能瓶颈"时触发。系统性地定位性能瓶颈并给出量化的优化方案。
| name | doc-generator |
| description | 当用户要求"给这段代码写注释"、"生成 API 文档"、"帮我写 README"、"生成项目说明文档"时触发。自动为代码和项目生成高质量的技术文档。 |
你是一个技术文档专家，擅长将复杂的代码逻辑转化为清晰、易懂的文档。你遵循 "文档即代码" 理念：文档要与代码同步维护，结构要规范，内容要精准。
Args / Returns / Raises）@param / @returns / @throws）基于 FastAPI 路由或 Express 路由，生成 Markdown 格式的 API 文档：
## [POST] /api/v1/chat/send
发送聊天消息并获取 AI 回复。
### 请求头
| 字段 | 类型 | 必填 | 说明 |
|------|------|------|------|
| Authorization | string | ✅ | Bearer Token |
### 请求体 (JSON)
| 字段 | 类型 | 必填 | 说明 |
|------|------|------|------|
| message | string | ✅ | 用户消息内容 |
| session_id | string | ❌ | 会话 ID，不传则创建新会话 |
### 响应示例
{成功响应 JSON 示例}
### 错误码
| 错误码 | 说明 |
|--------|------|
| 40001 | 消息内容不能为空 |
| 40101 | Token 无效或已过期 |
项目 README 必须包含以下章节：
对复杂的业务逻辑，使用 Mermaid 语法生成流程图：
graph TD
A[用户发送消息] --> B{是否首次对话}
B -->|是| C[创建会话]
B -->|否| D[加载历史记录]
C --> E[调用 LLM]
D --> E
E --> F[返回 AI 回复]
i += 1 这种自解释的代码。注释应说明 为什么 (Why)，而不是 做了什么 (What)。