The Art of Technical Writing for Developer Documentation

The Documentation Hierarchy

1. API Reference (What)

• Auto-generated from code when possible
• Every endpoint: method, URL, params, response, errors
• Include curl examples for every endpoint
• Keep it mechanical, not conversational

2. Tutorials (How — step by step)

• Start from zero (literally: "Open your terminal")
• One tutorial = one outcome
• Test every tutorial quarterly (they rot fast)
• Include expected output at ea