fitting the most information in the least space: tc dojo presentation

Post on 19-Jun-2015

126 Views

Category:

Technology

0 Downloads

Preview:

Click to see full reader

DESCRIPTION

Writing instructions for products you can hold in your hand isn't the same as writing for the software industry. In many cases, you're creating paper documents to fit in small boxes, so page layouts matter. This session addresses the unique needs of writers in the manufacturing industry, but these tips also apply to writing for the web and mobile devices. In this session, you'll learn about space-saving strategies, including the following: ◦Writing concisely ◦Positioning tables and figures effectively ◦Using multilingual layouts

TRANSCRIPT

Fit the most information in the least amount of spacethe least amount of space

Andrea J. Wenger, Schneider Electricg ,

10/6/2014TC Dojo Open Session 1

My credentialsMy credentials

STC A i t• STC Associate Fellow

• 19 years at• 19 years at Schneider Electric

• Competition awardsCo pe o a a ds

10/6/2014 TC Dojo Master Session 2

OverviewOverview

W iti• Writing• Graphics• Layout

10/6/2014 TC Dojo Master Session 3

Let’s start with the basics.

Writing

10/6/2014TC Dojo Open Session 4

WritingWriting

St l• Style • Word choice• Concision

10/6/2014 TC Dojo Master Session 5

StyleStyle

S d• Second person • Imperative voice • Present tense

10/6/2014 TC Dojo Master Session 6

Word choiceWord choice

U i l dUse simple words

10/6/2014 TC Dojo Master Session 7

ExampleExample

C li t d• ComplicatedThe base plate is furnished with four mounting screwswith four mounting screws.

• SimpleThe base plate comes ithThe base plate comes withfour mounting screws.

10/6/2014 TC Dojo Master Session 8

Writing conciselyWriting concisely

U th f t d th t illUse the fewest words that will express the precise meaning.

10/6/2014 TC Dojo Master Session 9

ExampleExample

O i i lOriginalInstall the boot onto the operator by inserting the bezeloperator by inserting the bezel side of the operator into the boot openingboot opening. NOTE: Stretching the boot opening to accept the operatoropening to accept the operator will be required but will not damage the boot.g

10/6/2014 TC Dojo Master Session10

ConciseConcise

R i dRevisedStretch the boot and insert the bezel side of the operator intobezel side of the operator into the boot.

10/6/2014 TC Dojo Master Session11

WritingWriting

A picture is worth 10,000 words.

Graphics

10/6/2014TC Dojo Open Session 13

3 ways to create new graphics3 ways to create new graphics

M i l t CAD fil• Manipulate CAD files• Create from product samples• Draw from product photos

10/6/2014 TC Dojo Master Session14

Manipulate CAD filesManipulate CAD files

Line art from CAD filesLine art from CAD files

Create from samplesCreate from samples

Line art from product sampleLine art from product sample

Draw from product photosDraw from product photos

Line art from photosLine art from photos

GraphicsGraphics

Because people still use paper instructions.

Page layout

10/6/2014TC Dojo Open Session 22

Multilingual layoutsMultilingual layouts

T t• Text• Tables• Figures• Legendsg• Scrunching

10/6/2014 TC Dojo Master Session23

Multilingual layoutOpening with a figure instead of text

Multilingual layoutSafety message

Multilingual layoutProcedure, graphic, and legend

Multilingual layoutLarge graphic, and legend

Multilingual layoutNote text around the graphic

Multilingual layoutGraphic enlargement

Multilingual layoutProcedure with graphics

LabelsLabels

Page LayoutPage Layout

ConclusionConclusion

Questions?

Contact me at awengerstc@yahoo.comg y

top related