Lightening your Content

20
Light(e)ning Talk Larry Kunz Systems Documentation Inc. STC Summit – May 2012 @larry_kunz

description

Light(e)ning talk from STC Summit 2012: Taking the flab out of your content

Transcript of Lightening your Content

Page 1: Lightening your Content

Light(e)ningTalkLarry Kunz

Systems Documentation Inc.

STC Summit – May 2012@larry_kunz

Page 2: Lightening your Content

May 2012@larry_kunz

Flabby Content

Page 3: Lightening your Content

Flabby Content

May 2012@larry_kunz

Is harder to keep current.

• There’s more content to update.• The content is harder to find.

Page 4: Lightening your Content

Flabby Content

May 2012@larry_kunz

Costs more to translate.•More words•More inconsistency

Page 5: Lightening your Content

Flabby Content

May 2012@larry_kunz

Forces your reader towork harder.• Jargon• Sesquipedalianism Big words• Convoluted structure• Weak verbs

Page 6: Lightening your Content

Writing forGeorge Jetson

May 2012@larry_kunz

Page 7: Lightening your Content

Writing forGeorge Jetson

May 2012@larry_kunz

Activating the red button initiates the process that invokes the Pizza Making feature.

Page 8: Lightening your Content

Writing forGeorge Jetson

May 2012@larry_kunz

Press the red button to get a pizza.

Page 9: Lightening your Content

Lightening Your Content

May 2012@larry_kunz

How can you trimyour flabby content?

(You already know the answer)

•A sensible diet•Healthy exercise

Page 10: Lightening your Content

Tips for a Sensible Diet

May 2012@larry_kunz

I made this very long, because I did not have the leisure to make it shorter.

- Blaise Pascal

Make time to write less.

Page 11: Lightening your Content

Tips for a Sensible Diet

May 2012@larry_kunz

Eliminate content that no one reads.

• Use web analytics.• Lop off the deadwood.

Page 12: Lightening your Content

Tips for a Sensible Diet

May 2012@larry_kunz

Eliminate transitionalor “glue” material:

• In the next chapter we will see…• The following sections will tell you…• As you read previously…

Page 13: Lightening your Content

Tips for a Sensible Diet

May 2012@larry_kunz

Endeavor to eliminate composition that is excessively sesquipedalian, bombastic, or circumlocutory.

• Simpler words• Simpler sentence structure

Page 14: Lightening your Content

Tips for a Sensible Diet

May 2012@larry_kunz

a number of = somea majority of = most

due to the fact that = becausetake into consideration = consider

Thanks to Gurpreet Singhtechnicalwritingtoolbox.com

17Apr2012

• Active voice• Strong, concrete verbs• Controlled vocabulary

Page 15: Lightening your Content

Healthy Exercise

May 2012@larry_kunz

Exercise good judgment!

Page 16: Lightening your Content

Healthy Exercise

May 2012@larry_kunz

Remember your audience!

• Not what the SMEs want it to say (how it works)

• But what your audience needs (how to use it)

Page 17: Lightening your Content

Healthy Exercise

May 2012@larry_kunz

Use structured authoring.

• Easier to isolate, then eliminate, unnecessary topics

• No need for “glue”

Page 18: Lightening your Content

Healthy Exercise

May 2012@larry_kunz

Change inconsistencyinto consistency.

• Terminology• Phraseology• Level of detail• Topic structure

Page 19: Lightening your Content

Healthy Exercise

May 2012@larry_kunz

Get feedback:

• Usability tests• Customer comments

…then adjust accordingly.

Page 20: Lightening your Content

Stay in Touch!

May 2012@larry_kunz

Larry Kunzwww.sdicorp.com/Resources/Blog.aspx

[email protected]: @larry_kunz