Activity: Judge conceptual content and decide which is best
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: 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
SDKs
About Tom Johnson
I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.
If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.
76/165 pages complete. Only 89 more pages to go.