Writing Technical Descriptions
36
TECHNICAL DESCRIPTIONS Introduction
Transcript of Writing Technical Descriptions
TECHNICAL DESCRIPTIONS
Introduction
OBJECTIVESBy the end of this lesson, you should be able to:
Identify the purpose of technical descriptions
Recognize the two main types of description
Identify the elements of a good technical description
Identify ways of being objective
WHAT ARE TECHNICAL DESCRIPTIONS?
Like definitions, descriptions answer the question ‘what is it?’ but give additional information to help readers visualize what’s being described.
shape materials
function operation?size
MAIN TYPES OF DESCRIPTION2
PRODUCT DESCRIPTIONDescribes what the item is like.
For people who want to use…
PROCESS DESCRIPTIONDescribes how something works.
For people who want to know how…
Elements of a GOOD DESCRIPTION
TITLEClear and limiting
The title should promise exactly what the description will deliver.
How BMW’s Ant i -Lock Braking System Works.
BMW- Safety First!
l l
DETAILAppropriate level of
Give enough detail to convey a clear picture but don’t burden the reader with unnecessary information.
You need to identify: • your audience • their reason for using the description
low detail
high detail
VISUALSIllustrative
U s e d r a w i n g s , d i a g r a m s a n d photographs with captions and labels that help users understand what they are looking at.
Avoid verbal and visual clutter.
SEQUENCEAppropriate and Clear
SPATIALwhat it looks like
• Used when we want readers to visualize a static item.
• A part of all physical descriptions.
1.
2.
4.
5.3.
FUNCTIONALhow it works
3.
2.4.
1.
• Used in describing a mechanism/device in action.
• Reflects the order in which the parts function.
CHRONOLOGICALthe time at which things happen
1.
3.
2.
4.
5.
• Used to describe a process • Also used to describe an item when it needs to be
visualized in the order in which its parts are assembled.
OBJECTIVITEHow to be
USE PHOTOGRAPHIC
LANGUAGE
help the reader visualize the item being described
BE PRECISE
Use high information words that enable readers to picture the item.
•use exact measurements.
•specify locations and positions with words like ‘above’, ‘behind’ and ‘adjacent’, ‘horizontal’ and ‘parallel’
•Use correct names
The volume controls are conveniently placed.
The two volume controls are located on the left hand side of the handset approximately 28 mm from the top. The two buttons are horizontally aligned, parallel with the ‘silent’ switch.
l l
SUMMARYthe purpose of technical descriptions
two types of technical description; product and process
elements of a good description
how to be objective
END OF LESSON
