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
I'd Rather Be Writing features regular podcasts with experts in the field of technical communication.
…
continue reading
All technical writers have one thing in common: their peers outside of the industry believe technical writing is a boring career. They think we lack creativity; they think we only eat tuna salad for lunch; and they think our work is reserved to instructional manuals that they don't even use. This podcast gives you the tools to prove them wrong! In each episode we talk to the humans behind the docs, sharing stories, experience and expertise to inspire, entertain, and give you knowledge and sk ...
…
continue reading

1
The craft of technical writing with Marcia Riefer Johnston
52:59
52:59
Play later
Play later
Lists
Like
Liked
52:59📣 Special announcement: The Not-Boring Tech Writer team (Kate and Chad) will be at Write the Docs Portland in May. Thanks to KnowledgeOwl's sponsorship, they’ll be wearing KnowledgeOwl and The Not-Boring Tech Writer t-shirts and giving out The Not-Boring Tech Writer stickers. If you're attending WTD Portland this year, please say hi to Kate and Cha…
…
continue reading

1
Notes and discussion for Jonathan Warner's <i>More Than Words: How to Think About Writing in the Age of AI</i>
59:40
59:40
Play later
Play later
Lists
Like
Liked
59:40This post has notes and questions for discussion for More Than Words: How to Think About Writing in the Age of AI, published in February 2025 by Jonathan Warner. Warner's book, which explores what we lose when we outsource writing to AI, is the first book in the AI Book Club: A Human in the Loop.By Tom Johnson
…
continue reading
📣 Special announcement: The Not-Boring Tech Writer team (Kate and Chad) will be at Write the Docs Portland in May. Thanks to KnowledgeOwl's sponsorship, they’ll be wearing KnowledgeOwl and The Not-Boring Tech Writer t-shirts and giving out The Not-Boring Tech Writer stickers. If you're attending WTD Portland this year, please say hi to Kate and Cha…
…
continue reading

1
We’re all responsible for content accessibility with Kenzie Woodbridge
45:57
45:57
Play later
Play later
Lists
Like
Liked
45:57📣 Special announcement: The Not-Boring Tech Writer team (Kate and Chad) will be at Write the Docs Portland in May. Thanks to KnowledgeOwl's sponsorship, they’ll be wearing KnowledgeOwl and The Not-Boring Tech Writer t-shirts and giving out The Not-Boring Tech Writer stickers. If you're attending WTD Portland this year, please say hi to Kate and Cha…
…
continue reading

1
Kate sounds off on docs hierarchy of needs and how we talk to ourselves
17:36
17:36
Play later
Play later
Lists
Like
Liked
17:36📣 Special announcement: The Not-Boring Tech Writer team (Kate and Chad) will be at Write the Docs Portland in May. Thanks to KnowledgeOwl's sponsorship, they’ll be wearing KnowledgeOwl and The Not-Boring Tech Writer t-shirts and giving out The Not-Boring Tech Writer stickers. If you're attending WTD Portland this year, please say hi to Kate and Cha…
…
continue reading

1
Bridging the gap from “not technical enough” to “technical” with Janine Chan
56:28
56:28
Play later
Play later
Lists
Like
Liked
56:28📣 Special announcement: The Not-Boring Tech Writer team (Kate and Chad) will be at Write the Docs Portland in May. Thanks to KnowledgeOwl's sponsorship, they’ll be wearing KnowledgeOwl and The Not-Boring Tech Writer t-shirts and giving out The Not-Boring Tech Writer stickers. If you're attending WTD Portland this year, please say hi to Kate and Cha…
…
continue reading

1
Rethinking traditional approaches to release notes -- recording of WTD Australia presentation
56:52
56:52
Play later
Play later
Lists
Like
Liked
56:52I gave a presentation to the Write the Docs Australia group on using AI to write release notes using file diffs, on Feb 16, 2025. Here's the recording, presentation description, and transcript.By Tom Johnson
…
continue reading
📣 Special announcement: The Not-Boring Tech Writer team (Kate and Chad) will be at Write the Docs Portland in May. Thanks to KnowledgeOwl's sponsorship, they’ll be wearing KnowledgeOwl and The Not-Boring Tech Writer t-shirts and giving out The Not-Boring Tech Writer stickers. If you're attending WTD Portland this year, please say hi to Kate and Cha…
…
continue reading

1
Developer collaboration with Lorna Mitchell
44:15
44:15
Play later
Play later
Lists
Like
Liked
44:15📣 Special announcement: The Not-Boring Tech Writer team (Kate and Chad) will be at Write the Docs Portland in May. Thanks to KnowledgeOwl's sponsorship, they’ll be wearing KnowledgeOwl and The Not-Boring Tech Writer t-shirts and giving out The Not-Boring Tech Writer stickers. If you're attending WTD Portland this year, please say hi to Kate and Cha…
…
continue reading

