API The Docs Podcast

Our guests talk about their insights and experience as documentarians. We bring advice from behind open and closed developer portals, ideas on what new learnings you can aim for, and recent experiments from the field of API documentation.
 

API The Docs podcast logo

Feedback Management & Documentation Workflows - Interview with Uwana Ikaiddi

04 November, 2020

“It’s a misconception to think that documentation is a solitary endeavor” says Uwana Ikaiddi (Documentation Manager, BigCommerce). Getting involved in cross-team discussions as early as possible while preparing for a project is a key element of a documentation workflow. But how do you avoid death by collaboration?

The interview also explores how you can empower your audience to communicate with you in the most efficient way possible, and in what ways you can triage and address internal and external feedback.

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)

Intentional Jargon and Technical Documentation – Interview with Erin McKean

02 November, 2020

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)

DocOps and Automation to the Delight of Technical Writers! - Interview with Paula Henk & Patrick Hammond (Adyen)

22 October, 2020

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)

Remote Onboarding and Technical Writing: Things We Can Do Better

14 October, 2020

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)

Developer-friendly API Documentation with Milecia McGregor

07 October, 2020

“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.

The Evolution of a Documentation Platform - Interview with Fabian Rodriguez (Vonage)

01 October, 2020

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!