WTD Episode 14: Humanizing your documentation

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 gendere
53 Minuten
Podcast
Podcaster
A discussion podcast based on WTD topics and issues, focused on technical writing and documentation for software products.

Beschreibung

vor 7 Jahren
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.

Kommentare (0)

Lade Inhalte...

Abonnenten

15
15