60
TECHNICAL DESCRIPTIONS Introduction to

Introduction to techincal descriptions

Embed Size (px)

Citation preview

TECHNICAL DESCRIPTIONS

Introduction to

OBJECTIVES

OBJECTIVESIdentify the purpose of technical descriptions

OBJECTIVESRecognize the two main

types of description

OBJECTIVESIdentify the elements of

a good technical description

OBJECTIVESIdentify ways of being

objective

TECHNICAL DESCRIPTION

a detailed discussion of the physical aspects of an

object or process

TECHNICAL DESCRIPTION

Like a technical definition, a technical

description tells us what something is

A description gives additional information to help the reader visualize what’s being described

J?

J?

shape size

colormaterial

function operation

1

OF TECHNICAL DESCRIPTION

TWO TYPES

Product Process

KKk

Product Process

KKkDescribes what the object is like

Product Process

KKkDescribes what the object is like

for people who want to use the product

Product Process

KKk

Product Process

KKkDescribes how something works

Product Process

KKkDescribes how something works

for people who want to know how

2KEY

ELEMENTSOF A GOOD TECHNICAL DESCRIPTION

No matter which kind of definition you’re writing, there are some key elements you’ll need

to include.

CLEAR AND LIMITING TITLE

CLEAR AND LIMITING TITLE

The title should promise exactly what the description will deliver.

“BMW: Safety First”

“BMW: Safety First”

“How the Anti-Lock Braking System on the BMW X5 Works”

APPROPRIATE LEVEL OF

DETAIL

APPROPRIATE LEVEL OF

DETAIL

Give enough detail to convey a clear picture but don’t burden

the reader with unnecessary information.

know who your audience is and their purpose for reading

the description

high detail

low detail

EFFECTIVE VISUALS

EFFECTIVE VISUALS

Use drawings, diagrams and photographs with captions to help users understand what

they are looking at.

avoid verbal and visual clutter

APPROPRIATE SEQUENCE

APPROPRIATE SEQUENCE

Present the information in an order that helps the reader

process it

spatialy

based on where the parts of an

object are located

functionalFreflects the

order in which the parts function

chronologicalHshows the

time at which things happen

spatialy

based on where the parts of an

object are located

functionalFreflects the

order in which the parts function

chronologicalHshows the

time at which things happen

spatialy

based on where the parts of an

object are located

functionalFreflects the

order in which the parts function

chronologicalHshows the

time at which things happen

part of most physical descriptions

spatialy

based on where the parts of an

object are located

functionalFreflects the

order in which the parts function

chronologicalHshows the

time at which things happen

part of most physical descriptions

used when you want the reader to visualize a static object

1

2 3 4

5

spatialy

based on where the parts of an

object are located

functionalFreflects the

order in which the parts function

chronologicalHshows the

time at which things happen

spatialy

based on where the parts of an

object are located

functionalFreflects the

order in which the parts function

chronologicalHshows the

time at which things happen

used to describe a process or procedure

1

2 3 4

5

spatialy

based on where the parts of an

object are located

functionalFreflects the

order in which the parts function

chronologicalHshows the

time at which things happen

spatialy

based on where the parts of an

object are located

functionalFreflects the

order in which the parts function

chronologicalHshows the

time at which things happen

reflects the order in which the parts function

spatialy

based on where the parts of an

object are located

functionalFreflects the

order in which the parts function

chronologicalHshows the

time at which things happen

reflects the order in which the parts function

used to describe a device or mechanism in use

1

3

45

2

3

WHEN WRITING TECHNICAL DESCRIPTIONS

BEING OBJECTIVE

USE PHOTOGRAPHIC

LANGUAGE

USE PHOTOGRAPHIC

LANGUAGE

help the reader visualize the item being described

only describe things you would see in a photograph

BE PRECISEBE PRECISE

Use high information words that enable readers to picture

the item

use exact measurements

specify locations

Q

use words like ‘above’, ‘behind’,

‘adjacent’ and ‘parallel’

use correct names

avoid using terms like ‘thing’

k !

“The volume controls are conveniently placed.”

“The volume controls are conveniently placed.”

“The volume controls are located on the left side of the handset,28 mm from the top, parallel with the ‘silent’ switch.”

SUMMARYSUMMARY