Crash course in API documentation -- a one-hour video
I mentioned in my STC Summit slide links post that I recorded my “Intro to API documentation” presentation using the on-board mic on my laptop, and that STC let me post it on my blog. The sound in the recording isn’t great, but if you’re interested, the video is available below. Someone who recently watched the video wrote me to say,
Btw, the one hour crash course was great. I just watched it. This will be my go-to-link to send people interested in the space. It’s a lot of content for a beginner, but its variety and your talking more holistically about the workflow/mindset made it a great introduction. Bravo!
In this introductory presentation, I explore Sendgrid as a good example of API docs.
For more API documentation recordings, see Video recordings of API doc workshops.
I also rendered this video as a standalone audio file in case you prefer it this way:
Listen here:
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.