You need to be careful when writing user guides, design documents, and specifications as ‘false’ words give the wrong impression and undermine the quality of your material.
Mr. Krabs: Hurry up! What do you think I’m paying you for?
SpongeBob: You don’t pay me. You don’t even exist. We’re just a clever visual metaphor used to personify the abstract concept of thought.
Mr. Krabs: One more crack like that and you’re outta here!
SpongeBob: No, please! I have three kids!
We both know that a Microsoft Exchange Server doesn’t have feelings, hopes and desires. But when we write technical documents, these type of human feelings can creep in.
21 Words That Trip Up Technical Writers
When writing about hardware, software, and technical systems be careful when you apply these human characteristics.
The Microsoft Style Guide for Technical Documentation reminds us that, ‘Programming documentation lends itself to some anthropomorphic treatment.. It’s acceptable that programs and commands do things, but avoid words that convey emotions (refuses), behavior (forces), and intellect (knows) rather than more straightforward actions.’
It lists the following verbs as acceptable in the right context:
- answer
- assume
- behave
- capture
- decide
- demand
- deny
- discard
- ignore
- impersonate
- inherit
- know
- own
- persist
- prevent
- realize recognize
- refuse
- remember
- think
- understand
- wait
Some are these are appropriate when writing technical documentation – others need to be removed to avoid embarrassment.
What others would you add to this list?
