doc-generator

oimiragieo 的头像作者 oimiragieo

从代码、API和规范生成全面文档。创建API文档、开发者指南、架构文档和用户手册,包含示例和教程。

📖 中文导读:从代码、API和规范生成全面文档。创建API文档、开发者指南、架构文档和用户手册,包含示例和教程。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: doc-generator description: Generates comprehensive documentation from code, APIs, and specifications. Creates API documentation, developer guides, architecture docs, and user manuals with examples and tutorials. model: sonnet allowed-tools: read, write, glob, search, codebase_search version: 1.0 best_practices: - Extract documentation from code comments - Generate OpenAPI/Swagger specs from code - Create comprehensive examples - Include troubleshooting guides - Follow documentation standards error_handling: graceful streaming: supported templates: [api-docs, developer-guide, architecture-docs, user-manual]

Documentation Generator Skill - Generates comprehensive documentation from code, APIs, and specifications including API docs, developer guides, architecture documentation, and user manuals. - Generating API documentation - Creating developer guides - Documenting architecture - Creating user manuals - Generating OpenAPI/Swagger specs - Updating existing documentation

Step 1: Identify Documentation Type

Determine documentation type:

  • API Documentation: Endpoint references
  • Developer Guide: Setup and usage
  • Architecture Docs: System overview
  • User Manual: Feature guides

Step 2: Extract Information

Gather documentation content:

  • Read code and comments
  • Analyze API endpoints
  • Extract examples
  • Understand architecture

Step 3: Generate Documentation

Create documentation:

  • Follow documentation templates
  • Include examples
  • Add troubleshooting
  • Create clear structure

Step 4: Validate Documentation

Validate quality:

  • Check completeness
  • Verify examples work
  • Ensure clarity
  • Validate links
**Integration with Technical Writer Agent**: - Uses this skill for documentation generation - Ensures documentation quality - Validates completeness

Integration with Developer Agent:

  • Generates API documentation
  • Creates inline documentation
  • Updates docs with code changes
  1. Extract from Code: Use code as source of truth
  2. Include Examples: Provide working examples
  3. Keep Updated: Sync docs with code
  4. Clear Structure: Organize logically
  5. User-Focused: Write for users, not system
**API Documentation**
# Users API

## Endpoints

### GET /api/users

List all users with pagination.

**Query Parameters:**

- `page` (number): Page number (default: 1)
- `limit` (number): Items per page (default: 10)

**Response:**

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

Example:

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

<formatting_example>
**Developer Guide**

```markdown
# Developer Guide

## Getting Started

### Prerequisites
- Node.js 18+
- pnpm 8+

### Installation
```bash
pnpm install

Development

pnpm dev

Architecture

[Architecture overview]

Development Workflow

[Development process]

</formatting_example>
</examples>

<examples>
<usage_example>
**Example Commands**:

Generate API documentation

Generate API documentation for app/api/users

Generate developer guide

Generate developer guide for this project

Generate architecture docs

Generate architecture documentation

Generate OpenAPI spec

Generate OpenAPI specification from API routes

</usage_example>
</examples>