Great Technical Writing: Banish These Two Attitudes

Overview

Incomplete User Documents disappoint your Readers. Two attitudes of many Technical Writers result in incomplete User Documents. These two attitudes are:

. "Everyone Knows That", and

. "The User Can Figure It Out"

This article describes these attitudes and presents methods for overcoming them. The result is more effective User Documents and more satisfied Users.

1. "Everyone Knows That"

The "Everyone Knows That" attitude makes assumptions about your Reader's knowledge. These assumptions cause your Reader grief.

Here's an example of a possible "Everyone Knows That." Do you know this:

Tomatoes. Most of us keep them in a refrigerator. However, storing them in a refrigerator will ruin the taste and nutrition of tomatoes. Tomatoes should be stored on a kitchen counter at room temperature, until they are cut. Once cut, tomatoes should then be stored in the refrigerator.

Does everyone know that? What do you assume that everyone knows about your product?

Sometimes your User Documents have to overcome previous User experience. Everyone thinks that they know how to properly (safely) shut off a barbecue...they don't! The safe shutdown method is described in most barbecue User Documents, but it is not "advertised" (forcefully presented) in the User Documents.

Its rarely true that "Everyone Knows That". Just because you find something to be obvious, it does not mean everyone knows that something.

Here's another example: How do you use a (combined product -- '2 in one') shampoo and hair conditioner? When shampooing, the shampoo is massaged into the scalp and immediately rinsed. When conditioning the hair, the conditioner is massaged into the hair, and remains on the hair for about two minutes. Now, what do the Users do for the combined product: rinse quickly, or let the product remain in the hair?

If you have the "Everyone Knows That" attitude when you write, you will tend to leave out needed material from your User Document. You will be doing a disservice to your Readers, and to your writing.

When in doubt whether "everyone knows something," assume that they do not. Then,

. add some text explaining the topic, or

. tell the Reader where to find information that will explain the topic

Another Caution

Be careful about assuming that just because you explained something earlier in your User Document, your Reader will remember (or even have read) that information. It is rare for Users to read product documentation from start to finish.

When in doubt, add a reference to that earlier (background) information. Tell your Reader where to find it, or provide a link to it if your document is electronic.

Here's a Thought Experiment: You are a User of products: How often do you read the product documentation from start to finish? If you always do, then ask some other people. (The great thing about this fact -- that Users do not read the documentation from start to finish -- is that it results in great flexibility in writing, formatting and editing the product documentation.)

2. "The User Can Figure It Out"

The User does not want to have to figure things out. The User is not reading a mystery novel or any other literature, where he/she wants to think about what is happening.

When someone uses your product, they are using it to meet their own needs. Your product may be central to your life, but to your Users, your product is a means to an end. And they do not want to have to decipher your product documentation.

Here's a simple example. An e-mail tells you to call someone, but the message leaves out the phone number. You are expected to find the phone number on your own. The writer probably knew the phone number, but left it out. This "information oversight" gets expensive within a company when the e-mail is sent to many employees...each looking up the phone number on his/her own.

My favorite pet peeve: dates. Within recent memory we "survived" the Year-2000 transition. Yet we still write dates sloppily. We use "06" for a year, instead of "2006." When we see things like "07/11/04" what is the date it is referring to? Is it November 4, 2007, April 11, 2007, or some other permutation of the numbers. The standards for the format of dates vary around the world. This is an example of both assumptions:

. "everyone knows that" (because there is a "standard" date format -- there is not), and

. "the User can figure it out" (by seeing if my other dates provide clues to the format)

Dont leave things for the User/Reader to figure out for themselves. It takes you only a few moments to include the material your Reader needs, and will save many Readers many hours in figuring things out.

Do It:

The writing literature tells you to "know your Reader." Here is where you use that knowledge to improve your writing.

Either

. find someone who is like your intended Reader, or

. "do your best" to act like your intended Reader (you can do it if you need to)

In reading and evaluating the document, look for places where

. the writing assumes that "everyone knows that"

. the writing expects the Reader to be able to "figure it out"

. the writing makes jumps that your Reader cannot follow

. the writing makes the assumption that the Reader has read and remembered the entire document

Fix these places. It only takes a few words or sentences.

Everyone will be happier.

