文档生成器Skill doc-generator

---

名称: 文档生成器 描述: 从代码、API和规范生成全面的文档。创建API文档、开发者指南、架构文档和用户手册，包含示例和教程。 允许工具: 读、写、全局、搜索、代码库搜索 版本: 1.0 最佳实践:

• 从代码注释提取文档
• 从代码生成OpenAPI/Swagger规范
• 创建全面示例
• 包含故障排除指南
• 遵循文档标准 错误处理: 优雅 流式处理: 支持 模板: [api-docs, developer-guide, architecture-docs, user-manual]

---

<identity> 文档生成技能 - 从代码、API和规范生成全面的文档，包括API文档、开发者指南、架构文档和用户手册。 </identity>

<capabilities>

• 生成API文档
• 创建开发者指南
• 文档化架构
• 创建用户手册
• 生成OpenAPI/Swagger规范
• 更新现有文档 </capabilities>

<instructions> <execution_process>

步骤1: 识别文档类型

确定文档类型:

• API文档: 端点参考
• 开发者指南: 设置和使用
• 架构文档: 系统概述
• 用户手册: 功能指南

步骤2: 提取信息

收集文档内容:

• 读取代码和注释
• 分析API端点
• 提取示例
• 理解架构

步骤3: 生成文档

创建文档:

• 遵循文档模板
• 包含示例
• 添加故障排除
• 创建清晰结构

步骤4: 验证文档

验证质量:

• 检查完整性
• 验证示例工作
• 确保清晰性
• 验证链接 </execution_process>

<integration> 与技术写作代理集成:

• 使用此技能进行文档生成
• 确保文档质量
• 验证完整性

与开发代理集成:

• 生成API文档
• 创建内联文档
• 随代码更改更新文档 </integration>

<best_practices>

1. 从代码提取: 使用代码作为真相来源
2. 包含示例: 提供工作示例
3. 保持更新: 同步文档与代码
4. 清晰结构: 逻辑组织
5. 用户为中心: 为用户编写，而不是系统 </best_practices> </instructions>

<examples> <formatting_example> API文档

# 用户API

## 端点

### GET /api/users

列出所有用户，带分页。

**查询参数:**

- `page` (数字): 页码 (默认: 1)
- `limit` (数字): 每页项数 (默认: 10)

**响应:**

```json
{
  "data": [
    {
      "id": "uuid",
      "email": "user@example.com",
      "name": "用户姓名"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 100
  }
}
```

示例:

curl -X GET "http://localhost:3000/api/users?page=1&limit=10"

</formatting_example>

<formatting_example>
**开发者指南**

```markdown
# 开发者指南

## 入门

### 先决条件
- Node.js 18+
- pnpm 8+

### 安装
```bash
pnpm install

开发

pnpm dev

架构

[架构概述]

开发工作流

[开发过程]

</formatting_example>
</examples>

<examples>
<usage_example>
**示例命令**:

生成API文档

为 app/api/users 生成API文档

生成开发者指南

为该项目生成开发者指南

生成架构文档

生成架构文档

生成OpenAPI规范

从API路由生成OpenAPI规范

</usage_example>
</examples>