33
Why Technical Writers Shouldn’t Be “Writers.” Alan J. Porter

Why Technical Writers Shouldn't be "Writers"

Embed Size (px)

DESCRIPTION

Technical writers love the written word. Perhaps, we love it a little too much? We need to ask ourselves is the written word the best thing for documentation? Is it the best thing for us as an industry, and is it the best thing for you as a content developer.This presentation takes a look at why we are so focused on the written word, and present a few ideas about better ways for us to deliver our message to the end user in a way that increases customer satisfaction.What can we as documentation professionals learn from just observing the world around us, and how people communicate. What is the impact of new Web2.0 technology and social networks, and how they will change the way we need to view documentation design, distribution and usage.

Citation preview

Page 1: Why Technical Writers Shouldn't be "Writers"

Why Technical Writers Shouldn’t Be “Writers.”

Alan J. Porter

Page 2: Why Technical Writers Shouldn't be "Writers"

I’m A Writer • 20 + Years in Tech Pubs.• Magazine articles in over twenty different

publications.• Write for 8 different blogs.• Written three non-fiction books .. Two more on

the way.• Contributed to seven more.• Have a couple of novels being shopped.• Written screenplays.• And I write comics too.

Page 3: Why Technical Writers Shouldn't be "Writers"

I’m A Writer

Page 4: Why Technical Writers Shouldn't be "Writers"

How depressing! I was hired as a “tech writer.”

I came across a study on learning using a 94-page manual versus using 25 flash cards. It turns out that people learned more quickly with the flash cards covering key ideas and hints, and not step-by-step instruction. It turns out that users only want a pile of screen shots! I have to rethink all of this before I tackle this next documentation project.

Page 5: Why Technical Writers Shouldn't be "Writers"

Say What…???Main landing gear strutThe main gear strut consists of a main fitting and a sliding

member. The main fitting pivots from the main gear bracket, located in the main gear strut bays between the rear and false spars of each wing. Torque links fitted to the main fitting and sliding member permit shock absorbing movement of the strut while maintaining true alignment of the main wheels. The side stay assembly consists of two main members and two folding toggles hinged together and so attached between the gear strut and the side stay bracket as to provide….

Page 6: Why Technical Writers Shouldn't be "Writers"

It’s Not About

YOU.

Page 7: Why Technical Writers Shouldn't be "Writers"

Think about language from the Customer’s perspective.

• Turn the switch on.

• Power the device up.

• Press the ON switch.

Page 8: Why Technical Writers Shouldn't be "Writers"

It’s Not About “What”

It’s About

“How”

Page 9: Why Technical Writers Shouldn't be "Writers"

DA-PAM 750-30

Page 10: Why Technical Writers Shouldn't be "Writers"
Page 11: Why Technical Writers Shouldn't be "Writers"
Page 12: Why Technical Writers Shouldn't be "Writers"
Page 13: Why Technical Writers Shouldn't be "Writers"
Page 15: Why Technical Writers Shouldn't be "Writers"
Page 16: Why Technical Writers Shouldn't be "Writers"
Page 17: Why Technical Writers Shouldn't be "Writers"
Page 18: Why Technical Writers Shouldn't be "Writers"
Page 19: Why Technical Writers Shouldn't be "Writers"
Page 20: Why Technical Writers Shouldn't be "Writers"
Page 21: Why Technical Writers Shouldn't be "Writers"
Page 22: Why Technical Writers Shouldn't be "Writers"

Who Is This Guy?

Page 23: Why Technical Writers Shouldn't be "Writers"

Who Is This Guy?

Page 24: Why Technical Writers Shouldn't be "Writers"

What Should We Be?

• User Advocates

• Directors

• Designers

• Story Tellers

• And above all…

Page 25: Why Technical Writers Shouldn't be "Writers"
Page 26: Why Technical Writers Shouldn't be "Writers"

Putting The Ideas Into Practice

Page 27: Why Technical Writers Shouldn't be "Writers"

Putting The Ideas Into Practice

“I saw a graphic novel at (a conference) that described a non-profit walk-in computer lab and it was so easy to read and understand. I was amazed at how well the concepts within it stuck with me. “Anne Gentle – email – 3/13/09

Page 28: Why Technical Writers Shouldn't be "Writers"
Page 29: Why Technical Writers Shouldn't be "Writers"
Page 30: Why Technical Writers Shouldn't be "Writers"
Page 31: Why Technical Writers Shouldn't be "Writers"

Try the following..

Page 32: Why Technical Writers Shouldn't be "Writers"

Read These Books!!