1 Technical Descriptions Purpose Parts Rewriting.

1

Technical Descriptions

Purpose Parts Rewriting

2Modified from: Gerson & Gerson: Technical Writing, 5th Edition

Purpose of Technical Descriptions

User Manual Help reader visualize the product and understand the parts

Product Demand Specification

Order a piece of equipment of that does not currently exist

Sales Literature Identify key specifications of the product; used to market the product

Study Reports Report on problems

Design Specs Engineers describe equipment design specifications


Sample: Product Demand Spec


Sample: Sales Literature Spec


Parts of a Technical Description

Title Introduction Discussion Conclusion


Title

Clearly state the topic of your description Name the piece of equipment or

mechanism Give a serial number for identification,

if applicableThe 3219X2Z Radon Extractor

Description of the Standard Bumper Jack

The A1 Feed Switch


Introduction

Specify and define the mechanism you are describing

Explain the mechanisms functions or capabilities

List its major components


Introduction, cont.

Start with a Technical Definition: The name of the item to be defined The class to which the item belongs The features that differentiate the item

from all others in the class

Specify and define the mechanism you are describing


Technical definitions …

Term Class Features

Carburetor

a mixing device

in gasoline engines that blends air and fuel into a vapor for combustion within the cylinders

Stress an applied force

that strains or deforms a body


Technical definitions …

Term Class FeaturesFiber optics a technology that uses light energy to

transmit voices, video images, and data via hair-thin glass fibers

The standard bumper jack is a portable mechanism for raising the front or rear of a car through force applied with a lever. The jack enables even a frail person to lift one corner of a 2-ton automobile .


Introduction, cont.

The jack consists of a molded steel base supporting a free-standing perpendicular, notched shaft (Figure 1). Attached to the shaft are a leverage mechanism, a bumper catch, and a cylinder for insertion in the jack handle. Except for the main shaft and leverage mechanism, the jack is made to be dismantled. All its parts file neatly in the car’s trunk.

The jack operates on a leverage principle. During one normal jacking stroke, the operator’s hand travels 18 inches and the car raises or lowers 3/8 of an inch. Such a device requires many strokes to raise the car off the ground but may prove a lifesaver to a motorist on some deserted road.

Explain the mechanisms functions or capabilities


Introduction, cont.

List its major components

The jack includes five main parts: base, notched shaft, leverage mechanism, bumper catch, and handle. (Figure 1)


Introduction for a simple item

Introduction The topic Its function Its components

The radon extractor, used to vent harmful radon gases from basements, includes only three pieces of equipment.

Topic

Function

Components

Level of complexity depends on your

purpose and audience.


Discussion – Describes the components or parts

Use heading and subheadings to itemize and describe the components

Use graphics (with call-outs) to help the reader visualize the topic


For each main part….

Size (dimensions) Shape Weight Density Color Identifying number Make/model

See samples: Bumper jack, A1 Feed Switch

Define each part in terms of:

Texture Capacity Material (composition) Subparts Function and relation to

adjoining parts Mode of attachment


Component description

Word Usage: Quantify using specific, denotative words vs. connotative words

Denotative

Connotative

6’5” 2,045 lbs.

200’ L x 300’ H.035 mm

Gold

TallHeavyLargeThin

Precious metal


Conclusion – Depends on your Purpose

Sales Implementation of this product will provide you and your company…..

Show Uses After implementation, you will be able to use the <product> to ……

Provide Guarantees

The <product> carries a 15-year warranty against parts and labor.

Provide Additional information

The <product> is reliable in dusty and dirty places.


Editing and Rewriting

Revise the rough draft by Adding detail for clarity Deleting dead words and phrases for

conciseness Simplifying terms for easy understanding Moving text for emphasis Reformatting for easy access Enhancing the tone Correcting errors for professionalism

1 Technical Descriptions Purpose Parts Rewriting.

Documents

Transcript of 1 Technical Descriptions Purpose Parts Rewriting.