1
Introducing The Not-Boring Tech Writer Reboot
13:14
13:14
Play later
Play later
Lists
Like
Liked
13:14📣 Special announcement: The Not-Boring Tech Writer team (Kate and Chad) will be at Write the Docs Portland in May. Thanks to KnowledgeOwl's sponsorship, they’ll be wearing KnowledgeOwl and The Not-Boring Tech Writer t-shirts and giving out The Not-Boring Tech Writer stickers. If you're attending WTD Portland this year, please say hi to Kate and Cha…
…
continue reading
It's that time of year again when we take to analyzing trends. If you know me, you're probably gearing up for a load of AI-optimistic predictions because, as I've noted in previous posts like Unpacking the issues from AI, I'm an AI optimist. However, my AI optimism isn't based on hype or the current tech zeitgeist. Rather, I'm an AI optimist becaus…
…
continue reading

1
[Podcast] GenAI and Document360: Conversation with Saravana Kumar
49:36
49:36
Play later
Play later
Lists
Like
Liked
49:36This podcast explores GenAI in technical documentation scenarios, highlighting the AI features and capabilities provided in Document360. I talk with Saravana Kumar, CEO of Kovai.co, which makes Document360, about how AI is changing search functionality and reducing support costs in knowledge bases. We discuss practical applications of AI for techni…
…
continue reading

1
Podcast: Task decomposition and complex tree diagrams
18:38
18:38
Play later
Play later
Lists
Like
Liked
18:38This tutorial will help you understand task decomposition by guiding you through the process of creating a complex tree diagram that's too sophisticated for an AI tool to create at once. Whether you're creating tree diagrams or not, it doesn't matter. This is just an example of how to break down complex information into smaller chunks and pass it i…
…
continue reading

1
Podcast: Using long-token contexts to quality check an entire API doc set
21:58
21:58
Play later
Play later
Lists
Like
Liked
21:58One of the advantages of recent Gen AI updates is the massive token input context. When you can pass in an entire set of documentation as an input, you have a much stronger possibility for powerful prompts. In this tutorial, I share some quality-control prompts you can use that deal with entire doc sets as inputs, as well as explain some of the cha…
…
continue reading

1
Podcast: Using file diffs for better release notes in reference docs
17:31
17:31
Play later
Play later
Lists
Like
Liked
17:31You can use AI prompts when creating release notes for APIs by leveraging file diffs from regenerated reference documentation. The file diffs from version control tools provide a reliable, precise information source about what's changed in the release.By Tom Johnson
…
continue reading

1
Podcast: Populating documentation templates using AI
22:47
22:47
Play later
Play later
Lists
Like
Liked
22:47In this tutorial, you'll learn how to use AI to populate documentation templates with the source material you've gathered. For example, API overviews often follow a highly structured template. This technique can be a quick way to get an initial draft of documentation, which you can then edit and review with SMEs.…
…
continue reading

1
Podcast: Gathering source material for context input
18:02
18:02
Play later
Play later
Lists
Like
Liked
18:02One of the most successful strategies for using AI is to pass in an abundance of source material that can augument and inform the AI's responses. In this tutorial, I cover strategies for gathering this material, including what types of documents to look for, optimal ordering, pitfalls to look out for such as outdated or slanted information, and mor…
…
continue reading

1
Podcast: Creating high-fidelity, thematically organized notes from engineering meetings using AI
15:29
15:29
Play later
Play later
Lists
Like
Liked
15:29For AI tools to generate accurate information for documentation you're writing, you need to pass in source material. This usually means meeting with engineers and product managers to gather information about the product. In this tutorial, I share prompts for turning those meeting transcriptions into organized, readable meeting summaries. These clea…
…
continue reading

1
Documentation by humans for humans - Discussion with Polina Zaichkina and Max Clayton Clowes
43:21
43:21
Play later
Play later
Lists
Like
Liked
43:21How 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

1
From Inconsistent to Award-winning Docs - Conversation with Naomi Pentrel & Andrew Feierabend
50:38
50:38
Play later
Play later
Lists
Like
Liked
50:38In 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

1
The Secret Sauce of Developer Programs: A Conversation with Byrne Reese
56:46
56:46
Play later
Play later
Lists
Like
Liked
56:46Byrne 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

