/docs - Generate Documentation

Generate technical documentation for code, APIs, or systems.

Usage

/docs [target] [type]

Arguments:

• target - File, directory, or module to document
• type - (optional) Type of documentation: api, readme, technical, usage

Examples

/docs src/services/auth/
/docs src/api/users.ts api
/docs src/utils/ readme
/docs technical

What It Does

1. Analyzes the specified code to understand:

   • Public interfaces and APIs
   • Function signatures and parameters
   • Data structures and types
   • Dependencies and relationships

2. Generates documentation including:

   • Overview and purpose
   • Installation/setup instructions (if applicable)
   • API reference with examples
   • Configuration options
   • Common use cases

Output Format

## Documentation: {target}

### Overview
{Brief description of what this code does}

### API Reference

#### `functionName(params)`
{Description}

**Parameters:**
- `param1` (type) - Description

**Returns:** type - Description

**Example:**
\`\`\`javascript
// Usage example
\`\`\`

### Configuration
{Any configuration options}

### Related
- {Links to related documentation}

Skill Used

skills/confluence/technical-docs/

When to Use Agent Instead

Use the Software Architect agent when:

• Creating comprehensive system documentation
• Documentation needs architectural context
• ADRs or design documents are needed