| Deanna McGaughey-Summers |
|
Week 1: Introduction to Engineering Communication
Learning ObjectivesThis week, you will be introduced to the course and the basic techniques of engineering communication. Our specific learning objectives are to:
|
RemindersWeeks 2-4 will be conducted on Blackboard
Your assignment due dates are highlighted in the syllabus Assignments for week 2: 8/3/15: Discussion Board Assignment - Respond to the reading questions/activities posted in the discussion board under “Week 2” by 11:59pm on 8/3/15. 8/4/15: Discussion Board Assignment - Develop a work instruction for performing an oil change on your automobile. Format this document so that it is easy to read and use language appropriate for your target audience. On a separate sheet of paper, identify who the appropriate audience is for this type of document. Identify the writing level (4th grade, 6th grade level) that this document should be written at and explain why you believe that is the appropriate level. Post your work instruction by 11:59pm on 8/4/15. 8/5/15: Discussion Board Assignment - Select a manual from your home or work environment and prepare a critique of this document that includes: What the manual covers. Who is the target audience? How is the document organized? Is the language appropriate for the target audience? What are the strengths and weaknesses of the document? Post your manual critique by 11:59pm on 8/5/15. 8/6/15: Prepare an outline and annotated bibliography for your technical paper. See the assignment guide distributed in class and on Blackboard for specifications. Submit your assignment via “week 2” on Blackboard by 11:59pm on 8/6/15. You should record the due dates for your assignment in a calendar that you frequently use. The due dates for assignments are highlighted on the course calendar. |
Review the Syllabus
What is Technical Writing?
What is Technical Writing?Technical writing is sometimes defined as simplifying the complex. Inherent in such a concise and deceptively simple definition is a whole range of skills and characteristics that address nearly every field of human endeavor at some level. A significant subset of the broader field of technical communication, technical writing involves communicating complex information to those who need it to accomplish some task or goal.
Oxford Dictionaries Online (ODO) provides four definitions for the word technical, all of which relate to the profession of technical writing:
With these definitions in mind, it’s easy to see that technical writing has been around as long as there have been written languages. Modern references to technical writing and technical communications as a profession begin around the time of World War I as technical developments in warfare, industry and telecommunications began to evolve more rapidly. Although many people today think of technical writing as creating manuals for computers and software, the practice of technical writing takes place in any field or industry where complex ideas, concepts, processes or procedures need to be communicated. In fact, the US Bureau of Labor Statistics defines technical writers as those who “…put technical information into easily understandable language. They work primarily in information-technology-related industries, coordinating the development and dissemination of technical content for a variety of users; however, a growing number of technical communicators are using technical content to resolve business communications problems in a diversifying number of industries.”
The Goal of Technical Writing
Good technical writing results in relevant, useful and accurate information geared to specifically targeted audiences in order to enable a set of actions on the part of the audience in pursuit of a defined goal. The goal may be using a software application, operating industrial equipment, preventing accidents, safely consuming a packaged food, assessing a medical condition, complying with a law, coaching a sports team, or any of an infinite range of possible activities. If the activity requires expertise or skill to perform, then technical writing is a necessary component.
Only a small proportion of technical writing is actually aimed at the general consumer audience. Businesses and organizations deliver vast amounts of technical writing to explain internal procedures, design and produce products, implement processes, sell products and services to other businesses, or define policies. The leading professional association representing technical writing, Society for Technical Communication, hosts a number of special interest groups for these different aspects of the profession.
The Lifecycle of Technical Writing
Technical writing follows a development lifecycle that often parallels the product development lifecycle of an organization:
Oxford Dictionaries Online (ODO) provides four definitions for the word technical, all of which relate to the profession of technical writing:
- of or relating to a particular subject, art, or craft, or its techniques
- of, involving, or concerned with applied and industrial sciences
- resulting from mechanical failure
- according to a strict application or interpretation of the law or rules
With these definitions in mind, it’s easy to see that technical writing has been around as long as there have been written languages. Modern references to technical writing and technical communications as a profession begin around the time of World War I as technical developments in warfare, industry and telecommunications began to evolve more rapidly. Although many people today think of technical writing as creating manuals for computers and software, the practice of technical writing takes place in any field or industry where complex ideas, concepts, processes or procedures need to be communicated. In fact, the US Bureau of Labor Statistics defines technical writers as those who “…put technical information into easily understandable language. They work primarily in information-technology-related industries, coordinating the development and dissemination of technical content for a variety of users; however, a growing number of technical communicators are using technical content to resolve business communications problems in a diversifying number of industries.”
The Goal of Technical Writing
Good technical writing results in relevant, useful and accurate information geared to specifically targeted audiences in order to enable a set of actions on the part of the audience in pursuit of a defined goal. The goal may be using a software application, operating industrial equipment, preventing accidents, safely consuming a packaged food, assessing a medical condition, complying with a law, coaching a sports team, or any of an infinite range of possible activities. If the activity requires expertise or skill to perform, then technical writing is a necessary component.
Only a small proportion of technical writing is actually aimed at the general consumer audience. Businesses and organizations deliver vast amounts of technical writing to explain internal procedures, design and produce products, implement processes, sell products and services to other businesses, or define policies. The leading professional association representing technical writing, Society for Technical Communication, hosts a number of special interest groups for these different aspects of the profession.
The Lifecycle of Technical Writing
Technical writing follows a development lifecycle that often parallels the product development lifecycle of an organization:
- Identification of needs, audience(s), and scope
- Planning
- Research & content development
- Testing / review and revision
- Delivery / production
- Evaluation and feedback
- Disposition (revision, archiving, or destruction)
Helpful Resources
Audience Analysis and Document Planning
Discussion:
In the introduction to chapter 1, Rosenberg says that "good technical and scientific communication is one of the building blocks of civilization" (p. 3). What does he mean by this? Can you provide examples of how technical and scientific communication benefits others?
Describe the theorems of technical writing.
What role does audience play in planning and executing writing tasks? What does it mean to do an audience analysis? What specifically are you analyzing?
What are documentation plans? What are the differences between specs and project plans?
According to Ruben, how can documents be classified into genres?
What are the differences between marketing documents, conceptual documents, procedural documents, tutorials, job aids, and referential documents? Which of these are you most likely to encounter in your chosen field?
On page 9, Ruben includes a table of Communication Media Characteristics. Which of these media are you most and least likely to encounter in your field?
In the introduction to chapter 1, Rosenberg says that "good technical and scientific communication is one of the building blocks of civilization" (p. 3). What does he mean by this? Can you provide examples of how technical and scientific communication benefits others?
Describe the theorems of technical writing.
What role does audience play in planning and executing writing tasks? What does it mean to do an audience analysis? What specifically are you analyzing?
What are documentation plans? What are the differences between specs and project plans?
According to Ruben, how can documents be classified into genres?
What are the differences between marketing documents, conceptual documents, procedural documents, tutorials, job aids, and referential documents? Which of these are you most likely to encounter in your chosen field?
On page 9, Ruben includes a table of Communication Media Characteristics. Which of these media are you most and least likely to encounter in your field?
The Technical Report Assignment
|
Activity:
1. Choose a topic related to your field that you would like to research for your technical report assignment. 2. After we have discussed topics, we will begin the research process. Use keywords that generated in class to search for scientific articles in McMillen Library's Databases. You may want to also consult the library's subject guides. 3. Determine which citation style is used in your field. 4. Practice writing citations that you can use in your annotated bibliography. 5. Choose a specific type of report your would like to prepare. The genre you choose should be a form of writing specific to your field. See pp. 17-19 in Ruben for an overview of different types of technical reports. 6. Complete the audience analysis worksheets in the handout on "Audience Analysis: Building Information about Your Readers" |
|
Document Critique
Prepare a critique of the work documents students brought into class. This critique will include: How effectively does the document communicate the intended information? Is the language appropriate for the targeted audience? Does the document use active or passive voice? Students will make suggestions to improve on this document.
Questions about the course? Blackboard?
|
|