Search a title or topic

Over 20 million podcasts, powered by 

Player FM logo

API The Docs Podcasts

show episodes
 
Artwork
 
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.
  continue reading
 
Some people hear the phrase "technical writing" and think it must be boring. We're here to show the full complexity and awesomeness of being a tech writer. This podcast is for anyone who writes technical documentation of any kind, including those who may not feel comfortable calling themselves tech writers. Whether you create product documentation, support documentation, READMEs, or any other technical content—and whether you deal with imposter syndrome, lack formal training, or find yoursel ...
  continue reading
 
Loading …
show series
 
In this episode, I talk with Fabrizio Ferri-Benedetti about moving beyond strictly following documentation frameworks to embrace strategic thinking, his Seven-Action Documentation model that prioritizes user needs over content types, and how technical writers can grow and adapt in the AI era while positioning themselves as essential strategic partn…
  continue reading
 
In this solo episode, Kate shares an update on her content update progress. She also reflects on Sarah Walker’s interview (S3:E18) and the concepts of Asteya, giving great service, and going the extra mile. I’ve continued my work to update the KnowledgeOwl Support Knowledge Base to align with major navigation and UI changes that we rolled out in De…
  continue reading
 
In this episode, I talk with Sarah Walker, a technical writer and yoga instructor, about how yoga principles like establishing foundations, respecting people’s time, and embracing practice over perfection can transform your approach to technical writing and help you create more mindful, user-centered documentation. Sarah and I discuss her path into…
  continue reading
 
In this solo episode, Kate shares an update on her content update progress. She also reflects on Manny Silva’s interview (S3:E14), Ryan Macklin’s interview (S3:E16), and Liz Argall’s interview (S3:E13) and the importance of learning even when we don’t have explicit reasons to do so. I’ve continued my work to update the KnowledgeOwl Support Knowledg…
  continue reading
 
Learn how Ryan Macklin's "empathy advocacy" framework helps you design documentation that works for users in all emotional states (e.g. anxious, frustrated, exhausted, and curious/distractible) rather than assuming everyone comes to your docs in a perfect state of clarity. Ryan and I discuss his unique path into technical writing, starting from his…
  continue reading
 
In this solo episode, Kate shares an update on her content update progress. She also reflects on Nick Graziade’s interview (S3:E12) and Liz Argall’s interview (S3:E13) and the ways these interviews highlight some elements of “good” docs experiences. I’ve continued my work to update the KnowledgeOwl Support Knowledge Base to align with major navigat…
  continue reading
 
We discuss findings from GitBook's "State of the Docs" report (2025), for example that 90% view documentation as crucial for purchases, yet 40% of those interviewed don't track its performance. We talk of speeding up API integration, and GitBook's focus on refining adaptive and personalized documentation features, then address avoiding tunnel visio…
  continue reading
 
In this episode, I'm talking with Manny Silva, a technical writer who created the "Docs as Tests" concept name and the open-source tool Doc Detective. We discuss how to automatically test your documentation for accuracy, why customer reports of broken docs are actually failed tests, and practical ways to implement automated documentation testing re…
  continue reading
 
In this episode, I’m talking with Liz Argall, a writer I connected with at Write the Docs Portland 2025. We talk about working on open source projects, developing good qualitative metrics, her work with a permaculture nonprofit in Uganda, and the ways that being interviewed by a technical writer can make hidden expertise shine. Liz and I presented …
  continue reading
 
Welcome back to the A(P)I The Docs podcast! We’re opening this new chapter with an absolute treat of an episode in which Anila Zaidi, Staff Technical Writer at Squarespace, and Marco Spinello, Senior Technical Writer at Booking.com discuss the transformative role of generative AI in technical writing and beyond. We explore how AI has evolved from a…
  continue reading
 
In this episode, I'm talking with Nick Graziade, a technical writer and musician who approaches documentation as a creative endeavor. We explore how his early fascination with Lego instructions and synthesizer manuals shaped his philosophy that technical writing doesn't have to be dry or boring, but can be passionate and innovative work that adapts…
  continue reading
 
In this solo episode, Kate shares an update on her content update progress. She also reflects on Sue Brandt’s interview (S3:E10) and on the Write the Docs Portland 2025 conference. I’ve continued my work to update the KnowledgeOwl Support Knowledge Base to align with major navigation and UI changes that were rolled out in December. I updated an add…
  continue reading
 
In this episode, I’m talking with Sue Brandt, a former Director of Documentation who’d hired around 60 people when we recorded the episode. We discuss practical strategies for technical writing job applications, what hiring managers are really looking for in resumes and interviews, and how to stand out in today’s competitive job market. Sue and I d…
  continue reading
 
In this solo episode, Kate shares an update on her content update progress. She also reflects on Marcia Riefer Johnston’s interview (S3:E8) and on the idea of docs stewardship as opposed to docs ownership. I’ve continued my work to update the KnowledgeOwl Support Knowledge Base to align with major navigation and UI changes that were rolled out in D…
  continue reading
 
