descriptions in technical writing

DESCRIPTIONS in Technical Writing

• How does X work?• What does it look like?• What is it made of?• How has it been put together?• What does it do?

Questions that govern the act of description:

Descriptions provide information that allows people to successfully do their jobs, make appropriate purchases, or accomplish other sorts of tasks.

• Background (depending on placement)• Features• Physical attributes (shape, size, texture, color,

position, material)• Functions• Characteristics (qualities)• Visuals

Information Typically Included in Technical Descriptions

Difference between Definition and Description in Technical Writing

Definition DescriptionTypical individuals are 8 to 10 cm (3 to 4 in) long and weigh 30 to 35 grams (1.1 to 1.2 oz). Queens are larger and may weigh well over 50 grams (1.8 oz), the largest reaching 80 grams (2.8 oz). They are well-adapted to their underground existence. Their eyes are quite small, and their visual acuity is poor. Their legs are thin and short; however, they are highly adept at moving underground and can move backward as fast as they can move forward. Their large, protruding teeth are used to dig and their lips are sealed just behind the teeth, preventing soil from filling their mouths while digging. About a quarter of their musculature is used in the closing of their jaws while they dig - about the same proportion as found in the human leg.[5] They have little hair (hence the common name) and wrinkled pink or yellowish skin. They lack an insulating layer in the skin.Its karyotype has 2n = 60.[2]

Written Components of Technical Descriptions

Introduction

Background (depending on context)

Parts, Characteristics, or Steps

Visuals

Introduction

• Name the object/process, • Identify what audience needs to know about

background (and why), • Give short description of object/process (what

is it? or how does it happen? • Provide forecasting statement about what’s in

your developed description.

Background

• Explains why this description will be useful to the audience (what, exactly, will it enable them to understand or do?).• Provides information and/or definitions that

the audience needs to know in order to understand the description.

Parts, Characteristics, and Steps

• Parts are the physical components of the thing.• Characteristics are describable aspects of the

thing, but not parts (length, width, material, etc.)• Steps are the parts of a process (explain how the

thing is used, or how it’s created, e.g.).

Visuals

• Graphics, illustrations, photographs, tables, charts, etc., that support your written description.• Make sure they’re appropriate for the audience

and purpose of your description.