Technical Writing - Product Descriptions

46
PRODUCT DESCRIPTIONS

Transcript of Technical Writing - Product Descriptions

PRODUCT DESCRIPTIONS

OBJECTIVESBy the end of the lesson, you should be able to:

Recognize the correct organization of a product description

Select appropriate visuals to illustrate a product description

Identify effective ways to highlight important information

ORGANIZATION

TITLE

INTRODUCTION

MAJOR PARTS

OPERATION

CONCLUSION

TITLE

Start with a clear title that precisely states the topic.

Technical Description - Apple Watch

INTRODUCTION

DEFINTION

FUNCTION

INTENDED AUDIENCE

GENERAL DESCRIPTION

MAJOR PARTS

DEFINTION

FUNCTION

INTENDED AUDIENCE

GENERAL DESCRIPTION

MAJOR PARTS

Start with a definition of the product/mechanism being described so the audience knows exactly what’s being discussed.

Provide a brief description of the function and capabilities of the item.

DEFINTION

FUNCTION

INTENDED AUDIENCE

GENERAL DESCRIPTION

MAJOR PARTS

Explain the intended audience and the purpose of the description

DEFINTION

FUNCTION

INTENDED AUDIENCE

GENERAL DESCRIPTION

MAJOR PARTS

Provide a short overall description of the product including: overall size and shape main materials

DEFINTION

FUNCTION

INTENDED AUDIENCE

GENERAL DESCRIPTION

MAJOR PARTS

Provide a list of the major parts that will be described in the main body of the description

DEFINTION

FUNCTION

INTENDED AUDIENCE

GENERAL DESCRIPTION

MAJOR PARTS

The Apple Watch is a smart watch that displays the time and date, runs specially designed applications and allows the user to access SMSs, instant messages and emails. The Apple Watch connects to an iPhone and displays data and messages stored on the phone.

This description is intended to describe to the end user the structure and operating principle of the Apple Watch.

General Description

The main body of the Apple Watch is an aluminum square with rounded corners and edges. There is a two piece rubber strap that is connected to the main body at the top and bottom. The bottom strap contains a series of holes and the upper strap contains a metal stud which is used to connect the two pieces together.

When laid flat, the overall dimensions of the Apple Watch are:

Length: 42mm Width: 285 mm

The major components of the Apple watch are: 1. Main Body 2. Touch Display 3. Crown 4. Strap 5. Fastening Stud

DEFINITION

FUNCTION

AUDIENCE

GENERAL DESCRIPTION

MAJOR COMPONENTS

DESCRIPTION OF MAJOR PARTS

HEADING

DEFINITION

APPEARENCE

MATERIALS

RELATIONSHIP WITH OTHER PARTS

HEADING

DEFINITION

APPEARENCE

MATERIALS

RELATIONSHIP WITH OTHER PARTS

Start with the name of the part being described.

HEADING

DEFINITION

APPEARENCE

MATERIALS

RELATIONSHIP WITH OTHER PARTS

Define the part by stating the function it performs.

HEADING

DEFINITION

APPEARENCE

MATERIALS

RELATIONSHIP WITH OTHER PARTS

Describe the shape, color etc. of the part and give its dimensions.

HEADING

DEFINITION

APPEARENCE

MATERIALS

RELATIONSHIP WITH OTHER PARTS

Say what the part is made of.

HEADING

DEFINITION

APPEARENCE

MATERIALS

RELATIONSHIP WITH OTHER PARTS

Say how the part is connected to other parts and how its function interacts theirs.

Use the spatial or functional sequence.

WORD USAGEActive verbs functions, appearance and location Passive verbs materials

Strap

The strap is the component that holds the watch to the user’s wrist. There are two parts to the strap; the upper strap and the lower strap.

The upper strap is 37mm wide at end which connects to the main body and tapers to a width of 32mm. The opposite end of the strap semicircular. The upper strap is 126mm in length and the thickness is 3.5mm. The upper strap contains a series of five notches (holes) for the fastening stud to be placed through to allow the strap to fit different size wrists. The notches are positioned equidistant between the two edges and run from 12mm in from the rounded edge to approximately mid-way along the strap. The upper strap is black and made from vulcanized rubber.

The lower strap is the strap that contains the fastening stud and allows for the strap to be fastened to the user’s wrist. The lower strap is 199 mm in length with a width of 37mm at the main body end and 32 mm at the opposite end which is also semicircular. The width expands to 44 mm halfway down the strap. This wider section contains an opening (hole) through which the end of the upper strap is placed when the watch is fastened to the wrist. The hole is that is 38mm wide and 7mm high. There is a second opening 6mm from the semicircular end of the strap which hold the fastening stud. The upper strap is black and made from vulcanized rubber.

DEFINITION

HEADING

APPEARENCE

MATERIALS

RELATIONSHIP WITH OTHER PARTS

OPERATION

Give a step-by-step description of how to use the mechanism.

Use the passive voice.

Use the chronological sequence.

Fastening

First, the main body of the watch is placed on the back of the wrist. Second, the two semicircular ends of the strap are wrapped around the wrist to meat at the pulse point. Thirdly, the end of the lower strap is pulled until the desired wrist size is reached. Fourth, the fastening stud is put through the corresponding notch. Fifth, the end of the lower strap is placed through the large opening in the upper strap.

Steps

passive verbs

CONCLUSION

REVIEW

ADDITIONAL INFORMATION

OUTSIDE SOURCES

REVIEW

ADDITIONAL INFORMATION

OUTSIDE SOURCES

Briefly review the major parts and the cycle of operation.

REVIEW

ADDITIONAL INFORMATION

OUTSIDE SOURCES

Give the reader some new information about the mechanism e.g. price and availability.

REVIEW

ADDITIONAL INFORMATION

OUTSIDE SOURCESTell the reader where they can find out more about the product.

Conclusion

The five components of the Apple Watch combine to give the user a light, comfortable device that allows them to see the time and date, access information from applications and receive emails, SMSs and instant messages sent to their iPhone. The crown of the watch allows the user to scroll through information and adjust the size to make the information easily readable. The multiple notches on the strap allow the strap to be adjusted to fit wrists of varying sizes.

The Apple Watch is available from all Apple Stores and licensed Apple Retailers with prices starting at $469.

For more information, visit www.apple.com/watch.

review

additional information

OUTSIDE SOURCES

VISUALS

Use simple, clearly-labeled visuals photos or diagrams to help the reader understand.

strap crown

display

? ?

?

HIGHLIGHTING

underlineItalicscolor

bold

combination(bold and color)

Pick one style. Be consistent.

SUMMARY

Organize the information properly

Use clear, well-labelled visuals

Highlight consistently

END OF LESSON