Conceptual topics overview
I'm giving an API documentation workshop in San Francisco, California, on November 19, 2019. Check it out on EventBrite and register today to receive a $100 early bird discount.
Up until this point, we’ve mostly been focusing on the reference aspects of API documentation (the endpoints). The reference documentation is only one aspect of API documentation. In this section, I’ll cover the main conceptual topics that are commonly found in API documentation. Rather than “conceptual topics,” you might consider this type of information the “user guide.”
The following are common conceptual topics commonly found in API documentation:
- API Overview
- Getting started
- Authentication and authorization requirements
- Status and error codes
- Rate limiting and thresholds
- Quick reference guide
- API glossary
- API best practices
Beyond the sections outlined above, you might want to include other tasks and tutorials specific to your API, based on what you expect your users to do and the business scenarios for which they’ll use your API.
In each concept topic, I’ll provide general descriptions and overviews of what these sections contain, followed by examples from actual API documentation sites.
With each topic, there’s an activity for you to go into your open-source project and evaluate the conceptual topic at hand. Although many of the conceptual topics are straightforward, when you look at the information in context, that is, when you look to see how the information is actually implemented, it gets a lot more interesting.
85/146 pages complete. Only 61 more pages to go.
Want to buy me lunch? Click the Donate button below to donate any amount through Paypal.