Intentional Jargon And Technical Documentation – Interview With Erin McKean API The Docs podcast

Artwork

Tech API The Docs

Indhold leveret af API The Docs. Alt podcastindhold inklusive episoder, grafik og podcastbeskrivelser uploades og leveres direkte af API The Docs eller deres podcastplatformspartner. Hvis du mener, at nogen bruger dit ophavsretligt beskyttede værk uden din tilladelse, kan du følge processen beskrevet her https://da.player.fm/legal.

API The Docs Podcast « »
Intentional Jargon and Technical Documentation – Interview with Erin McKean

5y ago 37:23

Del

MP3•Episode hjem

Indhold leveret af API The Docs. Alt podcastindhold inklusive episoder, grafik og podcastbeskrivelser uploades og leveres direkte af API The Docs eller deres podcastplatformspartner. Hvis du mener, at nogen bruger dit ophavsretligt beskyttede værk uden din tilladelse, kan du følge processen beskrevet her https://da.player.fm/legal.

The Good Docs Project aims to create open source documentation templates, and most recently an information architecture template too. Erin McKean, one of the central orchestrators behind the Good Docs Project, is our guest for this episode. We talk with Erin about why it is so important to intentionally include jargon in your technical documentation and where to do that. She shares her practice on curating a project documentation wishlist to keep the future focus going, and why and how to get documentation treated as a key core feature of a product.

The hosts are Laura Vass (Editor of Developer Portal Newsletter, Co-Founder, Pronovix) and Anett Pozsár (Senior Technical Writer, Pronovix).

Music: Virgill - Its over now (CC)

… continue reading

60 episoder

#Tech #API The Docs

Artwork

Intentional Jargon and Technical Documentation – Interview with Erin McKean

API The Docs Podcast

published 5y ago

Del

MP3•Episode hjem

Indhold leveret af API The Docs. Alt podcastindhold inklusive episoder, grafik og podcastbeskrivelser uploades og leveres direkte af API The Docs eller deres podcastplatformspartner. Hvis du mener, at nogen bruger dit ophavsretligt beskyttede værk uden din tilladelse, kan du følge processen beskrevet her https://da.player.fm/legal.

The Good Docs Project aims to create open source documentation templates, and most recently an information architecture template too. Erin McKean, one of the central orchestrators behind the Good Docs Project, is our guest for this episode. We talk with Erin about why it is so important to intentionally include jargon in your technical documentation and where to do that. She shares her practice on curating a project documentation wishlist to keep the future focus going, and why and how to get documentation treated as a key core feature of a product.

The hosts are Laura Vass (Editor of Developer Portal Newsletter, Co-Founder, Pronovix) and Anett Pozsár (Senior Technical Writer, Pronovix).

Music: Virgill - Its over now (CC)

… continue reading

60 episoder

#Tech #API The Docs

Alle episoder

×

Velkommen til Player FM!

Player FM is scanning the web for high-quality podcasts for you to enjoy right now. It's the best podcast app and works on Android, iPhone, and the web. Signup to sync subscriptions across devices.

Lyt til 500+ emner

Lyt til dette show, mens du udforsker