1
[Podcast] Uncovering and communicating the value of your tech comm teams' work, with Keren Brown
47:32
47:32
Play later
Play later
Lists
Like
Liked
47:32In this podcast episode, I talk with Keren Brown, VP of Marketing and Value at Zoomin Software, about strategies for technical writers to demonstrate their value within their organizations, especially in light of recent layoffs in the tech industry. We discuss aligning documentation work with high-priority initiatives, quantifying the impact of tec…
…
continue reading

1
Teaching and Learning Git - Discussion with Anna Skoulikari
27:30
27:30
Play later
Play later
Lists
Like
Liked
27:30When it comes to learning Git, it can be daunting to navigate the plethora of learning resources out there. Recognising the need for a visually engaging all-levels experience, Anna Skoulikari (JetBrains) decided to write her own self-study book to help learners along the way.
…
continue reading

1
Install ways to check on the overall health of the portal - Conversation with Rachel Lee Nabors
25:39
25:39
Play later
Play later
Lists
Like
Liked
25:39"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

1
React.dev and storyboarding with Rachel Lee Nabors
23:37
23:37
Play later
Play later
Lists
Like
Liked
23:37"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

1
On the management track - conversation with Claire Waters
44:35
44:35
Play later
Play later
Lists
Like
Liked
44:35Drawing from her role as a wayfinder, Claire Waters (Senior Manager – Product Content Experience, Cloudflare) shares her team’s using the COIN methodology for embracing AI tools as a team, and how they engage in low-stakes AI challenges to foster familiarity and comfort with AI technologies.
…
continue reading

1
The zen of resilience - Discussion with Dan Grabski
49:23
49:23
Play later
Play later
Lists
Like
Liked
49:23You need docs and headspace when a well-oiled system inevitably throws a flat tire. With Dan Grabski we talked from car racing through tech execs mediating at Burning Man, forest fire incident management systems and early expectations setting all the way to API docs and back again.
…
continue reading

1
Writing with humans in mind - Discussion with Ryan Young
36:02
36:02
Play later
Play later
Lists
Like
Liked
36:02Technical 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

1
DevPortal Awards Jury Interview - Special Edition Part 4
16:34
16:34
Play later
Play later
Lists
Like
Liked
16:34How 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

1
DevPortal Awards Jury Interview - Special Edition Part 3
22:10
22:10
Play later
Play later
Lists
Like
Liked
22:10The 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

1
DevPortal Awards Jury Interview - Special Edition Part 2
28:09
28:09
Play later
Play later
Lists
Like
Liked
28:09The 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

1
DevPortal Awards Jury Interview - Special Edition Part 1
18:40
18:40
Play later
Play later
Lists
Like
Liked
18:40The 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

1
Harnessing the power of customer success - Discussion with Charlie Edwards
36:32
36:32
Play later
Play later
Lists
Like
Liked
36:32Connected 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

1
Building empathy with a beginner’s mindset - Discussion with Adrienne Braganza Tacke
49:46
49:46
Play later
Play later
Lists
Like
Liked
49:46Adopting 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

1
Docs anthropology, and how to make content useful for the future - conversation with Portia Burton
27:22
27:22
Play later
Play later
Lists
Like
Liked
27:22How 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

1
[Podcast] Breaking ground: New API documentation course at UW, with Bob Watson
53:05
53:05
Play later
Play later
Lists
Like
Liked
53:05In this podcast, I chat with Bob Watson about an upcoming API documentation course he'll be teaching at the University of Washington. Bob has extensive experience working as an API technical writer at big tech companies like Microsoft, Amazon, and Google. The UW reached out to Bob to develop this new course offering. The 14-week evening course will…
…
continue reading

1
My 2024 technical writing trends and predictions
28:28
28:28
Play later
Play later
Lists
Like
Liked
28:28I've been mulling over whether to write a trends post this year. There's so much uncertainty, it's hard to feel confident about how the tech writing profession will play out. But little trends-related ideas keep surfacing in the back of my mind, so I decided to write out some of my thoughts. Before I jump into this, I want to say that I’m much more…
…
continue reading

1
Podcast: Notes and themes from Zen and the Art of Motorcycle Maintenance by Robert Pirsig
1:03:29
1:03:29
Play later
Play later
Lists
Like
Liked
1:03:29These are some notes and thoughts from reading Robert Pirsig's classic philosophical novel, Zen and the Art of Motorcycle Maintenance, published in 1974. My reading here focuses more on the technical writing aspects and themes from the book. Some themes include Classic versus Romantic modes of thought, the concept of Quality, our relationship with …
…
continue reading

