Know your target audience
. Are you writing for a technical or non-technical audience? These are two different audiences. One will understand 'technical jargon' and the other won't. Make sure you use verbiage that the end user
What is your writing goal?
You can write the most comprehensive manual or users guide but if you get lost in the details, your goal will be lost in translation! Don't get lost in the details. Step back from your work and look at the big picture. Does your writing make sense? Will the target audience understand what you wrote? If focus solely on the details your message will get lost. Review your writing now and again to make sure you're on track with your writing goal.
. Help the end user out by using examples. You may understand the information back and forwards but don't assume the end user will. Provide examples within your writing, especially if you're technical writing is for computer software. Make sure the examples are relevant and the audience can understand them.
Give credit to your resources
. Do you remember when you had to write research papers and were required to quote sources and provide a bibliography? Make sure you reference any resources you use. Give credit whenever you can.
. Most people are visual and will appreciate a table of contents, graph, or chart. Use these whenever you can because it will help the end user understand the information quickly.
Proofread your work
. If you don't have an editor or manager proofreading your work, make sure you proofread. It can be embarrassing for a company to send out a manual or guide that's filled with errors. You'd be surprised by the amount of errors found in newspapers, magazines, newsletters, books, brochures, and other writings. Ask someone to proofread your work to make sure all errors are found and corrected.
Have someone review your work
. Constructive criticism can improve your technical writing skills. Don't be afraid to get a second opinion. It's good to have a different perspective because you may have missed something or discover a new way of presenting information.
.. >> More