Search results

Non-reference API topics

Keep current with the latest trends in technical communication by subscribing to the I'd Rather Be Writing newsletter. 4,500+ subscribers

Psst, hey there. If you're an engineer, would you mind taking this quick, two-minute survey focused on engineers who write documentation? This will help me better understand trends in this space. I only need a few more responses to reach 100. You can see the ongoing results here.

While reference topics in APIs generally receive the most attention, the non-reference topics, such as getting started tutorials, information about authorization, rate limiting, status and error codes, quick reference guides, and other topics constitute about half of the documentation. These topics are usually handled by technical writers more than engineers. You can evaluate the quality of API documentation in part by looking to see whether it includes these non-reference topics.

60% Complete

60/110 pages complete. Only 50 more pages to go.


Want to buy me lunch? Click the Donate button below to donate $10 through Paypal.