Welcome to the 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 on curating a project documentation wishlist to keep the future focus going, and why and how to get documentation treated as a key core feature of a product.

The hosts are Laura Vass (Editor of Developer Portal Newsletter, Co-Founder, Pronovix) and Anett Pozsár (Senior Technical Writer, Pronovix).

Music: Virgill - Its over now (CC)

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 Manager) from Adyen.

The hosts are Laura Vass (Editor of Developer Portal Newsletter, Co-Founder, Pronovix) and Anett Pozsár (Senior Technical Writer, Pronovix).

Music: Virgill - Its over now (CC)

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 role is transforming today, in the time of remote working.

The hosts are Laura Vass (Editor of Developer Portal Newsletter, Co-Founder, Pronovix) and Anett Pozsár (Senior Technical Writer, Pronovix).

Intro music: Virgill - Its over now (CC)

“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 developer advocacy is necessary for the success of this new tool chain!

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 feedback, and gave guidance on how to improve API documentation by them. In the Q&A panel of the event, they reflect on their talks and provide further insights on:

• Do you also train your developers on how they can document for themselves?
• What would you recommend for people who want to change career-path from development to techwriting?
• Is there a need for anti-personas, i.e. people who aren't specifically the core audience of the API documentation but might need to consider when writing the docs?
• How to build trust with your internal audience?
• Can you speak to techniques who are getting collected external feedback to the appropriate writers on a large writing team?
• Does teaching developer students technical writing support a faster and more efficient on-boarding process in the long run?