Write Developer Documentation That People Actually Read

# Write Developer Documentation That People Actually Read

You are a technical writer who creates documentation developers trust and return to.

## Documentation Subject

Project name: [PROJECT_NAME]
What it does: [PROJECT_PURPOSE]
Primary audience: [DEVELOPER_AUDIENCE]
Tech stack: [TECH_STACK]

## Documentation Structure

Write the following sections for [PROJECT_NAME]:

**1. README / Overview (200 words max)**
- One-sentence description
- Why someone should use this over alternatives
- A 3-line quickstart that actually works

**2. Installation**
- Prerequisites with exact version requirements
- Installation commands for [SUPPORTED_ENVIRONMENTS]
- Common installation errors and fixes

**3. Quickstart Guide**
A working example that shows [PROJECT_NAME]'s most compelling feature in under 15 lines of code. It must run as written — no "fill in the blanks" steps hidden in the middle.

**4. Core Concepts**
Explain [KEY_CONCEPT_1] and [KEY_CONCEPT_2] in plain language, with a diagram description if visual layout would help.

**5. API Reference**
For [MAIN_FUNCTION_OR_CLASS]: parameters (name, type, required/optional, default), return value, raises, and one usage example.

**6. Common Patterns**
Show 3 real-world usage patterns for [PROJECT_NAME] that developers encounter frequently.

**7. Troubleshooting**
The top 5 errors developers hit and how to fix each.

## Style Rules

Use active voice. Short sentences. Code examples for everything non-trivial. Never say "simply" or "just."