Comm.

1009: Week 4
Technical Descriptions

Week 4 Components of Technical

Descriptions

Expanded definition/ clarifier review

What, where, why?
Classifying and partitioning
Writing a technical description

Types and elements of Process

Descriptions

EXPANDED DEFINITIONS (Review)

A brief form of technical description
Formal definition plus 3 or more clarifiers
analogy
etymology
principal of operation
illustration
Etc. (See Ch. 5 in course text)

Analogy
Compares the unfamiliar to the familiar to identify
major characteristics.
Examples:

A civet cat is a raccoon-like omnivorous

mammal of Mexico and the
southwestern United States having a
long bushy tail with black and white
rings.
A kumquat is a citrus fruit about the size
and shape of a pecan.
4

Etymology
The linguistic origin of the word may help
clarify its definition.
Example:
The term, solenoid is derived from the
Greek word, solenoeides, which means
channel or shaped like a pipe.

Illustration
Drawings, photographs or diagrams
Introduced by an identifying sentence before
Discussed after their use
Descriptive labels
and captions
Positioned carefully
1977 BMW R100 RS:
the worlds first full
fairing production
motorcycle.

Choose the right illustrations

Visual overviews:

photographs, realistic drawings, maps

Interior components:

show how parts fit together

Phantom views, schematics, cross-section
maps

Individual parts in relation to the whole:

exploded views, cutaway views.

To support easy and quick

comprehension

13 Types of Data Illustrations

1.
2.
3.
4.
5.

Tables
Bar charts/graphs
Pictographs
Line charts/graphs
Pie charts

13 Types of Graphics
6. Photographs
7. Drawings/Illustrations
8. Screen shots

10

13 Types of Graphics
Diagrams can be very effective for instructions

11

13 Types of Graphics
Use the PFDs and P & IDs to explain a process or
system
9.Flow charts
10.Diagrams

12

TECHNICAL DESCRIPTIONS
Any info product that describes something
with a mechanical or scientific focus.
Explains an item or topic to someone who
wants to understand, buy, use, operate, or
assemble it.
Can include specifications, graphics with words
and/or diagrams, prose (text in paragraphs) or
bullet point details.
Design according to audience and purpose.
13

Where are technical

descriptions used?
Observation notes
Reference manuals and training materials
Proposals and reports
Marketing and promotional pieces
Public information and education.

14

Why do we use technical

descriptions?
To show how something is put together and
why it works.
More specifically:

What is it? What does it do?

What is its purpose and importance?
What are its characteristics?
What are its parts?
How do the parts fit together and work
together?

15

Using partition and

classification
When describing a single item, partition it into its
component parts.
When describing a collection of items, classify them
into smaller groups.
In technical descriptions, we use both techniques
and delineating the boundaries can be difficult and
even *arbitrary.

16

Effective Classifications
Inclusive Every item has a place, all
items belonging to group are included
Exclusive Every item has only one
place, items not belonging to group are
excluded
Informative Groupings are useful to
readers.

17

Effective Partitions
Inclusive every part is included
Exclusive parts that do not belong to
the product or mechanism being
partitioned are excluded
Informative groupings useful to
readers.

18

Considering Purpose
If purpose is descriptive:

Focus on structural components physical

aspects of the device, without regard to
purpose.
If purpose is to explain or discuss:

Focus on functional components perform

clearly defined tasks in the operation of the
device.
19

Using the clearest descriptive

sequence
Spatial sequence The way it appears
as a static object
Functional sequence The way its
parts operate in order
Chronological sequence The way its
parts are assembled.

20

Other Elements
Distinguish between major and minor parts

Major parts are large and essential

Minor or sub-parts offer detail on minor
parts
Use precise diction so that information is
verifiable
Use illustrations where useful:
Visual overviews in Introduction
Component views in Body.
21