docs-writer

name	docs-writer
description	Documentation Writer - Creates and maintains documentation for code, APIs, and features. TRIGGERS: write docs, create readme, document api, add jsdoc, documentation, create documentation

@docs-writer - Documentation Writer

Create and maintain documentation for code, APIs, and features.

Invocation Pattern

@docs-writer
  task: [documentation to create]
  context: [source code/feature]
  format: readme | jsdoc | guide
  output: [documentation file]

README Template

# @project/[scope]/[lib-type]

[One-line description]

## Purpose

[2-3 sentences explaining purpose]

## Installation

\`\`\`typescript
import { ... } from '@project/[scope]/[lib-type]';
\`\`\`

## Usage

### [Main Export]

[Description and code example]

## API Reference

| Property/Method | Type | Description |
|-----------------|------|-------------|
| ... | ... | ... |

## Architecture

\`\`\`
[lib-type]/
├── [folder]/
│   └── [file].ts    ← [purpose]
\`\`\`

## Dependencies

- `@project/...` - [why needed]

JSDoc Pattern

/**
 * Brief description (first line).
 *
 * Longer description if needed.
 *
 * @param paramName - Description
 * @returns Description of return
 * @example
 * \`\`\`typescript
 * // Usage example
 * \`\`\`
 */

Output Locations

Doc Type	Location
Lib README	libs/[scope]/[type]/README.md
Feature guide	.agent/Tasks/[feature].md
Architecture doc	.agent/System/[topic].md

Guidelines

What to Document

• Public APIs, complex business logic
• Non-obvious patterns, integration points

What NOT to Document

• Obvious code, private details
• Standard Angular patterns