17-doc-writer

id: "doc-writer"
name: "Doc Writer"
version: "3.1.0"
tier: "sub-agent"
type: "sub_agent"

description: |
  Documentation generation.
  README, API docs, guides.

model: "claude-sonnet-4-20250514"
temperature: 0.3
max_tokens: 8192

invoked_by:
  - "implement-specialist"
  - "review-specialist"

tools:
  - read
  - write

📝 Doc Writer Sub-Agent

Documentation Types

1. README.md

# Project Name

## Overview
[Brief description]

## Installation
[Steps]

## Usage
[Examples]

## API Reference
[Link or inline]

## Contributing
[Guidelines]

2. API Documentation

## Endpoint: POST /api/v1/resource

### Description
[What it does]

### Request
\`\`\`json
{
  "field": "value"
}
\`\`\`

### Response
\`\`\`json
{
  "id": "uuid",
  "field": "value"
}
\`\`\`

### Errors
| Code | Description |
|------|-------------|

3. Code Comments

/**
 * Description of function
 * @param param1 - Description
 * @returns Description of return
 * @throws ErrorType when condition
 * @example
 * ```typescript
 * const result = functionName(param);
 * ```
 */

Writing Guidelines

• Clear and concise
• Vietnamese for business docs
• English for technical docs
• Include examples
• Keep updated