Write Your Technical Documents with Consistent Voice and Mood

Technical Writing Tips

Technical writing is consistent writing, whether you’re writing software or marketing specs.
Your sentences need to be consistent in

  • Voice
  • Mood
  • Case
  • Tense
  • Style

If you end your sentences with the same mood, voice and tense that you start them with, the battle is already won. [Which rule did this sentence violate already?]

Technique 1) Write with a consistent VOICE

If you start with active voice, end with active voice; or vice versa.

EXAMPLE: “I’d like to complain [ACTIVE] but I’m not allowed [PASSIVE] to criticize the Board.”
BETTER: “I’d like to complain [ACTIVE] but the club rules don’t allow [ACTIVE] me to criticize the Board.”

Technique 2) Write in a consistent MOOD

Stick to the same mood from one clause to another, or start a new sentence.

EXAMPLE: “Work hard [IMPERATIVE] and that’s how you’ll become successful [INDICATIVE].”
BETTER 1: “Work hard [IMPERATIVE] and achieve success [IMPERATIVE].”
BETTER 2: “Work hard [IMPERATIVE]. That’s the formula for success [INDICATIVE in a new sentence].”

MORE INFO

The Differences Between a User Guide, a Startup Guide, and a Quick Reference Guide
How to Test the quality of a User Guide
The Most Basic and Indispensable Parts of a “User Manual”
Two Different Types of Software User Manuals