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)

Techwriting, DX and DevRel working together at Miro - Part 2

Techwriting, DX and DevRel working together at Miro - Part 2

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

30 Sep 202231min

Techwriting, DX and DevRel working together at Miro - Part1

Techwriting, DX and DevRel working together at Miro - Part1

With our three Mironeer guests, DevRel Lead Anthony Roux and Senior Techwriters Mira Balani and Marco Spinello, we talked about how they joined their teams, what they learnt since, how and by whom the...

7 Sep 202234min

Interview with Anthony Sansone, staff technical writer at MongoDB - The importance of onboarding in techwriting

Interview with Anthony Sansone, staff technical writer at MongoDB - The importance of onboarding in techwriting

Our guest is Anthony Sansone, staff technical writer at MongoDB, who has spent 20+ years in computer hardware, software, and services, specializing in data protection and user security. His experience...

6 Juli 202238min

Interview with Marc Burgauer part 2 - Will social practices eat your change strategy for breakfast?

Interview with Marc Burgauer part 2 - Will social practices eat your change strategy for breakfast?

Or, maybe you could map it: what does each of you do, why, and how? We converse about integration of practices and practice networks with Marc Burgauer, co-founder of Contextualise. Together with Chri...

13 Juni 202233min

Interview with Marc Burgauer part 1 - Will social practices eat your change strategy for breakfast?

Interview with Marc Burgauer part 1 - Will social practices eat your change strategy for breakfast?

Or, maybe you could map it: what does each of you do, why, and how? We converse about integration of practices and practice networks with Marc Burgauer, co-founder of Contextualise. Together with Chri...

13 Juni 202238min

When is no news good news for a scheduling platform? - Interview with DevRel Kristyn Bryan and Application Architect Dmitry Pashkevich from Calendly

When is no news good news for a scheduling platform? - Interview with DevRel Kristyn Bryan and Application Architect Dmitry Pashkevich from Calendly

We asked DevRel Kristyn Bryan and Application Architect Dmitry Pashkevich from the Calendly API team about the new, v2 of their API and the upgraded devportal. Why and how did they redesign the legacy...

3 Juni 202237min

Source code access, consistency: some ingredients of Adyen's API program

Source code access, consistency: some ingredients of Adyen's API program

Interview with Ruby Batallones, Technical Writer at Adyen and Aleksei Akimov, Head of API at Adyen Involve your technical writers already from the API design discussions: this can help ensure a consis...

11 Jan 202233min

Confidence and Critical Thinking in Techwriting: Part 2

Confidence and Critical Thinking in Techwriting: Part 2

MongoDB is one of the most popular NoSQL database programs, providing both on-premise and cloud-based solutions. Tony works as a senior technical writer on cloud based tools. He has 20+ years experien...

2 Sep 202120min

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