WTD Episode 20: Minimum Requirements For Good Tech Docs, With Matt Reiner Write The Docs podcast

Artwork

User Experience Tech Software Development Podcasting Education Write The Docs

Innehåll tillhandahållet av Write the Docs Podcast. Allt poddinnehåll inklusive avsnitt, grafik och podcastbeskrivningar laddas upp och tillhandahålls direkt av Write the Docs Podcast eller deras podcastplattformspartner. Om du tror att någon använder ditt upphovsrättsskyddade verk utan din tillåtelse kan du följa processen som beskrivs här https://sv.player.fm/legal.

Write the Docs Podcast « »
WTD Episode 20: Minimum requirements for good tech docs, with Matt Reiner

5+ y ago 57:15

Dela

MP3•Episod hem

Innehåll tillhandahållet av Write the Docs Podcast. Allt poddinnehåll inklusive avsnitt, grafik och podcastbeskrivningar laddas upp och tillhandahålls direkt av Write the Docs Podcast eller deras podcastplattformspartner. Om du tror att någon använder ditt upphovsrättsskyddade verk utan din tillåtelse kan du följa processen som beskrivs här https://sv.player.fm/legal.

In episode 20, Matt Reiner from K15t joins us to talk about minimum standards for documentation - what techniques or standards can you put in place to help engineers and other contributors meet the minimum requirement for good tech docs? What essential sections, headings, or topics should you include in templates? And how do you help non-native speakers with grammar issues? We also discuss how tech writers can work with marketing to create honest and interesting writing. There seems to be the feeling that tech writing is dull but accurate and marketing copy is flashy and fluffy - we brainstorm ways technical writers can better align with marketing writers.

… continue reading

50 episoder

#User Experience #Tech #Software Development #Podcasting Education #Write The Docs

Artwork

WTD Episode 20: Minimum requirements for good tech docs, with Matt Reiner

Write the Docs Podcast

40 subscribers

published 5+ y ago

Dela

MP3•Episod hem

Innehåll tillhandahållet av Write the Docs Podcast. Allt poddinnehåll inklusive avsnitt, grafik och podcastbeskrivningar laddas upp och tillhandahålls direkt av Write the Docs Podcast eller deras podcastplattformspartner. Om du tror att någon använder ditt upphovsrättsskyddade verk utan din tillåtelse kan du följa processen som beskrivs här https://sv.player.fm/legal.

In episode 20, Matt Reiner from K15t joins us to talk about minimum standards for documentation - what techniques or standards can you put in place to help engineers and other contributors meet the minimum requirement for good tech docs? What essential sections, headings, or topics should you include in templates? And how do you help non-native speakers with grammar issues? We also discuss how tech writers can work with marketing to create honest and interesting writing. There seems to be the feeling that tech writing is dull but accurate and marketing copy is flashy and fluffy - we brainstorm ways technical writers can better align with marketing writers.

… continue reading

50 episoder

#User Experience #Tech #Software Development #Podcasting Education #Write The Docs

Kaikki jaksot

×

Välkommen till Player FM

Player FM scannar webben för högkvalitativa podcasts för dig att njuta av nu direkt. Den är den bästa podcast-appen och den fungerar med Android, Iphone och webben. Bli medlem för att synka prenumerationer mellan enheter.

Lyssna på 500+ ämnen