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

Artwork

Tech API The Docs

内容由API The Docs提供。所有播客内容（包括剧集、图形和播客描述）均由 API The Docs 或其播客平台合作伙伴直接上传和提供。如果您认为有人在未经您许可的情况下使用您的受版权保护的作品，您可以按照此处概述的流程进行操作https://zh.player.fm/legal。

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

4y ago 37:23

分享

MP3•单集首页

内容由API The Docs提供。所有播客内容（包括剧集、图形和播客描述）均由 API The Docs 或其播客平台合作伙伴直接上传和提供。如果您认为有人在未经您许可的情况下使用您的受版权保护的作品，您可以按照此处概述的流程进行操作https://zh.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

56集单集

#Tech #API The Docs

Artwork

Intentional Jargon and Technical Documentation – Interview with Erin McKean

API The Docs Podcast

published 4y ago

分享

MP3•单集首页

内容由API The Docs提供。所有播客内容（包括剧集、图形和播客描述）均由 API The Docs 或其播客平台合作伙伴直接上传和提供。如果您认为有人在未经您许可的情况下使用您的受版权保护的作品，您可以按照此处概述的流程进行操作https://zh.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

56集单集

#Tech #API The Docs

सभी एपिसोड

×

欢迎使用Player FM

Player FM正在网上搜索高质量的播客，以便您现在享受。它是最好的播客应用程序，适用于安卓、iPhone和网络。注册以跨设备同步订阅。

收听超过500个主题