Insider's advice on actions your tech writers can take to create quality API documentation

Insider's advice on actions your tech writers can take to create quality API documentation

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?

Avsnitt(61)

The Ambient AI Future - conversation with Tashfeen Mahmud

The Ambient AI Future - conversation with Tashfeen Mahmud

Tashfeen Mahmud, senior technical writer at Samsung Research in Canada explains why curiosity is your best defense against technical aversion, and how to prepare for a future where technical writers a...

6 Mars 32min

Streamline release notes: balance AI and human oversight

Streamline release notes: balance AI and human oversight

Senior technical writers Gareth Brinn and Lydia Pedersen talk about using GPTs and n8n to automate release notes: scripting, prompt engineering, and synthesizing data from Jira and GitHub. Next plans ...

25 Nov 202535min

Beyond Access Control: Model-Context Protocol Paradigm

Beyond Access Control: Model-Context Protocol Paradigm

API thought leader Kevin Swiber and Pronovix CEO Kristof Van Tomme join the podcast to explore the Model Context Protocol (MCP) and the emerging governance challenges it presents to API strategy. We d...

21 Okt 202536min

State of the Docs 2025: Insights from GitBook - Discussion with Addison Schultz

State of the Docs 2025: Insights from GitBook - Discussion with Addison Schultz

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

14 Juli 202528min

How AI Impacts Technical Writing Workflows - Discussion with Anila Zaidi and Marco Spinello

How AI Impacts Technical Writing Workflows - Discussion with Anila Zaidi and Marco Spinello

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

16 Juni 202556min

Documentation by humans for humans - Discussion with Polina Zaichkina and Max Clayton Clowes

Documentation by humans for humans - Discussion with Polina Zaichkina and Max Clayton Clowes

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

18 Juli 202443min

From Inconsistent to Award-winning Docs - Conversation with Naomi Pentrel & Andrew Feierabend

From Inconsistent to Award-winning Docs - Conversation with Naomi Pentrel & Andrew Feierabend

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

8 Juli 202450min

The Secret Sauce of Developer Programs: A Conversation with Byrne Reese

The Secret Sauce of Developer Programs: A Conversation with Byrne Reese

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

27 Juni 202456min

Populärt inom Teknik

uppgang-och-fall
elbilsveckan
market-makers
rss-elektrikerpodden
skogsforum-podcast
rss-laddstationen-med-elbilen-i-sverige
natets-morka-sida
gubbar-som-tjotar-om-bilar
har-vi-akt-till-mars-an
bilar-med-sladd
rss-technokratin
rss-it-sakerhetspodden
rss-veckans-ai
ai-sweden-podcast
bli-saker-podden
rss-uppgang-och-fall
developers-mer-an-bara-kod
rss-snacka-om-ai
rss-ai-med-katarina-gospic-och-viggo-cavling
rss-fabriken-2