Search results

Conceptual topics in API docs

While reference topics in APIs generally receive the most attention, the conceptual 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 conceptual topics.

Buy me a coffeeBuy me a coffee
66% Complete

66/141 pages complete. Only 75 more pages to go.