Putting together an effective technical document can be hard at times. For it to be read and understood, the writer needs to adhere to some mechanics of technical writing rules. Readers are known to trash documents that they cannot understand or those that do not meet their anticipations. To avoid that, the professional should follow these guidelines.
Before anything else, he must understand who the target audience is so as to meet their needs. If they are young, middle aged or old people, he should clearly know what language and approach to use. With this in mind, he will not end up sending a document to old folks with a language that only the youth understand.
Another rule the writer must follow is by using the correct words. Slang and jargon language are to be avoided at all times. Brief sentences that form precise paragraphs endear the reader to read on. The words must at all times be used at the right places.
To show that he understands the message that he is driving at his readers, the writer must always strive to maintain consistency through using a particular style throughout the document. The chosen style must be appropriate for the audience.
The writer should edit unnecessary verbiage that only act as verbal props. Conciseness in such documents cannot be overemphasized. He should strive to use only the necessary words to drive a particular message home. To make sure there are no grammatical, punctuation or other errors, the writer should proofread his document more than twice. Readers also tire from repetitive phrases.
Pictures such as charts and maps are sometimes used in this category of writing. As one of the mechanics of technical writing, it is therefore a must that the writer learn how and when to use them effectively.
Before anything else, he must understand who the target audience is so as to meet their needs. If they are young, middle aged or old people, he should clearly know what language and approach to use. With this in mind, he will not end up sending a document to old folks with a language that only the youth understand.
Another rule the writer must follow is by using the correct words. Slang and jargon language are to be avoided at all times. Brief sentences that form precise paragraphs endear the reader to read on. The words must at all times be used at the right places.
To show that he understands the message that he is driving at his readers, the writer must always strive to maintain consistency through using a particular style throughout the document. The chosen style must be appropriate for the audience.
The writer should edit unnecessary verbiage that only act as verbal props. Conciseness in such documents cannot be overemphasized. He should strive to use only the necessary words to drive a particular message home. To make sure there are no grammatical, punctuation or other errors, the writer should proofread his document more than twice. Readers also tire from repetitive phrases.
Pictures such as charts and maps are sometimes used in this category of writing. As one of the mechanics of technical writing, it is therefore a must that the writer learn how and when to use them effectively.
