Artwork

Inhoud geleverd door API The Docs. Alle podcastinhoud, inclusief afleveringen, afbeeldingen en podcastbeschrijvingen, wordt rechtstreeks geüpload en geleverd door API The Docs of hun podcastplatformpartner. Als u denkt dat iemand uw auteursrechtelijk beschermde werk zonder uw toestemming gebruikt, kunt u het hier beschreven proces https://nl.player.fm/legal volgen.
Player FM - Podcast-app
Ga offline met de app Player FM !

Intentional Jargon and Technical Documentation – Interview with Erin McKean

37:23
 
Delen
 

Manage episode 291782008 series 2922116
Inhoud geleverd door API The Docs. Alle podcastinhoud, inclusief afleveringen, afbeeldingen en podcastbeschrijvingen, wordt rechtstreeks geüpload en geleverd door API The Docs of hun podcastplatformpartner. Als u denkt dat iemand uw auteursrechtelijk beschermde werk zonder uw toestemming gebruikt, kunt u het hier beschreven proces https://nl.player.fm/legal volgen.

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 afleveringen

Artwork
iconDelen
 
Manage episode 291782008 series 2922116
Inhoud geleverd door API The Docs. Alle podcastinhoud, inclusief afleveringen, afbeeldingen en podcastbeschrijvingen, wordt rechtstreeks geüpload en geleverd door API The Docs of hun podcastplatformpartner. Als u denkt dat iemand uw auteursrechtelijk beschermde werk zonder uw toestemming gebruikt, kunt u het hier beschreven proces https://nl.player.fm/legal volgen.

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 afleveringen

모든 에피소드

×
 
Loading …

Welkom op Player FM!

Player FM scant het web op podcasts van hoge kwaliteit waarvan u nu kunt genieten. Het is de beste podcast-app en werkt op Android, iPhone en internet. Aanmelden om abonnementen op verschillende apparaten te synchroniseren.

 

Korte handleiding

Luister naar deze show terwijl je op verkenning gaat
Spelen