Search results

Activity: Create or fix an API reference documentation topic

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.

##

This part of the activity might be challenging, but here is where you’ll start building some examples for your portfolio.

  1. In the same project as before, identify one of the API reference topics that needs help. (If the API has a new reference endpoint to document, focus on this endpoint.)
  2. Edit the topic to improve it. (If it’s a new endpoint, write the documentation for it.)
  3. Create a pull request and contribute your edits to the project.
127% Complete

127/150 pages complete. Only 23 more pages to go.

Donate?

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