1
Webinar recording: Experiments and use cases for AI from a tech writer’s perspective
1:02:34
1:02:34
Play later
Play later
Lists
Like
Liked
1:02:34I recently gave a webinar titled 'Experiments and use cases for AI from a tech writer’s perspective' on December 8, 2023. The webinar was sponsored by the STC Washington, DC - Baltimore Chapter. In this presentation, I shared some personal experiences in using AI for different writing-related use cases, explaining what I’ve found helpful. These use…
…
continue reading

1
30+ ways I’m using AI in everyday writing life as a technical writer, blogger, and curious human
44:33
44:33
Play later
Play later
Lists
Like
Liked
44:33In this post, I provide over 30 real-life examples of how I'm using AI on a daily basis, not just for technical writing tasks but more broadly in life, including summarizing content, explaining concepts, answering questions, troubleshooting problems, and having engaging conversations for a variety of tasks and scenarios. In my view, AI use cases ar…
…
continue reading

1
Podcast: The evolution of podcasting, with Ed Marsh
57:24
57:24
Play later
Play later
Lists
Like
Liked
57:24In this podcast, I talk with Ed Marsh about podcasting. You may have listened to Ed Marsh's Content Content podcast previously. As an experienced podcaster, Ed has a lot of insights and thoughts about podcasting. We discuss what initially drew him to start podcasting, the equipment and logistics involved in podcasting, different formats that engage…
…
continue reading

1
Demystifying DevRel and Tech Writing - Discussion with Kruno Golubic and Katarina Šupe
53:52
53:52
Play later
Play later
Lists
Like
Liked
53:52Technical 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

1
Podcast: Tech writing and Zen and the Art of Motorcycle Maintenance, with Dan Grabski
42:12
42:12
Play later
Play later
Lists
Like
Liked
42:12In this episode, I chat with Dan Grabski, a senior content developer based in Portland, both about his recent WTD talk titled 'Zen and the Art of Manually Creating API Documentation' and Robert Pirsig's 'Zen and the Art of Motorcycle Maintenance.' Dan explains the importance of focusing not just on technical details of implementations but also on i…
…
continue reading

1
Doing research with AI tools -- avoiding the trap of fabricated URLs
14:56
14:56
Play later
Play later
Lists
Like
Liked
14:56In this short podcast, I explore using AI tools to do research, the potential for fake URLs, and how to deal with the fabrication. I started by using Claude to summarize a podcast and provide a list of salient points, including the potential counterargument. What I didn't expect was for Claude to fabricate a list of imagined research and then summa…
…
continue reading

1
Notes for Building the Cycling City: The Dutch Blueprint for Urban Vitality
46:49
46:49
Play later
Play later
Lists
Like
Liked
46:49In Building the Cycling City: The Dutch Blueprint for Urban Vitality, Melissa and Chris Bruntlett describe how the Dutch achieved so much cycling success, and how other cities might do the same. The authors bring up a variety of techniques and approaches the Dutch have used, such as seamlessly integrating cycling with public transit, pursuing custo…
…
continue reading

1
Fostering an API-first culture in a startup environment - Discussion with Alex Akimov and Helen Kosova
42:54
42:54
Play later
Play later
Lists
Like
Liked
42:54From 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

1
My experience trying to write original, full-length human-sounding articles using Claude AI
37:30
37:30
Play later
Play later
Lists
Like
Liked
37:30You can use AI tools like Claude to help you write full-length content. By going paragraph-by-paragraph, you can direct the AI while seemingly maintaining your own voice and ideas. However, despite my attempts to use AI with writing, I've found that it's harder to pull off than I thought. I can get close, but due to the way AI tools are trained, th…
…
continue reading

1
Chatting about AI trends and tech comm with Fabrizio Ferri Benedetti
49:01
49:01
Play later
Play later
Lists
Like
Liked
49:01In this podcast, I chat with Fabrizio Ferri Benedetti, a tech writer in Barcelona who blogs at passo.uno and works for Splunk, about various AI news topics. We talk about the Forrester AI jobs impact forecast, the community element in documentation, the way the profession is changing with AI, content design roles with LLMs, how complex processes an…
…
continue reading

1
[Podcast] AI and APIs: What works, what doesn't
1:00:58
1:00:58
Play later
Play later
Lists
Like
Liked
1:00:58In conversations about AI, a lot of tech writers are asking what kind of scenarios is AI good for? What works, what doesn’t? In which scenarios? You may have read my responses to these questions before in previous posts, but this time I recorded a podcast with slides. In the podcast, I try to pull together these ideas into more of a narrative shape…
…
continue reading

1
Empowered community through user-centered design - Discussion with Anthony Pichardo
23:51
23:51
Play later
Play later
Lists
Like
Liked
23:51With 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