Sequence For Sense
Clear writing follows clear logic. When information appears in the right order, readers barely...
Read More
Category: Advent Calendar of Effective Tech Writing
Write In One Voice
Readers should never feel like they are switching authors halfway through your product...
Read More
Lead With What Matters
Readers do not read linearly. The first thing they see should answer the question they came with....
Read More
Walk The Path You Write
If you want readers to succeed, follow your own instructions. Testing what you write exposes gaps,...
Read More
Write For Everyone
Good products start with writing that works for everyone. Not everyone using your content speaks...
Read More
Don’t Timestamp Your Text
Documentation should age gracefully. Words like currently, new, or soon pin your writing to a...
Read More
You’re Not the Audience
It is easy to write from what you know. But your reader is not you. What feels obvious to an...
Read More
If It’s Hard to Describe, Sketch It
When words start working too hard, it’s time for a visual. Some concepts like workflows,...
Read More
Write What You Want to Happen
Good writing gives direction. Instead of describing what not to do or what might happen, it tells...
Read More
Be Consistent, Not Creative
Creativity matters in product work. It matters far less in instructions. When users read docs,...
Read More
Stay Consistent with Your Terms
Consistency builds confidence. When your writing uses different words for the same thing, readers...
Read More
Write Actions, Not Abstractions
Abstract language hides the work. It talks around action instead of guiding it. In technical...
Read More