In this episode, I’m talking with Marcia Riefer Johnston, a technical writer who’s worked in our industry for 40 years. We talk about how the profession has evolved since she first started in it, the grammar patterns that have helped her tighten up her writing, and how “creative” writing and “technical” writing are just different expressions of the…
  continue reading
 
In this solo episode, Kate shares an update on her content update progress, muses about the similarities between mice infestations and docs projects, and reflects more on Kenzie Woodbridge’s interview (S3:E6) and how we choose what we work on. Since Episode 5, I’ve continued my work to update the KnowledgeOwl Support Knowledge Base to align with ma…
  continue reading
 
In this episode, I’m talking with Kenzie Woodbridge, a documentarian and self-taught accessibility advocate. We talk about how feeling “not expert enough” is no reason to skip content accessibility, four ways you can make your content more accessible right now, and ways you can serve as an accessibility advocate as you review content and work with …
  continue reading
 
In this solo episode, Kate shares an update on working with content types, muses about the idea of a Documentation Hierarchy of Needs, and reflects more on Janine Chan’s interview (S3:E4) and how we talk to ourselves about being tech writers. — I may have overcommitted myself in Episode 3. I have been incorporating content type work into my massive…
  continue reading
 
In this episode, I’m talking with Janine Chan, a technical writer and Write the Docs community moderator. We talk about how feeling “not technical enough” is as much about attitude and approach as it is about knowledge and ways you can bridge the gap to a more technical future. Janine and I discuss the fact that there’s no defined/established set o…
  continue reading
 
My current in-flight projects include updating nearly all of our documentation to reflect major changes to our user interface, which includes changes to screenshots, navigation options, and section/subsection labels. I’m also working on my long slog to convert all our screenshots from .png to .webp format. As I make all of those updates, I’m bringi…
  continue reading
 
In this episode, I’m talking with Lorna Mitchell, a technology leader, published author, tech blogger, and developer experience expert who is passionate about APIs and developer tools. We talk about why developers writing docs is good for both your devs and your docs, the best ways to build successful collaboration with developers, and more! Lorna …
  continue reading
 
Meet our new host Kate Mueller and get the inside scoop on how The Not-Boring Tech Writer (TNBTW) will work moving forward. Kate Mueller is the Documentation Goddess of KnowledgeOwl, a seasoned technical writer and owner of knowledgewithsass, a knowledge management coaching service. She’s written and maintained documentation for companies in broadc…
  continue reading
 
How do you get people on board when you shift to a new tool or a new approach? Even if the value proposition is clear, it might be a challenge to create a practice out of the change. In this episode of API The Docs, Polina Zaichkina (Senior technical writer at Codat) and Max Clayton Cowes (Product director for experience at Codat) share insights ab…
  continue reading
 
In this episode, Naomi Pentrel and Andrew Feierabend share their journey of revamping Viam’s robotics APIs documentation. They discuss the benefits of sitting down with actual users in well-structured interview sessions with specific scripts and tasks. Learn about their approach to user research, their team’s collaborative methodology for achieving…
  continue reading
 
Byrne Reese had the opportunity to build a number of developer programs over the years. In this episode, he explains his unique Developer Pyramid framework which he uses as a guide to build a successful and scalable developer program now at RingCentral. He also dives into his passion for board games and how it influences his approach to documentati…
  continue reading
 
"Key results are the things you're going to do to move that number. Here's the thing where most people spin out. There should be a break mechanism on the things that you're doing […] a culture of experimentation, and objective critique around 'Is this the right thing to be doing?” Welcome back to our two parts episode with Rachel Lee Nabors, we con…
  continue reading
 
"You can always tell when it's a novice writer or a writer and an artist who are in bad relation because there will be blocks of text everywhere explaining how the character is feeling […] There's a delicate balance to be struck and it's the same with code.” Welcome Rachel Lee Nabors, one of the creators behind the grand award-winning react.dev por…
  continue reading
 
Technical writers walk a tricky tightrope between delivering accurate technical information and making it comprehensible for a wide range of users with varying levels of technical experience. In this episode, Ryan Young (Technical writer at Stripe) shares his thoughts on bridging the gap between different content layers and writing for humans in a …
  continue reading
 
How can one make their devportal accessible and useful at the same time? What can devportal owners do to support inclusive design? We were honored to ask Susanna Laurin (Certified Professional in Accessibility Core Competencies, G3ict and IAAP Representative to the EU) about these questions in 2023’s DevPortal Awards framework. As she highlighted, …
  continue reading
 
The API The Docs Podcast brings you a Special Edition series with insights from the 2023 DevPortal Awards. Each year, the DevPortal Awards seeks the most outstanding solutions with the help of experienced jurors, who are volunteers with extensive knowledge of API programs, developer portals, and API documentation. In the Special Edition series, we …
  continue reading
 
The API The Docs Podcast brings you a Special Edition series with insights from the 2023 DevPortal Awards. Each year, the DevPortal Awards seeks the most outstanding solutions with the help of experienced jurors, who are volunteers with extensive knowledge of API programs, developer portals, and API documentation. In the Special Edition series, we …
  continue reading
 
