Do That After This – Terence Eden’s Blog

Good advice for documentation—always document steps in the order that they’ll be taken. Seems obvious, but it really matters at the sentence level.

Do That After This – Terence Eden’s Blog

Tagged with

Related links

Just Simply | Stop saying how simple things are in our docs

If someone’s been driven to Google something you’ve written, they’re stuck. Being stuck is, to one degree or another, upsetting and annoying. So try not to make them feel worse by telling them how straightforward they should be finding it. It gets in the way of them learning what you want them to learn.

Tagged with

Words To Avoid in Educational Writing | CSS-Tricks

This old article from Chris is evergreen. There’s been some recent discussion of calling these words “downplayers”, which I kind of like. Whatever they are, try not to use them in documentation.

Tagged with

Humanizing Your Documentation - Full Talk - Speaker Deck

The slides from Carolyn’s talk at Beyond Tellerrand. The presentation is ostensibly about writing documentation, but I think it’s packed with good advice for writing in general.

Tagged with

Tagged with

Readability Guidelines

Imagine a collaboratively developed, universal content style guide, based on usability evidence.

Tagged with

Related posts

Tone and style

The Clearleft tone of voice and style guide microsite.

Content buddy

Moving words around.

Words

When I hear the phrase “I reach for my revolver”, I reach for my red pen.