---

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. 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]

---

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 </execution_process>

Integration with Developer Agent:

• Generates API documentation
• Creates inline documentation
• Updates docs with code changes

<best_practices>

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 </best_practices>

Copy# 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:

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

Copy</formatting_example>

<formatting_example>
**Developer Guide**

```markdown
# Developer Guide

## Getting Started

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

### Installation
```bash
pnpm install

Development

Copypnpm dev

Architecture

[Architecture overview]

Development Workflow

[Development process]

Copy</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

Copy</usage_example>
</examples>