gerson: technical communication, 6e© 2009 pearson education, upper saddle river, nj 07458. all...

34
Gerson: Technical Communication, 6e © 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and Product 6 th Edition Steven M. Gerson Sharon J. Gerson

Upload: christopher-riley

Post on 01-Jan-2016

217 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

1

Technical Communication: Process and Product

6th Edition

Steven M. Gerson

Sharon J. Gerson

Page 2: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

2

Graphics

This chapter discusses the following:

• Objectives• Color• Three-Dimensional

Graphics• Criteria for Effective

Graphics• Types of Graphics

Page 3: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

3

Objectives

Wall-to-wall text is neither clear nor concise. Effective technical communication includes graphics, which provide the following benefits:

Page 4: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

4

Objectives (cont.)

• Conciseness—visual aids can convey large amounts of information in less space.

Page 5: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

5

Objectives (cont.)

• Clarity—visual aids can clarify complex information by showing

– Trends

– Comparisons

0

10

20

30

40

50

60

70

80

90

1st Qtr 2nd Qtr 3rd Qtr 4th Qtr

EastWestNorth

0102030405060708090

100

1st Qtr 2nd Qtr 3rd Qtr 4th Qtr

East

West

North

Page 6: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

6

Objectives (cont.)

• Clarity—visual aids can clarify complex information by showing

– Percentages

– Facts and figures

13%

17%

57%

13%1st Qtr2nd Qtr3rd Qtr4th Qtr

1st Q 2nd Q 3rd Q

1600 1360 2145

2311 6743 2456

Page 7: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

7

Objectives (cont.)

• Cosmetic Appeal—visual aids add interest to documentation.

Page 8: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

8

Color

Color adds interest to visual aids. However, use color with caution. Color can cause problems:

• Harsh colors can be distracting.

0

10

20

30

40

50

60

70

80

90

1st Qtr 2nd Qtr 3rd Qtr 4th Qtr

EastWestNorth

Page 9: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

9

Color (cont.)

• Colors can go out of style.

• Color can increase production cost.

• Color consumes disk space.

• Color can cause problems for people with visual impairments.

Page 10: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

10

Three-dimensional Graphics

Three-dimensional graphics add interest to visual aids. However, use 3-D with caution. 3-D can cause problems:

• Unclear data

0102030405060708090

100

1st Qtr 2nd Qtr 3rd Qtr 4th Qtr

EastWestNorth

1stQtr

2ndQtr

3rdQtr

4thQtr

East

North0

20

40

60

80

100

EastWestNorth

Exact plot points

Inexact plot points

Page 11: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

11

Criteria for Effective Graphics

Effective graphics are:

• Integrated with the text

• Appropriately located

• Add to the text

• Communicate important information

• Do not detract

Page 12: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

12

Criteria for Effective Graphics (cont.)

• Are sized effectively

• Are readable

• Are correctly labeled

• Are consistent in style with other graphics

• Are well conceived and executed

Page 13: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

13

Types of Graphics

Graphics include:

• Tables

• Figures

Page 14: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

14

Tables

Tables have these benefits:

• Conciseness—avoid needless repetition of words

• Clarity—provide easy-to-see comparisons/contrasts

• Easy reference

Page 15: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

15

Tables (cont.)—Criteria

To create effective tables: • Number them in order of presentation

(Table 1, Table 2, etc.).• Title all table (Table 1: Comparison of

Annual Wages).• Place tables soon after mention in text.• Do not insert table before mention in

text.

Page 16: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

16

Tables (cont.)—Criteria

• Use introductory lead-ins to tables.

• Provide follow-up explanations to tables, explaining the significance.

• Provide headings for all columns.

• Abbreviate terms to size columns appropriately.

• Do not crowd tables on a page.

Page 17: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

17

Tables (cont.)—Criteria

• Separate columns with ample white space for easy readability.

• Show omissions with ellipses ( . . .) or hyphens/dashes ( - - - )

• Use numbers consistently (either ½ or .5)

• Write “cont.” if a table spans more than one page.

Page 18: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

18

Tables (cont.)—Criteria

Table 9.1 Student Headcount, 2008

Age Group New Students Continuing Students

18-20 1.400 900

21-23 330 602

24-26 263 496

Total 3,393 1,998

Page 19: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

19

Figures

• Bar charts• Pie charts• Line charts• Combination charts• Flowcharts• Organizational charts• Schematics

• Geologic maps• Line drawings• Renderings• CAD drawings• Photographs• Icons• Downloadable clip art

There are many different types of figures:

Page 20: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

20

Figures (cont.)—Criteria

To create effective figures, • Number the figures in order of presentation

(Fig. 1, Fig. 2, etc.).• Title each figure (Fig. 1: Percentages of

Work Performed).• Preface each figure with an introductory lead-

in.• Do not use a figure until mentioned in the

text.

Page 21: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

21

Figures (cont.)—Criteria

• Present the figure soon as mentioning.

• Explain the figure’s importance.

• Label the figure’s components (x- and y-axes, for example).

• Provide a legend when necessary.

• Define any abbreviations.

Page 22: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

22

Figures (cont.)—Criteria

• Cite sources of information as needed.

• Do not crowd figures on a page.

• Size the figures appropriately for readability.

Page 23: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

23

Types of Figures

• Bar charts

0

10

20

30

40

50

60

70

80

90

1st Qtr 2nd Qtr 3rd Qtr 4th Qtr

EastWestNorth

Page 24: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

24

Types of Figures (cont.)

• Pie Charts

1st Qtr 2nd Qtr 3rd Qtr 4th Qtr

Page 25: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

25

Types of Figures (cont.)

• Line Charts

0

20

40

60

80

100

1st Qtr 2nd Qtr 3rd Qtr 4th Qtr

East

West

North

EastWestNorth

Page 26: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

26

Types of Figures (cont.)

• Combination Charts

0

20

40

60

80

100

EastWestNorth

East 20.4 27.4 90 20.4

West 30.6 38.6 34.6 31.6

North 45.9 46.9 45 43.9

1st Qtr 2nd Qtr 3rd Qtr 4th Qtr

Page 27: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

27

Types of Figures (cont.)

• Flowcharts

Page 28: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

28

Types of Figures (cont.)

• Organizational Charts

President

CFO FFO CEO

Page 29: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

29

Types of Figures (cont.)

• Schematics• Geologic maps• Line drawings• Renderings• CAD drawings• Virtual Reality

Page 30: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

30

Types of Figures (cont.)

• Line Drawings

Air Bag

Page 31: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

31

Types of Figures (cont.)

• Photographs

Page 32: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

32

Types of Figures (cont.)

• Icons

Page 33: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

33

Types of Figures (cont.)

• Internet Downloadable Clip Art– The Internet (sites like “Google”) offer

millions of downloadable clip art.

NOTE:Be careful when using downloadable clip art.Abide by copyright laws.

Modify the graphics Give credit to the artists (source citations) Get permission before use

NOTE:Be careful when using downloadable clip art.Abide by copyright laws.

Modify the graphics Give credit to the artists (source citations) Get permission before use

Page 34: Gerson: Technical Communication, 6e© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved. 1 Technical Communication: Process and

Gerson: Technical Communication, 6e

© 2009 Pearson Education, Upper Saddle River, NJ 07458. All Rights Reserved.

34

Practice

• Use the end-of-chapter activities to practice graphics.