ENGL-2333RTechnical Writing I

Technical Communications - Ninth Edition

Lannon, John M.

Chapter 2 - Preparing an Effective Technical Document

1. Consider the Key Tasks - (you will be doing four tasks in writing)
   1. Deliver the essential information
      1. Accurate information
      2. Answer questions:(like)
         1. How much explaining should I do?
         2. How will I organize?
         3. Do I need visuals?
   2. Make a persuasive case
      1. When the facts are neither complete or conclusive you need to make decisions
      2. Decisions represent you and your company
   3. Weigh the ethical issues
      1. Do you over look or sugarcoat things
      2. Is it fair and who might benefit or suffer are a few questions to ask.
   4. Work in teams
      1. Much of writing may be multinational in focus, and you may coloborate with people you have never met.
      2. You will need to work with diverse people with divese backgrounds
2. Rely on Creative and Critical Thinking
   1. Creative Thinking - explore new ideas, build on information
   2. Critical Thinking - test our ideas
   3. We apply these through the four stages in the writing process
      1. Gather and evaluate ideas and information
      2. Plan the document
      3. Draft the document
      4. Revise the document
   4. No one stage of these steps is complete till all are complete
3. In Brief: Communicating in a Virtual Company
4. Guidelines for Writing with a Computer
   1. Beware of computer junk - because it is easy to put in words, do not necessarily do it
   2. Do not confuse style with substance - fancy fonts and design cannot help a document that does not have good content
   3. Save and print work ofen
   4. Revise on hard copy
   5. NEVER depend on automated "checkers"
   6. Select a design and a transmission method that your audience favors
5. Exercises
6. Collaborative Project
7. Service-Learning Project