IntroductionIntroduction

Presenter: Matthew HowsePresenter: Matthew HowseDate: 9/23/08Date: 9/23/08

Article: Article: "Adding Life to Your Documentation""Adding Life to Your Documentation" Author: Whitney Beth PotsusAuthor: Whitney Beth Potsus

OverviewOverview

Ever get caught in a writers blockEver get caught in a writers block

Doing the same thing day in and day outDoing the same thing day in and day out

How to get past writers block and keep the How to get past writers block and keep the readers attention.readers attention.

N- listN- list

N- list, no more that 15 main points keep it N- list, no more that 15 main points keep it brief brief

Can be links off the 15 main pointsCan be links off the 15 main pointsK.I.S.S. keep it simple stupid. K.I.S.S. keep it simple stupid. ““The Least You Need to Know” ListsThe Least You Need to Know” Lists

Use to-do Lists, Recipes, Use to-do Lists, Recipes, Checklists.Checklists.

Described as shopping list documentationDescribed as shopping list documentation

Having everything you need before you follow a procedure. Having everything you need before you follow a procedure. Checklist what to do before the next step.Checklist what to do before the next step.Great for assemblies, installation, and procedural directions.Great for assemblies, installation, and procedural directions.

““The least you need The least you need to know” lists.to know” lists.

Giving you the bare minimum of the topicGiving you the bare minimum of the topic

Not very in-depth Not very in-depth Just good enough for a basic understandingJust good enough for a basic understanding

Telling the users what they’re supposed to do.

Very technical, usually wanting the user to Very technical, usually wanting the user to do something. do something.

Best/Common Practices Best/Common Practices Well written can be very goodWell written can be very goodPoorly written can result in 9 support calls per monthPoorly written can result in 9 support calls per month

GraphicsGraphics

Charts, Graphs, tables, and pictures. Charts, Graphs, tables, and pictures.

Good for comparing objects Good for comparing objects Good to grab the reader, more likely to read the articleGood to grab the reader, more likely to read the articleMaking it quick and easy Making it quick and easy

Quizes and other Quizes and other self-testsself-tests

Self explanatory way of explaining getting Self explanatory way of explaining getting you’re point across.you’re point across.

Easy/hardEasy/hardLong/shortLong/shortFun/serrousFun/serrousUseful in training classesUseful in training classes

ConclusionConclusionMain pointsMain points

“What matters is that they read and felt that they walked away with enough knowledge to be immediately productive.”

Catching the readers attention and holding it.

Effective and fast ways to get your point across.

??Questions????Questions??