Technical Writing Tips
© Copyright Darrell Anderson.
![[Image: Clip art of a quill pen and ink bottle. Intended for mood and backdrop only.]](../images/quillpen.jpg)
Technical writing possesses a certain mystique, which is unfortunate. Technical writing is writing about technical subjects, not writing to sound technical. This simple concept confuses many writers. Technical writing should be as uncomplicated as any other kind of writing.
Writers want readers to understand the information they share. Readers want to grasp that information. A writer’s goal is to ensure readers understand the provided information. Achieving that goal is possible. Here are a few suggestions and reminders toward accomplishing this goal.
- Identify and understand the audience you’ll be writing for.
- Although some topics may be discussed assuming a minimum level of expertise, many do not. Know your audience but when in doubt assume your reader knows nothing about the subject. Offer as much information as possible without insulting or degrading more knowledgeable readers.
- Clarity is your most important objective.
- Keep thoughts separate. Write simply, candidly and logically.
- Use only one thought per sentence. Use only one sequence of thoughts per paragraph.
- Be precise, explicit. Avoid confusing your reader.
- Avoid the word it.
- Be objective.
- Be comfortable using an active voice and the present tense.
- Technical writing is usually unnecessarily dull just because the subject is technical — let your reader enjoy the material.
- Remember to explain acronyms, abbreviations and jargon.
- Avoid cluttering the page. White space is useful space — used to calm the reader’s eyes (and nerves).
- Write from the positive viewpoint, not the negative.
- Outlines and lists are useful — use them.
- Read out loud if you’re stumped. Sometimes hearing the text helps you write.
- Be humble and let your proofreaders and editors do their jobs. When you stop to listen and learn, your writing improves and your reader understands what you’re trying to explain. Besides, the worst proofreader and editor is the author.
- Avoid wordiness. Impress your readers by how well they understand your material, not by how much you know.
- Avoid pompous words.
- Rewrite, proofread. Rewrite, proofread. Rewrite, proofread. . . .
Technical writing is the same as any other writing. The subject is technical, not the writing. Writing is similar to other skills — so practice, practice, practice!
Remember your mission: to help people understand complex material.
Finis.