Barry Millman, Ph.D., has been a consultant for over 25 years, an instructor, course developer, and award-winning speaker. For the past seven years he has been researching and creating resources to help organizations create great User Documents. Visit: http://www.greatuserdocs.com/ for resources to help you create the content and access that your Users want and need.Littlelupevideos
Kinky Girl Gets Tied Up And Finger Fucked
Horny Bbw Babe Slammed By A Lucky Guy
Sleeping Bitch Threesome Sex Action
Cute Lady
Brookeskye
Little Lupe Innocent Teen Cutie
Little Lupe Uncensored Sucking Dick
3
Ariel Rebel Showing Her Teen Cunt In Public
Myteendeja
Little Lupe Movies
Plump Brunette Getting Pumped Full Of Jizz
Chessie Xxx Chubby Pussy Licking
Blonde Bbw That Loves To Be Fucked
Little Lupe Tight Pussy Picnic
Drunk Girls Sure Know How To Have A Sleeping Fuck Party
Sexingy Bbw Sucking On Two Cocks
Cute Flower Dress Little Lupe
COol Pixels
Cute Plumper Fingering Her Wet High School Pussy
Two Sexy Big Women Having Bbw Lesbian Sex
Little Lupe Getting Fuckinged Doggystyle
Chubby Latina Chick Gets Stuffed
Little Lupe Gives Blowjob Outdoor
Chubby Girl Showing Her Boobies
Chubby Teen
Asian Bbw Pounding Her Plump Teen Pussy With Fake Brutal Cock
Blonde College Teen Fucks Hard
Hayleehunter
Little Lupe Short Skirt
Chubby Girls From Fling
Selina18blog
Little Lupe Wearing Cute Red Dress
Plump Fat Young Pussy
Littlelupegallery
Amateur Homemade Porn Girlfriend Movie
Little Lupe Pink Booty Shorts
Little Lupe Pictures
Sleepsins Halloween Assault
Young Sex Hole Full Of Hot Cum
Pamela Spice Lesbian Play
Cumcave
Sleeping Fucking Fantasy Fucking Trailer
Mrsquirt
Ariel Rebel Snatch
Littlelupegallery
Sleep Sins The Sleep Assault New Sleeping Fucking Site
Little Lupe Cute Summer Panties
Selina18ishot
Little Lupe Lesbian
#comments
Chubby Lesbian Chicks
Selina18 Cute Teen With Braces
Realestateinvancouver
Nzc3nzozojmx
Pamela Spice Young Teen Nipples
Mistygatesblog
Ariel Rebel Sexy Sweater
Katie Pink Pussy Stretch Dildo Fun
Night Invasion Blonde Blowjob Vid
Littlelupevideos
#comments
Piperfox Playing Guitar Hero
#comments
Sleeping Bitch Gets Her Vagina Licked And Fuckinged
Andi Pink Short Skirt
Feed
Cute Karla Spice Fingers Pussy Gallery
Teen Drunk College Girl
Pamela Spice Latin Pussy Gallery
Trishastorm
Jordan Capri Lesbian Sleep Fucking
Bbw Sybian Riders
Night Invasion Sexy Free Video
Young Voyeur Dorm Teens Sex Party
Lesbian Twins
Pamela Spice Nude
Squirting 101 Has Babes That Can Really Spray
Katesplayground
Little Lupe Sucking Huge Cock
Sexy Bbw Young Princess Lissa Naked
Cock Or Dildo
Feed
Sitemap
Plump Lesbian Cunt Licking
Feet Fetish Blonde Teenager Girl
Selina18pics
Cute Girls
Little Lupe Lesbian Fuck
Ariel Rebel Nude
Latina Teenager Outdoor Naked
Drunk College Girl Gets Her Teen Cunt Licked And Sleep Assaulted
Sweetadriblog
Jordan Capri Lesbian Toying On Bed
Softcoreteens
Sex My Little Teen Tits
Cute Karla Spice Fingers Pussy Gallery
Selina18 Lesbian Pool Sex
Ebangbros
Asian Girl Sleep Assault
Alyssa Bliss
Little Lupe
Sitemap
#comments
Kates Playground Sexy Lingerie Set
Hot Babe Gets Sexed While Sleeping
Little Lupe Nude
Pamela Spice Playground
Chubby In The Beach Look At That Body
Pamelaspiceblog
Hardcore Full Movie Of Little Lupe
Little Lupe Tease
Feed
Ex Girlfriend Young Teen Voyeur
Pamelaspice Blackpanties
Xoxo Leah Playing Nude Soccer
Check Out My Sex Hole
Sweetadriblog
Cute Chubby Chick
Abigail 18
Sitemap
See This Hot Chubby Sexing Action
Old Mature Woman With Chubby Twat
Little Lupe Bath Tease
Little Lupe Stripping In The Bushes
Carmen Cocks
Fat Fuckinging
Chubby Chick Gets Fucked
Little Lupe Dildo Doggy Picture
Pamelaspice
Little Lupe Hard Cock Blowjob
Sleep Assault Anal Sex
Little Lupe Lesbian Milf Picture
Sexy Nude Ex Girlfriend Pictures
Snow Bunny Sleep Assault Milf
Little Lupe Likes It Doggystyle
Little Lupe Hardcore Dildo
Night Invasion Violation
Mygaydatingservice
Candyskye
Ariel Rebel Shows Tiny Tits
Hi Guys This Is Me Candy Skye
Teens Passed Out Sleeping Sex Fucking
Brooke Skye Hot Clit And Nipples
Sweetadris
Karlaspice
Chubby Fat Young Fuck Trailer
Piper Fox Plays Guitar Hero
Melissamidwest Hardcore Hooters Girl
Misty Gates Playing Guitar Hero Naked
Candy Skye Getting Sexed
Ariel Rebel Posing In Cap
Blonde College Teen Fucks Hard
Chubby In Stockings Getting Ready
Milfsniper
Little Lupe Loves Sucking Cock Licking Up Cum
Sleeping Bitch Is Great At Fuck
Casey Parker Trucker Girl
Assparademilf
New Fuckingy Bbw Mila Monroe
Myteendeja
Piper Fox Lesbian Teen Girls
Young Lesbian Sleeping Bitch Fuckinging Assualt
Little Lupe Lesbian Intercourseing
Jordan Capri Lesbian Toying On Bed
Sitemap
Dominated Female Anal Bdsm Submission Video
This Is Little Lupe
#comments
Littlelupegallery
Little Lupe Snapper
Ariel Rebel Picture
Selina18xxx
Feed
Sexy Twins
Tiffanypreston
Young Wet And Beautiful Plump Chick
Dominated Female Anal Bdsm Submission Video
Ariel Rebel Ass
Misty Gates Cute Teen Porn Movies
Chubby Chick Beaver Drilled
Redhead Sexed In Her Sleep
Sweet Adri Loves Lesbian Pussy
Style
Little Lupe Wants Cum
Feed
Super Chubby Chick Is Horny
Little Lupe Gives The Best Blowjobs
Sleepfucks
Passed Out Drunk Slut On Drugs Fuck
Little Lupe Sucks A Dick Full Movie Free Full Movie
Hot Chubby Chick Does Anal
Feed
Candy Skye Young Cunt
Casey Parker Trucker Girl
Lil Lupe
Little Lupes Tits
High On Drugs Blond Gets Fucked Hard By Black Guy While Asleep Sleeping Fuck
Littlelupe Schoolgirl Hardcore Clip
Vancouver Condos
Chrissy Blooms
Little Lupe Loves Milf Juggs
Doctor Sleep Sexs A Sexingy Hot Sleeping Teen Babe
Sexy Chubby Mom Summer Lynn Playing With Dildo
Chunky Booty With A Tramp Stamp
Big Asian Tits
Littlelupevideos
Hayleehunter
Candy Skye Shower
Passed Out Black Teen Girl Fuckinged
Pamelaspice1
Katiepink
Misty Gates Free Photo Gallery
Sexy Plump Chicks Wanna Fucking Them
Chubby Blonde On The Couch
Fattie Masturbates Herself
Tanning Teenager Joins The Sleeping Bitch Sex Club
Selina18blog
Check Out My Tits
Mygaydatingservice
Little Lupe Sucking Cock
Sleep Assault Sleeping Fuck Drunk Teen
Young Hot Babe Sleep Fucked In Her Young Pussy
Xoxo Leah In The Shower Free Pictures
Brand New Free Sleep Assault Free Clip
Hot Eighteen Fatty Spreading Her Chubby Eighteen Cunt
Little Lupe Riding Cock
Little Lupe Lifts Up Her Skirt Clip
Sexy Sleep Assault College High School Babe
Chubby Fanny Galore
Drunk Teens Passed Out Sleeping Sex
Brookeskye
New Fuckingy Bbw Mila Monroe
Little Lupes Tits
Pamela Spice Playground
Fat Fuckinging
Pamela Spice Hot Latina Fun
Sitemap
Pamelaspice1
Ariel Rebel Ass
Little Lupe Likes It Doggystyle
Ariel Rebel Snatch
Hot Eighteen Fatty Spreading Her Chubby Eighteen Cunt
Drunk College Girl Sexed In Her Sleep
Little Lupe Bath Tease
Brand New Free Sleep Assault Free Clip
Latina Teenager Outdoor Naked
Asian Bbw Pounding Her Plump Teen Pussy With Fake Brutal Cock
Littlelupevideos
Karla Spice Pink Panties On Her Bed
Little Lupe Loves Milf Juggs
Kates Playground Sexy Lingerie Set
Asian Girl Sleep Assault
Bbw Sybian Riders
Little Lupe Riding Cock
Little Lupe Hard Cock Blowjob
Chubby Teen
Whore Gets A Taste Of Sleeping Fucking
High On Drugs Drunk College Girls Get Cummed On
Sweet Adri Loves Lesbian Pussy
Pamelaspiceblog
Young Wet And Beautiful Plump Chick
Little Lupe Pictures
Jordan Capri Cow Girl Hotness
Candy Skye Fucking Hole
Katesplayground
Chubby In Stockings Getting Ready
Chubby Girls From Fling
Chubby Lesbian Chicks
Chubby Girl Showing Her Boobies
Blonde Bbw That Loves To Be Fucked
Feed
Young Sex Hole Full Of Hot Cum
Chunky Booty With A Tramp Stamp
Sweet Adri Loves Lesbian Pussy
Snow Bunny Sleep Assault Milf
Sleep Assault Picture Free Drunk Girl
Little Lupe Dildo Doggy Picture
Big Natural Tits And A Perfect Ass
Super Chubby Chick Is Horny
Drunk Girls Sure Know How To Have A Sleeping Fuck Party
Littlelupegallery
Hot Babe Gets Sexed While Sleeping
Brooke Skye Hot Clit And Nipples
Little Lupe
Innocent 18 Year Old Little Lupe Picture And Videos
Sleep Assault Sleeping Fuck Drunk Teen
Sitemap
Sitemap
Little Lupe Lesbian
Pamelaspice Blackpanties
Misty Gates Cute Teen Porn Movies
Vancouver Real Estate Market
Feed
Chunky Booty With A Tramp Stamp
Cute Chubby Chick
Casey Parker Blowjob Hardcore
Ariel Rebel Red White
Big Natural Tits And A Perfect Ass
Jordan Capri Cow Girl Hotness
Sleeping Bitch Threesome Sex Action
Brooke Skye In The Bath
Two Sexy Big Women Having Bbw Lesbian Sex
Softcoreteens
Kinky Girl Gets Tied Up And Finger Fucked
Andi Pink Short Skirt
Little Lupe Hard Cock Blowjob
Lil Lupe
Brookeskye
Pamela Spice Latin Pussy Gallery
Drunk High Schools Passed Out Sleeping Sex
Pussypee
Ariel Rebel Lesbian
Brand New Free Sleep Assault Free Clip
High On Drugs Blond Gets Fucked Hard By Black Guy While Asleep Sleeping Fuck
Super Chubby Chick Is Horny
Littlelupevideos
Squirting 101 Has Babes That Can Really Spray
Sleepassault1
Sleep Sins The Sleep Assault New Sleeping Fucking Site
Chubby Lesbian Chicks
COol Pixels
Bbw Sybian Riders
Piper Fox Photo Gallery
#comments
Sleepsins My New Favorite Sleep Sex Site
Candy Skye Getting Sexed
Chubby Latina Chick Gets Stuffed
Little Lupe Loves Sucking Cock Licking Up Cum
Young Wet And Beautiful Plump Chick
Misty Gates Playing Guitar Hero Naked
Mygaydatingservice
Hayleehunter
Jordan Capri Lesbian Toying On Bed
Assparademilf
Xoxo Leah In The Shower Free Pictures
Little Lupe Wearing Cute Red Dress
Selina18 Lesbian Pool Sex
Tanning Teenager Joins The Sleeping Bitch Sex Club
Pamela Spice Wet At The Pool
Little Lupe Pink Booty Shorts
Little Lupe
Dominated Female Anal Bdsm Submission Video
Drunk Teens Passed Out Sleeping Sex
Pamela Spice Lesbian Play
Young Sex Hole Full Of Hot Cum
Abigail 18
See This Hot Chubby Sexing Action
Ariel Rebel Ass
Check Out My Sex Hole
Sexy Twins
High On Drugs Teen Babe Sexs And Sucks Cock In Her Sleep
Katiepink