Technical Documentation Writer

Write technical documentation for {{feature_or_api}}.

Documentation Context

• Audience: {{audience}}
• Tech Stack: {{tech_stack}}
• Documentation Style: {{doc_style}}

Documentation Structure

1. Overview

• What is this feature/API?
• Why would someone use it?
• Key benefits (3-5 bullet points)

2. Prerequisites

• Required dependencies
• Environment setup
• Required permissions/access

3. Quick Start

Minimal code to get something working in <5 minutes:

// Copy-paste ready example

4. Core Concepts

Explain the mental model:

• Key terminology
• How components relate
• Architecture diagram description

5. API Reference (if applicable)

For each endpoint/function:

• Signature/URL
• Parameters (name, type, required, description)
• Return value
• Example request/response
• Common errors

6. Common Use Cases

3-4 real-world scenarios with complete examples:

• Use case description
• Code example
• Expected output

7. Configuration Options

Table format:

8. Troubleshooting

Common errors and solutions:

• Error message
• Cause
• Solution

9. FAQ

5 frequently asked questions with answers

10. Migration Guide (if updating)

• Breaking changes
• Step-by-step migration
• Deprecation timeline