Tech Description
Technical professionals are often required to
define or describe a technical object, concept, or process to someone who has
little knowledge or experience with the subject at hand. For example, an
engineering firm might write a proposal to bid on a contract to develop a
helicopter for the Defense Department; one section of the proposal would be a
detailed description of the product the company proposes to develop. Technical
descriptions are used before products and processes are developed (as part of
proposals and planning documents), during development (in progress reports, for
instance), and afterwards (as part of marketing and promotional literature and
technical support documents).This assignment asks you to select a product or process and write a description of it. It's a good idea to select something with which you are already familiar, so you can focus on learning how to write the description rather than focusing on both learning how to write the description and learning about the product or process. There are two different kinds of technical descriptions to consider. Choose whichever one is appropriate, depending on your topic.
Video Example: "How a Bailout Works" (South Park)
Product
Description
A product description explains the features of a specific
device, like a scientific instrument or computer program. Possible topics
include devices that are specific to your field, or devices you use in everyday
life:
List of Possible Topics:
·
Wind Turbines
·
Fuel cell
·
Battery
·
Human Powered Aircraft
·
Mitosis
·
A specific car model
Process Description
A process description explains
how a complex event occurs, including a mechanical process (i.e. how donuts are
made) or natural event (i.e. how lightning is produced). You can choose a
process that is specific to your field, or one that people may be curious
about:
List of Possible Topics
·
How a specific drug
works
·
How to conduct wind
tunnel testing
·
How a hearing aid works
·
How a computer compiles
and executes a program
·
How to manufacture jelly
beans
·
How food products are
irradiated
It is important to note that a product or process description is not an instruction set. An instruction set provides steps a user would take in order to complete a task (for example, steps to change oil in a car). In contrast, product and process descriptions describe how something works (for example, how oil functions to cool an engine). The contrast is between how to use something and how that thing works (e.g. how to use a microwave versus how the microwave heats food). For this assignment, you should focus on how things work, not how to use them. The next assignment will ask you to focus on instructions.
For Your Consideration
Before you begin to write, make sure to consider the rhetorical situation: audience, purpose and subject in order to construct the most effective argument.
Audience and Purpose
Select an audience that would be interested in learning about the process or product you explain. For example, you could assume an audience of students reading about your topic in a textbook. You could write a marketing document to persuade people to buy a product. Or, you could write a description that would be part of a proposal being sent to a potential client. In the assignment you should assume that the description is crucial to the work of your audience.
Gathering Information
Take time to learn about the product or
process you select. This might require you to read background information or
otherwise inform yourself about the topic.
Contents
For product descriptions, start with a
sentence definition of the product and its various parts. This could become an
extended definition if you think your audience needs more introductory
information. Next, describe each part of the product in more detail, including
its dimensions, materials, function, and relation to other parts. Conclude with
a description of one complete operating cycle for the product.
For process descriptions, start with a
definition of the process and the different steps it involves. Again, this
could become an extended definition if you think your audience needs more
introductory information. Next, describe each step in more detail. Conclude
with a summary of one complete cycle in the process.
In either case, though, remember to choose
contents based on the audience's level of interest, experience, and knowledge
about the topic.
Format
Include design features to help the reader
locate information and understand the product or process better: diagrams,
headers, bulleted lists and other technical communication conventions you've
learned about. The final paper should be at least 1000 words and should be
single-spaced.
Visuals
You have two options here. First, you can develop your own visuals (a rough sketch is fine if you don't know how to prepare one with a computer program). Second, you can use a "reference visual," which is a copy of a published image. If you use a published image, be sure to cite the source and discuss any modification that image needs to fit your context. (For example, if you're describing how a snowblower engine works, you might use an image from the manufacturer's website rather than drawing your own. And if you can't find the exact image you need, you could use a similar image and discuss how your ideal image might be different.)
Writer's Checklist for Product Descriptions
Did you provide a one sentence definition of your product in the introduction?
Did you clearly indicate the nature
and scope of the description?
Follow-up Introduction
What is the item?
What does it do?
What is its function?
What does it look like?
What is its principle of operation?
What are its principal parts?
Did you include a graphic identifying all the principal
parts?
The Major Components of the Body
Did you choose an appropriate organizing principle?
Have you included graphics for each of the components?
The Conclusion
Have you summarized the major points in the part-by-part
description?
Have you included (where appropriate) a description of the
item performing its function or an attempt to motivate the reader to take
action?
Writer's Checklist for Process Description
Did you provide a one sentence definition
of your process in the introduction?
Did you clearly indicate the nature
and scope of the description?
Follow-up Introduction
What is the process?
What is its function?
Where and when does the process take place?
Who or what performs
it?
How does the process
work?
What are its
principal steps?
Did you include a
graphic identifying all the principal steps?
The Main Components of the Body
Have you discussed the steps in chronological order?
Are the causal relationships clear among the steps?
Have you used the present tense?
Did you include graphics for each of the principal steps?
Conclusion
Have you summarized the major points in the step-by-step
description?
Does your reader understand the importance or implications
of the process?
Have you motivated the reader to take action?
Include your Email
Address on Project Page
I will send your grades through email.
Source: Mike Markel's Technical Communication 8th
Edition.
Files
Student Work
Example #3: The Nitrogen Cycle
Example #4 Human Powered Aircraft
Example #5 How a Flute is Made
Example #6: How Slingshot Works
Example #7:Space Shuttle Solid Rocket Boosters
Evaluation
Evaluation Criteria Assignment #4 Technical
Description
|
||||
|
|
|
Excellent |
Good |
Needs
Work |
|
Completeness |
The description is complete (includes all
the information requested).
Additionally, the description follows Markel's four principles for
writing descriptions. Includes visual argument. |
|
|
|
|
Detail |
The
description is clear and substantial. The description provides comprehensive,
specific, and precise detail. The sentence definition effectively begins the
description, and the visual enhances the description. |
|
|
|
|
Format and organization |
Readers
will be able to find the information they need. Design features enhance
readability. Paragraphs utilize effective topic sentences. Headings are clear. Title is effective. Includes
bullet lists. Paragraph coherence. |
|
|
|
|
Style |
The
description gives specific information in efficient sentences. Paragraphs are
unified. Includes transitions within and between paragraphs. |
|
|
|
|
Audience adaptation |
The
description clearly addresses a specific audience, and it helps the audience
understand the product or process. |
|
|
|
|
Participation |
Attendance, in-class writing assignments, planning worksheet, posted rough draft, and one peer review (30% grade). |
|
|
|
End Note
No TrackBacks
TrackBack URL: https://blogs.psu.edu/mt4/mt-tb.cgi/50818