The API The Docs Podcast brings you a Special Edition series with insights from the 2023 DevPortal Awards. Each year, the DevPortal Awards seeks the most outstanding solutions with the help of experienced jurors, who are volunteers with extensive knowledge of API programs, developer portals, and API documentation. In the Special Edition series, we …
  continue reading
 
Connected to both customers and internal teams, customer success is a powerful source of valuable information throughout the entire feedback loop. In this episode, Charlie Edwards (Customer Success Manager at CAE Technologies Limited) explains how the feedback from customer success teams contributes to the comprehensive improvement of products. The…
  continue reading
 
Adopting a beginner’s mindset allows you to explore familiar concepts through a lens of curiosity and openness. But how does that translate to documentation? In this episode, Adrienne Braganza Tacke (Sr. Developer Advocate & DevNet Community Programs Lead at Cisco) explains the unexpected benefits of writing with newcomers in mind and how it can ta…
  continue reading
 
How does a biological anthropologist become a professional docs auditor? Portia Burton, founder of DocumentWrite, narrates her meandering journey from biological anthropology to ESL China, through blockchain technology community engineering, all the way to content audit services. We talk about what to look for in an audit, and what is often critica…
  continue reading
 
Technical writing and developer relations are relatively new areas, and they have both grown out of a need for these specific skill sets. However, for newcomers in the IT landscape, it might take a while to understand what they actually mean and how they support the work of developers. Kruno Golubic (technical writer at Memgraph) and Katarina Šupe …
  continue reading
 
From rapid changes to learning on the fly, startups face unique challenges that require creative solutions. Alex Akimov (Head of API Platform at Monite) and Helen Kosova (API Technical Writer at Monite) discuss how Monite’s API council supports the adoption of an API-first approach at the company.
  continue reading
 
With Anthony Pichardo, product manager at Visa Developer Platform, on the value of user-centered design and building non-zero sum environments where everyone wins. Community is not just an afterthought, it’s an integral part of strategy. The platform team conducts regular user research to gauge pain points, and constantly strives to minimize the le…
  continue reading
 
We explore how developer documentation hubs enable a unified information architecture, at least outwards: our guests Christoph Weber (Pronovix) and Kristof Van Tomme (Pronovix) talk about the nuanced, socio-technical nature of large scale documentation processes, the need for a central API docs team, and the future use of private LLMs.…
  continue reading
 
Developers are the ones who know their APIs best, but they need an easy documentation process that wouldn’t be too different from the coding lifecycle to produce the technical documentation at scale. Senior technical writer Paula Cristina Vaz outlines the Documentation Framework at Farfetch, created to process markdown files and convert them to Con…
  continue reading
 
Daniel Izquierdo (Bitergia) and Kristof Van Tomme (Pronovix) explained their journey with innersource and open-source communities. They also discussed what a company can do with documentation islands (or silos), and what are the role of technical writers in this process. What is the connection between innersource and documentation? How can we defin…
  continue reading
 
Business and technical personas may have different skills, and in many cases, they use different terminology. Luca Vettor (Information Architect at Deltatre) explained how Domain Driven Design and event storming create transparent communication between the two personas. What is induced and intrinsic complexity? How could we define the problem space…
  continue reading
 
Why did Fabrizio Ferri-Benedetti (Senior Staff Technical Writer at Splunk) write a love letter to technical writing? How could technical writers create a bridge between the different parts of a company? With an MSc in cognitive psychology, Fabrizio shares a nuanced perspective in his ‘Docs' hierarchy of priorities’ and associated metrics.References…
  continue reading
 
Anna Tsolakou (Developer Advocate) and Mathieu Pincovai (Customer Success Specialist) shared with us the journey on how Amadeus for Developers created consistent and clear documentation. We also talked about why the docs-as-code approach is so crucial for them, and how they can create the right documentation for their APIs.…
  continue reading
 
Spotify Senior Developer Advocates Serah Njambi Kiburu and Alvaro Navarro talked with us about the two enemies of developer empathy, and their practices to optimise and scale for the community’s real needs. We also asked why Spotify even needs an API developer portal, and why isn’t it built on backstage? (spoiler alert) They have good reasons for t…
  continue reading
 
Our guest Emese Hallgató works as a UX researcher at Pronovix Developer Portals. Her education and experience in computer programming and in psychological research open the door to better understanding developers and their needs. How do developers approach coding, and what do they need to reach a state of flow? We talk about the archetypes of syste…
  continue reading
 
In Part 2 of our conversation with Miro's DevRel Lead Anthony Roux and Senior Techwriters Mira Balani and Marco Spinello, we walk deeper into how their respective teams complement each other, and we will also get a detailed narrative from Anthony about their process to aggregate all types of feedback, whether it's a feature requests, bugs, or docum…
  continue reading
 
Loading …
Copyright 2025 | Privacy Policy | Terms of Service | | Copyright
Listen to this show while you explore
Play