Knowledgebase

Writing Technical Content Clearly Print

  • 0

Language that does not obstruct.

WHAT CLARITY REQUIRES

Short sentences Ordinary words Specific statements Active phrasing Consistent terminology

WHY SHORT SENTENCES

Long sentences require holding several things in mind while reading.

WHAT TO AIM FOR

One idea per sentence.

WHAT TO AVOID

Words chosen to sound technical Long words where short ones exist Abstraction where a concrete statement is possible

WHY TECHNICAL-SOUNDING LANGUAGE FAILS

It obscures meaning and it does not impress the reader, who wants to finish.

WHAT TO PREFER

Saying what happens.

WHAT CONSISTENCY REQUIRES

The same term for the same thing, every time.

WHY

Readers assume different words mean different things.

WHAT TO ESTABLISH

A list of terms and their agreed usage.

WHAT TO AVOID

Synonyms for variety.

WHY

Variety is a virtue in prose and a defect in technical writing.

WHAT TO DO ABOUT AMBIGUOUS WORDS

Replace them.

WHAT AMBIGUITY LOOKS LIKE

Words that could refer to several things Pronouns whose referent is unclear Instructions that could be read two ways

WHAT TO TEST

Whether a sentence could be misread.

WHY

If it can be, it will be.

WHAT TO REMOVE

Words that add nothing Qualifications that weaken without informing Repetition of what was already stated

WHAT TO KEEP

Anything the reader needs to act.

WHAT TO READ

The document aloud, or have someone else read it.

WHY

Awkward and unclear passages are audible.


Was this answer helpful?
Back

Are you happy with your experience? Leave us a review on Trustpilot.


Trustpilot