Thursday, May 14, 2015

Use Simple Words In Technical Writing

Use Simple Words in Technical Writing


Technical writing seems to be, well, technical. To make it easier on the reader, you should use simple words in technical writing. This doesn't mean you have to dumb the text down, it just means that you must pick every word carefully.


Instructions


1. Use common speech. Instead of writing "demonstrates," use the word "shows." Instead of using the word "commonality," use the word "common" in reference to your subject. Never try to sound smart with big words in a technical document, it will only confuse the reader and make you look dumb.


2. Write for the reader. When you are involved in technical writing, you tend to have a particular audience you are writing to. You must use technical jargon when it is called for, but stay away from it when you can use a more simple set of words.


3. Construct steps in a simple manner. Technical writing has an intent to inform. If you are tasked with walking the reader through a series of steps, make sure that you use simple words to convey each step clearly.


4. Cut out all unnecessary verbiage. Simple, concise sentences will always be easier for a reader to comprehend. Don't use five words to make a point that can be made in two or three.


5. Keep things in the present tense. Unless you have to refer back to a step or bit of information from the beginning of your technical document, keep all writing in the here and now. Words are used to inform in technical writing, and you cannot afford to have any confusion.