Technical Description

UNIT 2 DELIVERABLES: Technical Description

Introduction

Descriptions are essential in workplace writing because they help

ensure that readers understand the full meaning of any technical

document. As technical writers, you will be responsible for

explaining, in brief and understandable language, a product or process.

Often, definitions and descriptions are only part of a larger product, or

deliverable. For example, take the O-ring issues that caused the space

shuttle Challenger to explode. Suppose you were one of a team of

scientists that had to draft a full report to congress and the American

public explaining how the disaster occurred. Does everyone know

what an O-ring is, how it was supposed to function, and/or why it

failed that day? You would be responsible for defining and describing

O-rings to your audience—a panel of lawmakers determined to find

the cause of the disaster.

Descriptions often include definitions first, and then answer the

additional questions:

 What does it look like?

 What are its parts?

 What does it do?

 How does it work?

 How does it happen

Assignment

Connect what you have learned from the Pre-Assignment Tasks and

specifically from the material in Chapter 18, “Technical Descriptions,

Specifications, and Marketing Materials,” to construct a technical

description. You choose the topic from one of the three definitions

you wrote in part A. It should be something you are familiar with, but

ideally, it would be connected to your professional field of study.

You are asked to provide a handout for an audience who will be

attending a talk on your topic (the topic is whatever term you have

decided to define and describe). Ask yourself, what precisely my

readers need to know and why do they need to know it. Will they be

using the tool, selling the tool, manufacturing the tool? It helps to

write a purpose statement prior to writing your definition. (You must

include a purpose statement at the bottom of your cover page. Begin

this purpose statement with “The purpose of this document is to . . . .).

You must also name your audience in the purpose statement.

Purpose To practice creating precise and accurate technical descriptions for a

specific audience.

Instructions Select a specialized product or process you understand well or that

you can learn about quickly by researching it on the Web

(stethoscope, microscope, other tool or equipment, how gum disease

develops, how an earthquake occurs, how steel is made, how a

computer compiles and executes a program, etc). Write a 2-3 page

descriptions of the product or process incorporating sufficient visuals.

If you choose to describe a product, choose one that you know well or

will be using consistently in your work setting. Remember, you are

describing the process here not instructing someone on how to

complete the process—that would be a set of instructions. See pages

420-421 for the section on “Outlining and Writing a Product

Description.” Also, see the examples in the textbook.

Ideas/Suggestions

The box on page 428 of your textbook contains some excellent

Guidelines for Writing Descriptions. If you are writing a set of

specifications, see the box on page 431 of your textbook for a list of

Guidelines for Specifications. Make sure to use the Checklists on

pages 4325-436 when writing descriptions and specification.

Rubric This item is not so much a method for me to assess your deliverable as it is a checklist for you to use while constructing it. Your descriptive

document should include all elements of descriptions as described on

pages 418-420 of your textbook.

Submission Submit the Word or PDF document (pdf holds its format better when uploading to Black Board) to Black Board using the drop box portal in

the DELIVERABLES module (located on the left-hand column of the

course page).

Assessment Rubric for A-2 Description

Requirement

Meets All Meets Some Does Not

Meet All Major Elements Included

 Clear & Limiting Title (telling title)

 Appropriate level of Detail and Technicality (based on your audiences

own knowledge of the product or

process)

 Visuals that assist in understanding (must have a purpose)

 A Clear Descriptive Sequence (spatial, functional, chronological)

Introduction

 Does the document begin with the

definition of the product or process?

 Does the introduction state the

objective of the description (what you

hope to accomplish)?

 Does the introduction contain only

what the user needs to know?

Body

 Does the body provide a clear and logical sequence?

 Are the connections between the parts explained clearly?

Conclusion

 Does the conclusion provide a brief summary if necessary, or explain the

interrelation of parts- briefly, or one

complete operating cycle, or a

summary of major stages as applicable

to your type of description (see the

outlines on pages 420 and 424).

Tone and Style are Appropriate to

Audience

 purpose statement lists specific audience

 language is correct for audience (not high in tone nor elementary in understanding)

 is objective in

Mechanics

 Grammatically Correct

 Spelling is Correct

 Word Choice is Correct

 Sentences are not convoluted

Precision

 clear, concise, and to the point without excess verbiage(words)

 not excessive in length nor excessively short

 does not give information the audience does not need or want