Technical Writing Mistakes
Let’s keep it short and to the point this week. Here’s a list of ten common mistakes you should avoid in your technical writing.
Not Knowing the Reader: Who will be reading this? Can I assume they can understand the terminology and data being presented? Make sure you’re writing for your audience.
Too Many Cooks in the Kitchen: Many reports are a collaboration between multiple people. Someone needs to be elected to produce the template, set a standard for writing style, and edit for consistency. That way, the final product has a single voice.
Not Utilizing Visual Aids: A picture is worth a thousand words. Use tables, figures, graphs, to help enhance the text. You don’t need to use words alone.
Illogical Trains of Thought: Make sure you’re starting with an Intuitive outline that follows a logical, preferably linear train of thought. Make sure your points are well made and easy to follow.
Incorrect Use of Numbering: Counted quantities should be spelled out and/or placed in parenthesis. Ex) Twenty (20) joists. Measured values should use numerals. Ex) 575 linear feet. Hyphenated values should be used only if being used as an adjective. Ex) The 30-pound stones.
Vague Adverbs & Adjectives: Stop using vague qualifiers, such as calling something “very important.” “Very” does not provide the reader with valuable or quantifiable information. The goal should be for the words in your report to provide value, not fluff.
Mispunctuation: Seriously though, if you don’t know how to use a semicolon, stop using it!
Overusing the Thesaurus: Replacing every other word with fancier sounding terms you found in the thesaurus does not improve your report. The goal should be to use precise, descriptive language.
Abbreviation Confusion: The first time you mention the term is when you should define the abbreviation. And then for the rest of the text, you should use that abbreviation.
Forgetting to Spell Check: Such a simple thing to do, but so easy to forget. Don’t be the person who makes the unfortunate typo that embarrases you for years to come.