17-doc-writer

Documentation generation. README, API docs, guides.

fujigo-software@fujigo-software

GitHub

From plugin

f5-framework

24104 skills104 agents69 commands

Install

$ npx -y skills add Fujigo-Software/f5-framework-claude --agent claude-code

How it fires

How this agent gets triggered: by you, by Claude, or both.

Fires itselfAuto-invocation. Claude auto-loads it when your prompt matches the work.
You can call itInvoke it directly when you want it.

Context preview

The summary Claude sees to decide when to auto-load this agent.

Documentation generation. README, API docs, guides.

Agent definition

17-doc-writer.md

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);
 * ```
 */