Activity: Judge conceptual content and decide which is best
I'm giving an API documentation workshop in Mountain View, California on August 30, 2019. If you're interested, you can register on EventBrite.
With each of the conceptual topics in this section, you’ve been analyzing the topic in the context of the open-source project you identified. Now broaden your analysis to see how these conceptual topics appear in other API documentation sites.
Remember that sometimes the best way to learn how to create API documentation is to carefully observe how it’s done on sites you admire. Following standard practices in the industry helps you create more predictable, easy-to-follow patterns in your own documentation.
The following are 9 common conceptual topics in API documentation. For each topic, examine the three examples and decide which one is best.
API getting started
API authentication and authorization
API status and error codes
API rate limiting and thresholds
API code samples and tutorials
SDKs and sample apps
API quick reference
70/122 pages complete. Only 52 more pages to go.
Want to buy me lunch? Click the Donate button below to donate $10 through Paypal.