WTD Episode 14: Humanizing your documentation

In this episode, we chat with Carolyn Stransky, a journalist and JavaScript developer living in Berlin, about ways to humanize documentation. We discuss dilemmas with transparency in docs (the balance between honesty and negativity), ways to avoid gendered language (including whether to correct workplace misuse of 'he'), strategies for achieving plain language and clarity (such as by reading your content out loud), the term 'user' and alternatives, how to develop empathy for your audience, why terms like 'simple' and 'easy' are problematic (even in Marketing), tools for identifying insensitivity and complexity in docs (Hemingway, Alex), what makes content sound truly human, and more.

Links

For more information, see the following:

• Hemingway Editor
• AlexJS
• Carolyn’s Lightning talk in Berlin
• Slide deck on Humanizing documentation

Hosts for this show

---

Subscribe to the WTD Podcast

iTunes | Stitcher | Youtube | Slack | Fire TV | Android TV | RSS | Email