Let's Talk Docs podcast -- episode on measuring API documentation quality
You can listen to episode 2 on the Let’s Talk Docs site or embedded below.
In this episode, we chat about the API documentation checklist I created in my API documentation course. While discussing criteria for measuring documentation quality, we also chatted about the Developer Portal Awards from Pronovix. This year I served as a juror for the API reference, onboarding, internal portals, developer dashboard, and editorial experience categories – alongside Ellis Pratt, Bob Watson, and Lukas Rosenstock.
By the way, you can see some jury commentary about what makes for winning developer portals in a Pronovix video interview here. (My comments appear about 24 minutes into this video.)
We also chat about other topics in this Let’s Talk Docs podcast, such as writing philosophies, community engagement, and life stories, but the focus on measuring API documentation quality probably has the most emphasis.
The Let’s Talk Docs podcast (which is associated under the larger Sustain podcast) has several other episodes available as well:
I added Let’s Talk Docs to my list of tech comm podcasts here.
About Tom Johnson
I'm a technical writer / API doc specialist based in the Seattle area. In this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, visual communication, information architecture, writing techniques, plain language, tech comm careers, and more. Check out simplifying complexity and API documentation for some deep dives into these topics. If you're a technical writer and want to keep on top of the latest trends in the field, be sure to subscribe to email updates. You can also learn more about me or contact me.