Podcast with Jacob Moses on the Not-Boring Tech Writer: Skill #26: Getting Started with API Documentation
Here’s a description of the podcast from Jacob’s site:
Skill #26: Getting Started with API Documentation
As tech writers consider how to stay relevant in the field, many consider getting started in API documentation. And who can blame them—it’s one of the most trending and highest paying roles in tech writing.
But getting started in API documentation can be intimidating, especially if you’ve never worked with code.
That’s why, in this episode, we have Tom Johnson on the podcast: creator of the tech writing site, I’d Rather be Writing, and technical writer at Amazon.
In this episode, Tom shares how to get started in API documentation, including where the tech writer fits in the API documentation process, what skills tech writers need to excel at API documentation, and where to find the best resources to ramp up those skills.
You can listen to the podcast on the Not-Boring Tech Writer site here:
You can also subscribe in iTunes and Podbean.
Sponsored
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, agent skills, tech comm careers, and more. Check out my AI courses for more on the latest in AI and tech comm. If you're looking for info about documenting APIs, see my API documentation course.
If you're a technical writer and want to keep on top of the latest trends in tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me.
Finally, I want to note a couple of things. I usually write the first drafts of my posts myself and then use AI to improve accuracy, clarity, and detail in places, so my writing is a mix of human and AI. (Hopefully that's not too off-putting.) Also, the opinions I express on my blog are my own perspectives, not those of my employer.