Search results

Activity: Judge conceptual content and decide which is best

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

I'm giving an API documentation workshop in Los Angeles, California, on January 23, 2020. Check it out on EventBrite and register today to receive a $100 early bird discount.

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.

Activity 6b: Judge conceptual content and decide which is best

The following are 6 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.

API overview

API getting started

API authentication and authorization

API status and error codes

API rate limiting and thresholds

API quick reference

97% Complete

97/150 pages complete. Only 53 more pages to go.


Want to buy me lunch? Click the Donate button below to donate any amount through Paypal.