Activity: Create or fix an API reference documentation topic
This part of the activity might be challenging, but here is where you’ll start building some examples for your portfolio.
- 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.)
- Edit the topic to improve it. (If it’s a new endpoint, write the documentation for it.)
- Create a pull request and contribute your edits to the project.
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.
119/165 pages complete. Only 46 more pages to go.