Search results

Activity: Assess the conceptual content in 3 API doc sites

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

Activity: Assess the conceptual 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:

    </tbody> </table> Recreate this table in your favorite word processing application and populate the columns with Xs if they contain the topic.
    Conceptual 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
    Quick reference guides
  3. Do you have any noteworthy observations from your analysis?
4% Complete

4/150 pages complete. Only 146 more pages to go.



Donate?

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