36
TECHNICAL WRITING November 16 th , 2012

TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

Embed Size (px)

Citation preview

Page 1: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

TECHNICAL WRITINGNovember 16th , 2012

Page 2: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

Today• Effective visuals.

• Work on Assignment 6

Page 3: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6
Page 4: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6
Page 5: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

Effective visuals• We have talked about format:

• Again

• And again

• And again…

This class is just a reminder to always maintain a clear, easy-to-follow layout for your documents.

Page 6: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

Effective design

If a document looks like this:

- The readers will think that this work is too complex and they won’t read it.

- A visually appealing document helps your company’s reputation and your own.

Page 7: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

3 Rules to Effective Design

1.Keep it simple. - Don’t try to impress your reader with visual effects.

2.Make it clear. -Include heads, bulleted lists, numbered steps, etc. to make your message easy to understand.

3.Have it flow. - Help your readers get through and understand your document easily.

Page 8: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

A Few Tips

Don’t be afraid of white space.

- Double-spacing between paragraphs.

- Spacing between headings and paragraphs.

- Providing adequate space around visuals.

Page 9: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

A Few Tips

Don’t be afraid of white space. - Double-spacing between paragraphs. - Spacing between headings and paragraphs. - Providing adequate space around visuals.

Page 10: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

A Few Tips

Change font size for certain functions.

Title (22 point)

Headings (14 point)

Content/paragraphs (12 point)

Footnotes/endnotes (8 point)

Page 11: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

A Few Tips

Headings and subheadings: parallel.

Page 12: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

A Few Tips

Color.

Color in documents can be used for:

- Borders

- Headings

- Keywords

- Internet addresses

- Graphic accents (backgrounds or graphics)

- Info boxes

Page 13: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

A Few Tips

Color

IF you use color:

- Make sure colors contrast with the background.

- No more than 2 - 3 colors on a page.

- Use “cool” colors.

Page 14: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6
Page 15: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6
Page 16: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6
Page 17: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6
Page 18: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

Visuals

- Pictures, diagrams, figures (tables and charts)

IMPORTANT:

Visuals work in conjunction with your writing to inform, illustrate, and persuade.

Page 19: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

Visuals

Reasons to use visuals:

1.Visuals arouse readers’ immediate interest.

2.Visuals increase readers’ understanding by simplifying concepts.

3.Visuals are especially important for non-native speakers of English

and multicultural audiences.

4.Visuals emphasize key relationships.

5.Visuals condense and summarize a large quantity of information into

a relatively small space.

6.Visuals are highly persuasive.

Page 20: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

Visuals

The most important function of visuals is to help the reader understand your work.

Page 21: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

Choosing Effective Visuals

1. Include visuals only when they are relevant for your purpose and audience.

- Visuals are not decorations.

i.e., a report workplace safety does not need a picture of a doctor.

Page 22: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

Choosing Effective Visuals

2. Use visuals in conjunction with – not as a substitute for – written work.

- Visuals are not substitutes for words.

- You may need to explain the info in visuals.

Page 23: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

Choosing Effective Visuals

3. Experiment with several visuals

- Use the visual that best represents your information.

or

Page 24: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

Choosing Effective Visuals

4. Always use easy-to-read and relevant visuals

- If the reader can’t understand the visual, it’s useless.

0

0.2

0.4

0.6

0.8

1

1.2

1 3 5 7 9 11 13 15 17 19 21 23 25 27 29 31 33 35 37 39 41

Series1

Series2

Series3

Series4

Series5

Page 25: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

Choosing Effective Visuals

5. Consider how your visuals will look on the page.

- Make sure it fits the page.- Make sure it’s readable.

Page 26: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

Choosing Effective Visuals

6. Be prepared to revise and edit your visuals.

- May have to change size, labels, colors, etc.

Page 27: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

Inserting Visuals into Documents

1. Insert your visuals appropriately.

- Never insert a visual before a discussion of it.

- (Try to) place visuals close to where they are mentioned.

- Size visuals appropriately.

Page 28: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

Inserting Visuals into Documents

2. Always mention in the text that you are including a visual.

- Tell the readers where it can be found and refer to it.

Page 29: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

Inserting Visuals into Documents2. Always mention in the text that you are including a visual.

i.e., “the figure below illustrates the Q1 profits of 2007.”

“the figure on the following page shows recent consumer trends.”

“the diagram to the right demonstrates the part of a 6-cylinder

engine.”

“the table on the bottom of page 3 summarizes the costs associated

with the change”

Page 30: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

Inserting Visuals into Documents

3. Center the visual.

- If necessary, also “box” the visual.

Page 31: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

Inserting Visuals into Documents

4. Never collect all visuals and put them in an appendix.

Appendix = section after the main document.

- Visuals are meant to help here and now.

- If reader has to go to the appendix to look at the visual, he/she will get frustrated.

Page 32: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

Visuals

Two types:

Tables: arrange information – numbers and/or words – in parallel columns or rows for easy comparison of data.

Figures: include graphs, circle charts, bar charts, organizational chars, flow charts, pictographs, maps, photographs, and drawings.

Page 33: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6
Page 34: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6
Page 35: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

Assignment 6Write an internal proposal, recommending Keimyung University to:

a) Hire more faculty, student workers, or office help.

b) Increase the number of online classes in your major.

c) Open a new, health conscious cafeteria on campus.

d) Purchase new classroom equipment or software.

e) Train employers about discrimination (i.e., race, age, sex, culture, looks, etc.)

Page 36: TECHNICAL WRITING November 16 th, 2012. Today Effective visuals. Work on Assignment 6

Assignment 6

With a partner:

- Choose a topic.

- Brainstorm information together.

- Create research results together.

Write SEPARATE proposals.