1. Clarity
The ultimate goal of good technical writing is clarity. If you write a memo, letter, or report that is
unclear your readers, then what have you accomplished?
You have wasted time. If your readers must write you a follow-up inquiry to determine your needs,
this wastes their time.
To avoid these time-consuming endeavors, write for clarity.
One way to achieve clarity is by supplying specific, quantified information. If you write using vague,
abstract adjectives or adverbs, such as some or recently , your readers will interpret these words in
different ways.
- Use easily understandable words
Avoid obscure words and be careful when you use acronyms, abbreviations, and jargon.
- Using Acronyms, Abbreviations, and Jargon
In addition to obscure words, a similar obstacle to readers is created by acronyms, abbreviations,
and jargon.
Examples
:( However, more often than not, acronyms, abbreviations, and jargon cause problems, not because
they are too common but because no one understands them.
Your technical writing loses clarity if you depend on them.
2. Conciseness :
- Conciseness means to the point
- Conciseness helps clarity
- Conciseness save time
- Technology demands conciseness
- whatever you write it should be concise in order to achieve the Objective of Technical writing .
In order to be achieve technical writing objectives ,
it must be accurate.
It requires the proofreading of the text.
- Let someone else read it
- Use the gestation approach
- Read backwards
- Use dictionary
- Use technology
- Read one line at a time
- Read it out loud
- Check figures
- Read long words syllable by syllable (split form)
- Try scattershot proofing (random)
Well explained...
ReplyDeleteSplendid
I think you can add Accessibility
ReplyDeleteAll Caps
Alphabetizing
Bold Face
Bulleting
Italics
Numbering
Underlining
White Space
Windows - such as boxes around important info of images.
:O)