Search results

Activity: Look for common patterns in 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

I'm giving an API documentation workshop in San Francisco, California, on November 19, 2019. Check it out on EventBrite and register today to receive a $100 early bird discount.

Activity: Look for common patterns in API doc sites

In this activity, identify common patterns in API documentation sites.

  1. Go the list of 100+ API documentation sites.
  2. Select about three different APIs (choose any of those listed on the page).
  3. Look for several patterns or commonalities among the API doc sites. For example, you might look for any of the following patterns:

    • Structure and templates
    • Seamless branding (between docs and the marketing site)
    • Abundant code samples and syntax highlighting
    • Lengthy pages
    • API Interactivity (such as an API Explorer)
    • Docs as code tooling
  4. Note any non-patterns, such as the following:

    • PDF
    • Translation
    • Video tutorials
    • Commenting features
    • Multiple outputs by role
  5. Make some notes in an API log or journal (or share them in the comments below).

In the next section, we’ll look at Design patterns with API doc sites. From your notes, look to see if the patterns I highlight match the ones you observed in the API doc sites you analyzed.

(

3% Complete

3/146 pages complete. Only 143 more pages to go.



Donate?

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