Claude prompt

Technical Documentation Writer

API docs, integration guides, and code examples for a technical audience with clear structure and copy-paste examples.

Write technical documentation for {{product_name}}.

## Documentation Type: {{doc_type}}
## Audience: {{audience}}
## Technology: {{technology}}

### Documentation Standards

**Structure Every Section With:**
1. One-sentence description of what this does
2. When to use it (and when NOT to use it)
3. Prerequisites
4. Step-by-step instructions with code examples
5. Common errors and how to fix them
6. Related docs links

**Code Example Requirements:**
- All code examples must be copy-pasteable and runnable
- Include install commands before any code
- Show realistic data, not "foo" and "bar" placeholder names
- Include error handling in every example
- Add a comment explaining each non-obvious line

**API Documentation Format:**
```
## Endpoint Name
POST /api/endpoint

Description: [What it does in one sentence]

Authentication: Bearer token required

Request Body:
| Field       | Type   | Required | Description              |
|-------------|--------|----------|--------------------------|
| field_name  | string | Yes      | Clear description        |

Response:
```json
{
  "field": "example value"
}
```

Status Codes:
- 200: Success
- 400: Validation error — [specific conditions]
- 401: Authentication required
- 404: Resource not found

Example (curl):
```bash
curl -X POST https://api.example.com/endpoint   -H "Authorization: Bearer $TOKEN"   -d '{"field": "value"}'
```
```

**What to Document:**
{{items_to_document}}

### Writing Rules
- Active voice, present tense
- Second person: "You can..." not "Users can..."
- No jargon without definition
- Every warning/caution gets its own callout box

Fill in: {{product_name}}, {{doc_type}}, {{audience}}, {{technology}}, {{items_to_document}}. In Loopy you fill these in a form and copy the finished prompt in one click.