Name: Stephanie Penatzer
Planning Worksheet for Technical Definition and Description
1. Brainstorm five processes or products with which you are familiar. Write a sentence definition for each one. Select the most promising topic.
How to prepare for a nuclear propulsion interview?
The US Navy’s Nuclear Propulsion Program is a rigorous and selective program that requires a slue of interviews to determine the best possible candidates for the position.
2. Familiarize yourself with the process or product by reading about and/or working with it. Your goal should be to become expert enough to be able to write about the process or product. Write down anything you think might be challenging about describing this process or product.
I just had an interview this week so I have personal experience with the process. I think fully describing the intensity of the situation will be challenging.
3. Think hard about the context within which the audience might use the product or process. How will you tailor your description to fit their needs?
The audience will be people who are considering joining the Navy’s nuclear program in NROTC. However, this topic is applicable to others outside of ROTC because there are other programs they can join to take this interview. The Navy also hires civilians to work as engineers.
4. Which organizational pattern makes sense for your description? Outline the process or product description at a high level.
I think this should be organized chronologically since it is more like a step-by-step process. For example: applying, studying, traveling/packing, 2 technical interviews, interview with the admiral, what to do after the interviews.
5. Where would visuals add clarity to your discussion?
Visuals may not be the best thing to use, however, they used visuals to describe the Admiral’s office and maps of the area might be helpful since some stress comes from traveling in DC. Also, the way a problem should be solve might make a good visual.
Name: Peter Ginzburg
Planning Worksheet for Technical Definition and Description
1. Brainstorm five processes or products with which you are familiar. Write a sentence definition for each one. Select the most promising topic.
Velomobile. A velomobile is a human powered vehicle which uses only the human body as the motor.
Three-Wheeled cars: some are very aero dynamic and require little energy to move.
Electric cars: very interesting and emerging technology in how to build a car that does not run on gas.
Desile cars: cars with very efficient engines that could be powered by bio diesel.
2. Familiarize yourself with the process or product by reading about and/or working with it. Your goal should be to become expert enough to be able to write about the process or product. Write down anything you think might be challenging about describing this process or product.
There are not too many velomobiles in existence and attaining data for these vehiles will be difficult to find.
3. Think hard about the context within which the audience might use the product or process. How will you tailor your description to fit their needs?
My audience might use the velomobile to ride to work and back while carrying their belonging. I will describe the pros and cons to the velomobile to help the reader deside if a velomobile is a right choice for them.
4. Which organizational pattern makes sense for your description? Outline the process or product description at a high level.
Chronological description.
5. Where would visuals add clarity to your discussion?
Visuals would be added through out the body of the paper.
Name: Paul Huemmrich
Planning Worksheet for Technical Definition and Description
1. Possible Topics
Hydrocyclone is a machine that can sort material by density or size using enhanced gravity.
Wastewater Treatment is a process where water is treated by removing solids and other contaminants before being disposed.
Hindered Settling Column is a machine that separates particles by density.
2. It might be challenging to clearly explain all the steps of wastewater treatment.
3. For hydrocyclone, and Hindered Settling Column, I could make a pamphlet highlighting the benefits of purchasing one. For wastewater treatment, I could make a pamphlet informing people to the wastewater treatment of their water supply.
4. For the topics, I would outline the process. Then I would explain each step in detail. Lastly I could highlight the benefits of the process.
5. Visual aids would clarify my discussion by allowing readers to see what I am discussing.
NEW TOPIC
Name: Stephanie Penatzer
Planning Worksheet for Technical Definition and Description
1. Brainstorm five processes or products with which you are familiar. Write a sentence definition for each one. Select the most promising topic.
How a Gas Turbine Engine Works: A gas turbine engine is a rotary engine that extracts energy from a flow of combustion gas.
2. Familiarize yourself with the process or product by reading about and/or working with it. Your goal should be to become expert enough to be able to write about the process or product. Write down anything you think might be challenging about describing this process or product.
I don’t think this topic will be challenging to describe. The only challenge would be keep the information appropriate for all audiences.
3. Think hard about the context within which the audience might use the product or process. How will you tailor your description to fit their needs?
In order to make this description audience friendly I will not use too much jargon. Any technical terms will be described in detail.
4. Which organizational pattern makes sense for your description? Outline the process or product description at a high level.
The GTE has a set of steps that work in chronological order. I will probably introduce the terms, follow through the engine, and then give a quick description of uses.
5. Where would visuals add clarity to your discussion?
Schematics of the engine will be helpful