Difference between revisions of "Common Writing Mistakes"

From CompSciWiki
Jump to: navigation, search
(→‎Improper Usages: add line at beginning)
(→‎Common Errors: Added pic of poorly written protest message)
 
(36 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
== Introduction ==
+
{{3040Topic |Chapter_TOC=[[Resources|Resources]] '''> Common Writing Mistakes''' |
 +
Introduction=
 
Everyone has read articles, papers or instructions littered with errors which can be either humourous or frustrating. With technical writing, you don't want either of these scenarios. Your writing should be clear and concise because the goal of what you are writing is to explain a topic. Having the errors in your writing appear either humourous or frustrating to the reader is the last thing you want the reader to experience. The reader should be able to clearly understand the concepts of what is being explained to them.
 
Everyone has read articles, papers or instructions littered with errors which can be either humourous or frustrating. With technical writing, you don't want either of these scenarios. Your writing should be clear and concise because the goal of what you are writing is to explain a topic. Having the errors in your writing appear either humourous or frustrating to the reader is the last thing you want the reader to experience. The reader should be able to clearly understand the concepts of what is being explained to them.
  
−
The best way to make sure the reader understands what has been written is to get rid of all the common mistakes in our writing. Some of the common errors are hard to catch because of the word's spelling or pronunciation. Lets take a look at some of these errors so that they can be fixed. Many of us are guilty of committing these errors, so lets try and reduce them.
+
|...by students=
 +
''Writing About Errors''
 +
Writing this section has probably got to be the most difficult to write. What could be worse than making spelling, grammar, or syntax mistakes when writing about common errors in writing? I just hope I didn't make any blatantly obvious errors which destroy the credibility of this section.
 +
}}
  
 +
Eliminating the common mistakes is the best way to ensure that the reader easily understands our writing. Some common errors are hard to catch because of the word's spelling or pronunciation. Lets take a look at some of these errors so that they can be fixed. Many of us are guilty of committing these errors, so lets try and reduce them.
  
−
== List of Common Errors ==
+
 
 +
== Common Errors ==
 +
[[Image:5yearstomany.jpg|thumb|A poorly written protest sign is always a good way to get your point across.]]
 
It can't be stressed enough: if you are guilty of these mistakes often use the search function in your word processor to find these words to double check your usage of them. When in doubt, try using another word. A thesaurus is good for looking up similar meaning words.
 
It can't be stressed enough: if you are guilty of these mistakes often use the search function in your word processor to find these words to double check your usage of them. When in doubt, try using another word. A thesaurus is good for looking up similar meaning words.
 +
 +
=== Word Phrases ===
 +
Avoid using obscure technical terms or buzz words. When using technical terms, make sure they are clearly defined in your document. Using terms the audience may not know will only lead to feelings that the document is unnecessarily wordy or above their grasp. Reading academic papers is often difficult for this reason. Remember that you are better off writing something that everyone understands<ref name="errors">[http://www.docsymmetry.com/mistakes-technical-writers-make.html Common Errors in Technical Writing]</ref>.
 +
 +
*'''Wordy Sentence'''<ref>[http://en.wikipedia.org/wiki/Nautical_terms Nautical Terms]</ref>
 +
**The ship must weigh anchor using the capstan.
 +
 +
*'''Less Wordy Version'''
 +
**The ship must raise it's anchor using a vertically mounted winch.
 +
 +
As for buzz words, nothing says you're B.S.ing like buzz words.
 +
 +
*'''Buzz Word Filled Sentence'''<ref>[http://www.atrixnet.com/bs-generator.html Corporate B.S. generator]</ref>
 +
**Our company needs to intrinsicly myocardinate interactive intellectual capital.
 +
 +
=== Tenses ===
 +
Maintaining a consistent tense throughout a sentence or paragraph can be difficult. Sentences can sound perfectly correct even when the sentences switch from present tense to past tense. Tense allow a reader to understand the time frame in which events occur <ref>[http://owl.english.purdue.edu/handouts/grammar/g_tensec.html Verb Tense Consistency]</ref>. Mastering the use of tenses will allow your writing to be understood clearly.
 +
 +
*'''Past Tense'''
 +
**I went to my technical communications class today.
 +
 +
*'''Present Tense'''
 +
**I am going to my technical communications class today.
 +
 +
*'''Future Tense'''
 +
**I will be going to my technical communications class today.
 +
 +
When writing technical documents or instructions it is best to use the present tense. With instructions, the user will be performs the step in the present, not in the future<ref name="errors"/>. Also, avoid the use of conditional phrases because conditionals make instructions lack clarity.
 +
 +
*'''Conditional Tense'''
 +
**Formatting your hard drive '''may''' erase all the data on the hard drive.
 +
 +
The outcome from the above example is not clear. The conditional only confuses the reader where proper instructions lead to a clear outcome.
 +
 +
*'''Without Conditional Tense'''
 +
**Formatting your hard drive erases all the data on the hard drive.
  
 
=== Improper Usages ===
 
=== Improper Usages ===
−
Here are a few of the more commonly misused words. For a much larger list of words, see here [http://www.wsu.edu/~brians/errors/errors.html]
+
Here are a few of the more commonly misused words.<ref>[http://www.wsu.edu/~brians/errors/errors.html Large list of errors]</ref> <ref>{{cite book |title=Technical Communication: A Practical Approach |last=Pfeiffer |first= William S. |authorlink= |coauthors=Jan Boogerd |year=2006 |publisher=Pearson |location=Toronto |isbn=0-13-196293-0 |pages= }}</ref> See here for a much larger [http://www.wsu.edu/~brians/errors/errors.html list of errors].
  
 
*'''a''' and '''an'''
 
*'''a''' and '''an'''
−
**It is '''a''' wonder monkey. (place before consonant/consonant sound)
+
**It is '''a''' monkey. (place before consonant/consonant sound)
 
**There is '''an''' elephant with the monkey. (place before vowel/vowel sound)
 
**There is '''an''' elephant with the monkey. (place before vowel/vowel sound)
 
*'''ain't'''
 
*'''ain't'''
−
***'''Ain't''' '''ain't''' a word because '''ain't''' '''ain't''' in the dictionary. (Even if it IS, your not using it!)
+
**'''Ain't''' '''ain't''' a word because '''ain't''' '''ain't''' in the dictionary. (Even if it is in the dictionary <ref>[http://en.wiktionary.org/wiki/ain%E2%80%99t Wiktinary word "ain't"]</ref>, you're not using it!)
 
*'''a lot''' and '''alot'''
 
*'''a lot''' and '''alot'''
 
**There is no such word as '''alot'''.
 
**There is no such word as '''alot'''.
 
*'''assure''', '''ensure''', and '''insure''
 
*'''assure''', '''ensure''', and '''insure''
−
***The monkey has '''assured''' me he won't escape his cage. (promise)
+
**The monkey has '''assured''' me he won't escape his cage. (promise)
−
***Please '''ensure''' the monkey does not escape his cage. (make certain)
+
**Please '''ensure''' the monkey does not escape his cage. (make certain)
−
***I need to '''insure''' my monkey. (insurance)
+
**I need to '''insure''' my monkey. (insurance)
 
* '''effect''', and '''affect'''
 
* '''effect''', and '''affect'''
 +
**The use of monkeys in these examples will remain in '''effect''' till I think of something better.(use, result, or achieve)
 +
**People were '''affected''' by the smell of the monkeys. (influence)
 
*'''flammable''', '''inflammable''', and '''non-flammable'''
 
*'''flammable''', '''inflammable''', and '''non-flammable'''
 
**'''Flammable''' and '''inflammable''' mean the same thing. Something that burns easily. Usually the prefix 'in' in front of a word would imply the opposite. But NOT in this case!
 
**'''Flammable''' and '''inflammable''' mean the same thing. Something that burns easily. Usually the prefix 'in' in front of a word would imply the opposite. But NOT in this case!
Line 28: Line 73:
 
*'''it's''' and '''its'''
 
*'''it's''' and '''its'''
 
**'''It's''' a baboon, not a monkey. (contration of it is)
 
**'''It's''' a baboon, not a monkey. (contration of it is)
−
**That belongs with the baboon and its cage. (possessive)
+
**That belongs with the baboon and '''its''' cage. (possessive)
 
*'''principal''' and '''principle'''
 
*'''principal''' and '''principle'''
 
**He believed in the '''principle''' of justice for all. (basic truths)
 
**He believed in the '''principle''' of justice for all. (basic truths)
Line 41: Line 86:
 
**'''Two''' is the number 2.
 
**'''Two''' is the number 2.
  
−
== External References ==
+
== References ==
−
*[http://www.wsu.edu/~brians/errors/errors.html Large list of errors]
+
<references/>
−
*textbook
+

Latest revision as of 13:43, 11 April 2008

COMP3040 > Resources > Common Writing Mistakes


Introduction

Everyone has read articles, papers or instructions littered with errors which can be either humourous or frustrating. With technical writing, you don't want either of these scenarios. Your writing should be clear and concise because the goal of what you are writing is to explain a topic. Having the errors in your writing appear either humourous or frustrating to the reader is the last thing you want the reader to experience. The reader should be able to clearly understand the concepts of what is being explained to them.






...by students

Writing About Errors Writing this section has probably got to be the most difficult to write. What could be worse than making spelling, grammar, or syntax mistakes when writing about common errors in writing? I just hope I didn't make any blatantly obvious errors which destroy the credibility of this section.

Eliminating the common mistakes is the best way to ensure that the reader easily understands our writing. Some common errors are hard to catch because of the word's spelling or pronunciation. Lets take a look at some of these errors so that they can be fixed. Many of us are guilty of committing these errors, so lets try and reduce them.


Common Errors

A poorly written protest sign is always a good way to get your point across.

It can't be stressed enough: if you are guilty of these mistakes often use the search function in your word processor to find these words to double check your usage of them. When in doubt, try using another word. A thesaurus is good for looking up similar meaning words.

Word Phrases

Avoid using obscure technical terms or buzz words. When using technical terms, make sure they are clearly defined in your document. Using terms the audience may not know will only lead to feelings that the document is unnecessarily wordy or above their grasp. Reading academic papers is often difficult for this reason. Remember that you are better off writing something that everyone understands[1].

  • Wordy Sentence[2]
    • The ship must weigh anchor using the capstan.
  • Less Wordy Version
    • The ship must raise it's anchor using a vertically mounted winch.

As for buzz words, nothing says you're B.S.ing like buzz words.

  • Buzz Word Filled Sentence[3]
    • Our company needs to intrinsicly myocardinate interactive intellectual capital.

Tenses

Maintaining a consistent tense throughout a sentence or paragraph can be difficult. Sentences can sound perfectly correct even when the sentences switch from present tense to past tense. Tense allow a reader to understand the time frame in which events occur [4]. Mastering the use of tenses will allow your writing to be understood clearly.

  • Past Tense
    • I went to my technical communications class today.
  • Present Tense
    • I am going to my technical communications class today.
  • Future Tense
    • I will be going to my technical communications class today.

When writing technical documents or instructions it is best to use the present tense. With instructions, the user will be performs the step in the present, not in the future[1]. Also, avoid the use of conditional phrases because conditionals make instructions lack clarity.

  • Conditional Tense
    • Formatting your hard drive may erase all the data on the hard drive.

The outcome from the above example is not clear. The conditional only confuses the reader where proper instructions lead to a clear outcome.

  • Without Conditional Tense
    • Formatting your hard drive erases all the data on the hard drive.

Improper Usages

Here are a few of the more commonly misused words.[5] [6] See here for a much larger list of errors.

  • a and an
    • It is a monkey. (place before consonant/consonant sound)
    • There is an elephant with the monkey. (place before vowel/vowel sound)
  • ain't
    • Ain't ain't a word because ain't ain't in the dictionary. (Even if it is in the dictionary [7], you're not using it!)
  • a lot and alot
    • There is no such word as alot.
  • 'assure, ensure, and insure
    • The monkey has assured me he won't escape his cage. (promise)
    • Please ensure the monkey does not escape his cage. (make certain)
    • I need to insure my monkey. (insurance)
  • effect, and affect
    • The use of monkeys in these examples will remain in effect till I think of something better.(use, result, or achieve)
    • People were affected by the smell of the monkeys. (influence)
  • flammable, inflammable, and non-flammable
    • Flammable and inflammable mean the same thing. Something that burns easily. Usually the prefix 'in' in front of a word would imply the opposite. But NOT in this case!
    • Non-flammable is the opposite of Flammable and inflammable.
  • it's and its
    • It's a baboon, not a monkey. (contration of it is)
    • That belongs with the baboon and its cage. (possessive)
  • principal and principle
    • He believed in the principle of justice for all. (basic truths)
    • No, the principal is not a monkey. (all other uses)
  • there, their, and they're
    • The monkey is over there by the tree. (location)
    • That is their monkey. (possessive)
    • They're going to get a monkey as a pet. (contraction of they are)
  • to, too, and two
    • I am going to the store to buy a monkey.
    • There are too many monkeys here.
    • Two is the number 2.

References

  1. ↑ 1.0 1.1 Common Errors in Technical Writing
  2. ↑ Nautical Terms
  3. ↑ Corporate B.S. generator
  4. ↑ Verb Tense Consistency
  5. ↑ Large list of errors
  6. ↑ Pfeiffer, William S.; Jan Boogerd (2006) Technical Communication: A Practical Approach; Pearson Toronto ISBN:0-13-196293-0
  7. ↑ Wiktinary word "ain't"
Retrieved from "https://hci.cs.umanitoba.ca/mediawiki/index.php?title=Common_Writing_Mistakes&oldid=6460"