Artwork

Contenuto fornito da API The Docs. Tutti i contenuti dei podcast, inclusi episodi, grafica e descrizioni dei podcast, vengono caricati e forniti direttamente da API The Docs o dal partner della piattaforma podcast. Se ritieni che qualcuno stia utilizzando la tua opera protetta da copyright senza la tua autorizzazione, puoi seguire la procedura descritta qui https://it.player.fm/legal.
Player FM - App Podcast
Vai offline con l'app Player FM !

Intentional Jargon and Technical Documentation – Interview with Erin McKean

37:23
 
Condividi
 

Manage episode 291782008 series 2922116
Contenuto fornito da API The Docs. Tutti i contenuti dei podcast, inclusi episodi, grafica e descrizioni dei podcast, vengono caricati e forniti direttamente da API The Docs o dal partner della piattaforma podcast. Se ritieni che qualcuno stia utilizzando la tua opera protetta da copyright senza la tua autorizzazione, puoi seguire la procedura descritta qui https://it.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 episodi

Artwork
iconCondividi
 
Manage episode 291782008 series 2922116
Contenuto fornito da API The Docs. Tutti i contenuti dei podcast, inclusi episodi, grafica e descrizioni dei podcast, vengono caricati e forniti direttamente da API The Docs o dal partner della piattaforma podcast. Se ritieni che qualcuno stia utilizzando la tua opera protetta da copyright senza la tua autorizzazione, puoi seguire la procedura descritta qui https://it.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 episodi

Tất cả các tập

×
 
Loading …

Benvenuto su Player FM!

Player FM ricerca sul web podcast di alta qualità che tu possa goderti adesso. È la migliore app di podcast e funziona su Android, iPhone e web. Registrati per sincronizzare le iscrizioni su tutti i tuoi dispositivi.

 

Guida rapida

Ascolta questo spettacolo mentre esplori
Riproduci