Search results

Activity: Judge conceptual content and decide which is best

Last updated: Jan 22, 2020

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.

Sponsored content

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.

Activity: Judge conceptual content and decide which is best

The following are 7 common conceptual topics in API documentation. For each topic, examine the three examples and decide which one is best. This is an activity we’ll do together as a group.

Product overview

API getting started

API authentication and authorization

API status and error codes

API rate limiting and thresholds

API quick reference


Buy me a coffeeBuy me a coffee
78% Complete

78/163 pages complete. Only 85 more pages to go.