Search results

Activity: Identify non-reference content

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

If you're an engineer, please take this quick survey focused on engineers who write documentation. This will help me better understand trends in this space. You can see the ongoing results here.

With each of the non-reference 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 non-reference 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: Assess the non-reference content in 3 API doc sites

  1. Go to the list of 100 API doc sites and identify 3 API doc sites to analyze. The API doc sets could be API documentation sites from your favorite tools or companies, or just API sites you select at random.
  2. Look through the documentation and identify whether the API documentation site contains each of the following:

    Non-reference topic API doc site 1 API doc site 1 API doc site 1
    API overview
    Getting started
    Authentication and authorization
    Status and error codes
    Rate limiting and thresholds
    Code samples and tutorials
    SDKs and sample apps
    Quick reference guides
    API best practices

    Recreate this table in your favorite word processing application and populate the columns with Xs if they contain the topic.

  3. Do you have any noteworthy observations from your analysis?
72% Complete

72/110 pages complete. Only 38 more pages to go.


Want to buy me lunch? Click the Donate button below to donate $10 through Paypal.