API The Docs Podcast

The Good Docs Project aims to create open source documentation templates, and most recently an information architecture template too. Erin McKean , one of the central orchestrators behind the Good Docs Project, is our guest for this episode. We talk with Erin about why it is so important to intentionally include jargon in your technical documentation and where to do that. She shares her practice o...

What are the main principles a documentation team operates on in a fast-moving industry? How to adopt DocOps? How does a documentation team decide on what should be automated? What is hard to automate? What is the point when you should not neglect the human eye? These are key questions that we try to find answers to in this interview with Paula Henk (Technical Writer) and Patrick Hammond (DocOps M...

How can you onboard new technical writers when your office just turned into remote-first? This podcast episode focuses on the mistakes Karen Sawrey (Contract Technical Writer) made and the issues she’s encountered and solved when joining a team of tech writing colleagues. The interview also touches upon documentation security and testing, the importance of guidelines, and how the technical writer...

“When you’re working on APIs that developers use, they need to know exactly how to use them. Great documentation is the way to do this & it gives development a chance to make things more user-friendly.” In this podcast, Milecia McGregor (Developer Advocate, Conducto ) reviews why API docs are important and she also shares some tips about how to manage their development cycle.

Vonage ’s developer platform journey started in 2017. Little did they know the impact that some of their design decisions were going to have now. In this interview, Fabian shares how the platform evolved over the years, what challenges the team needed to overcome and what new features are in the pipeline. Tune in to get some tips about separating the prose from the code, and find out what develope...

At the 7th API The Docs Virtual event Michelle Fredette , technical writer at New Relic and Chris Cowell , Oregon-based technical trainer and writer presented on the issues of onboarding writers with different knowledge gaps and how to solve them with 8 hours of training. Uwana Ikaiddi , Developer Documentation Manager at BigCommerce explained the significance of external and internal audience fee...

At the 6th API The Docs Virtual event Egan Anderson , head of developer experience at Galileo , explained ways companies can prioritize developers’ needs. Larry Kluger , lead developer advocate for DocuSign , presented how to create easy to use graphical drag & drop tools for creating and trying complex API requests. Michael Haberman , co-founder & CTO at Aspecto , explored maintaining API...

On 27th Tom Johnson, senior technical writer at Amazon, presented his comprehensive research on how API documentation trends differ from other tech comm trends. In the Q&A panel, he reflects on his talk and provide further insights on: What methods does your team use to estimate time for creating a documentation? How to improve the dynamics inside and outside of your documentation team?

On 13th May in the API The Docs virtual event Sarah Day , technical writer at LaunchDarkly , shared how you can incorporate API documentation in the big picture for overall efficiency in your organization. Riley Siebel , director of Developer Experience at C3.ai , and Mark Winberry , director of US Operations at Pronovix , presented a case study on providing a good DX with docs-as-code regardless...

On 6th May Steph Mills from Splunk shared how you can create the best possible golden paths through the API woods, and how to reduce the need for users to stray from the path into the wilds. Bob Watson from AWS explained how you're able to meet the practical aspects of customer goals with your API documentation, and how to measure how well you meet them as your API and customers evolve. In the Que...

On 22th April Mike Jang from GitLab explored what an Minimum Viable Documentation is for RESTful APIs. Jenny Wanger explained that the way you name, design, and structure your APIs has a huge impact on usability. In the Question-and-Answer session after their presentations, Jenny and Mike reflect on their talks and provide further insights. Enjoy!