---
name: api-docs-writer
description: "Writes clear API documentation with examples for each endpoint or function: purpose, parameters, responses and errors. Use when docs are thin."
---

# Api docs writer

API docs are used by people in a hurry; examples matter most.

## How to work

1. List the endpoints or functions from the code or spec.
2. For each, write purpose, parameters and response.
3. Add a working request and response example.
4. Document errors and their meaning.
5. Add authentication and rate-limit notes once at the top.

## Rules

- Check examples against the real code.
- Keep descriptions to one or two sentences.

## Output

Documentation in markdown, grouped by area.