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.

Words To Avoid in Educational Writing | CSS-Tricks

Tagged with

Related links

Monzo tone of voice

Some good—if overlong—writing advice.

  • Focus on what matters to readers
  • Be welcoming to everyone
  • Swap formal words for normal ones
  • When we have to say sorry, say it sincerely
  • Watch out for jargon
  • Avoid ambiguity: write in the active voice
  • Use vivid words & delightful wordplay
  • Make references most people would understand
  • Avoid empty adjectives & marketing cliches
  • Make people feel they’re in on the joke – don’t punch down
  • Add a pinch of humour, not a dollop
  • Smart asides, not cheap puns and cliches
  • Be self-assured, but never arrogant

Tagged with

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.

Tagged with

An editor’s guide to giving feedback – Start here

I was content-buddying with one of my colleagues yesterday so Bobbie’s experience resonates.

Tagged with

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

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