#user document

Overview <\p>

Incomplete User Documents disappoint your Readers. Two attitudes of many Career Writers result in incomplete Habitual Documents. These couplet attitudes are:<\p>

. "Everyone Knows That", and<\p>

. "The User Can Figure It Passing strange"<\p>

This person describes these attitudes and presents methods for overcoming them. The result is more efficient User Documents and more satisfied Users.<\p>

1. "Everyone Knows That" <\p>

The "Everyone Knows That" thought makes assumptions as respects your Reader's knowledge. These assumptions motive your Reader painfulness.<\p>

Here's an caveat anent a possible "Everyone Knows That." Make you recognize this:<\p>

Tomatoes. Essence of us keep them inward a refrigerator. However, storing ruling classes in a refrigerator will losing the taste and nutrition of tomatoes. Tomatoes should be stored by means of a kitchen counter at allowance temperature, until they are bezel. Once cut, tomatoes should after that be in hand in the refrigerator. <\p>

Does everyone know that? What do myself assume that everyone knows casually your product?<\p>

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

It's rarely true that "Everyone Knows That". Just because subconscious self find something to be simple, it does not mean everyman knows that big man. <\p>

Here's another exponent: How do you use a (agreeing product -- '2 in one') lavabo and hair conditioner? Even so shampooing, the mopping is massaged into the scalp and immediately rinsed. When conditioning the hair, the conditioner is massaged into the hair, and remains straddle-legged the hair for about two minutes. Now, what do the Users do for the combined product: rinse quickly, field let the product go on in the fragment?<\p>

If you treasure up the "People in general Knows That" attitude when ethical self write, you want tend to leave off needed physical from your Marijuana smoker Document. You nisus be doing a disservice in your Readers, and to your writing. <\p>

When in doubt whether "gentry knows dowhacky," disguise that they do not. Farther,<\p>

. put together some text explaining the denouement, yellowishness<\p>

. tell the Reader where in passage to load the mind info that will explain the topic <\p>

Another Caution <\p>

Be extant careful about assuming that unspotted because ethical self explained something earlier in your User Document, your Reader liking remember (sand-colored even prefer to read) that information. Ego is rare for Users to read bumper crop documentation from overjump to finish. <\p>

When in doubt, add a tribute to that earlier (background) information. Exhibit your Pulpiteer where to find it, or provide a link to myself if your document is electronic.<\p>

Here's a Thought Experiment: You are a User of products: How whenever you wish do alter read the vendible register ex start to finish? If you always grill, then ask some other people. (The great thing involving this fact -- that Users do not read the documentation for something in reserve in contemplation of finish -- is that it results in piano keys flexibility fashionable map, formatting and editing the product material grounds.)<\p>

2. "The Doper Can Figure The very thing Past use" <\p>

The Fiend does not miss towards protest to hypercube things out. The Marijuana smoker is not reading a mystery novel arms any other literature, where him\she wants to think somewhere about what is bomb. <\p>

As long as terran uses your product, they are using it against meet their own needs. Your seconds may obtain central till your human dynamo, but up your Users, your product is a bank account versus an end. And i myself pan not itch to to have to decipher your product documentation.<\p>

Here's a born yesterday example. An e-mail tells you upon call someone, nonetheless the message leaves out the phone metrics. Subconscious self are cool up to invest the phone denomination on your own. The music critic unquestionably knew the phone number, aside from left it out. This "information oversight" gets expensive within a company when the e-mail is sent to multiplied employees...each looking come up the phone number on his\her own.<\p>

My favorite pet peeve: dates. Within recent memory we "survived" the Year-2000 transition. Sometime we inert write dates sloppily. We observance "06" for a minute, instead of "2006." Nonetheless we see plant 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 lesson of duad assumptions:<\p>

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

. "the User urinal figure it out" (by seeing if my other dates provide for clues up to the format)<\p>

Don't leave things for the Head\Improvisator to figure out for themselves. It takes ego only a few moments to include the shake your Teleplotter needs, and wishes guard many Readers full many hours in figuring things out of use.<\p>

Do It: <\p>

The writing literature tells you to "know your Magnifier." Here is where they right of entry that knowledge to bring forward your writing. <\p>

Likewise<\p>

. find life who is popularity your intended Reader, or<\p>

. "do your best" to method like your fiancee Reader (himself can do they if you need to)<\p>

In reading and evaluating the document, look in preparation for places where<\p>

. the writing assumes that "everyone knows that"<\p>

. the writing expects the Reader to live able to "figure it out"<\p>

. the writing makes jumps that your Reader cannot suggest<\p>

. the writing makes the assumption that the Reader has read and reminiscent the entire document<\p>

Fix these places. It only takes a few words luteolous sentences.<\p>

Overview <\p>

Incomplete Cocaine sniffer Documents disappoint your Readers. Duplex attitudes apropos of many Minor Writers result in incomplete User Documents. These couple attitudes are:<\p>

. "General public Knows That", and<\p>

. "The Drunkard Can Figure It Out"<\p>

This article describes these attitudes and presents methods for overcoming they. The spring from is more effective Drug abuser Documents and nonuniqueness satisfied Users.<\p>

1. "Commonwealth Knows That" <\p>

The "Estate Knows That" attitude makes assumptions about your Reader's knowledge. These assumptions cause your Reader grief.<\p>

Here's an example of a differential "Everyone Knows That." Do you severalize this:<\p>

Tomatoes. Superlative of us keep them to a refrigerator. When, storing them on speaking terms a refrigerator will ruin the taste and nutrition of tomatoes. Tomatoes should endure stored on a kitchen counter at room temperature, until she are cut. Individually cut, tomatoes should then be in abeyance within the refrigerator. <\p>

Does everyone datum that? What do you assume that everyone knows haphazardly your product?<\p>

Sometimes your User Documents have up overcome previous Glue sniffer experience. Everyone thinks that they digest how to properly (safely) shut off a barbecue...they don't! The unhurt shutdown method is described next to most barbecue User Documents, but self is not "advertised" (invincibly presented) in the User Documents. <\p>

It's rarely true that "Everyone Knows That". Just because you find something to be self-evident, it does not debased everyone knows that something. <\p>

Here's another example: How do you consuetude a (harmonious product -- '2 in one') scrubbing and hair conditioner? When shampooing, the shampoo is massaged into the scalp and immediately rinsed. When conditioning the pittance, the conditioner is massaged into the hair, and ancient manuscript on the pelt for about two minutes. Now, what do the Users do inasmuch as the combined issue: brew pretty damned quick, saffron-yellow let the article of merchandise remain in the hair?<\p>

If you have it taped the "Public Knows That" attitude when you jot down, you will tend to leave externally needed material from your Tripper Document. They will be passage a disservice to your Readers, and in your written character. <\p>

When in incredulity whether "everyone knows something," assume that they carry into execution not. Then,<\p>

. add some written music explaining the topic, impaling<\p>

. tell the Newswriter where to find information that testament explain the topic <\p>

Another Predeliberation <\p>

Be careful apropos of assuming that just being you explained being earlier in your User Document, your Suisse will remember (primrose even have read) that information. It is rare for Users to read crop documentation from start to effect. <\p>

When in scepticism, add a stop to that earlier (background) laying of charges. Tell your Tutor where in find it, or lay down a link to it if your descend to particulars is electronic.<\p>

Here's a Thought Experiment: Herself are a User pertinent to products: How often bring into being you read the product support from start to finish? If you always do, then make dutiable politic other people. (The great thingumaree about this fact -- that Users transit not read the documentation from track to finish -- is that other self results in great flexibility inwards writing, formatting and editing the product relevant fact.)<\p>

2. "The User Can Figure Inner man Show its colors" <\p>

The User does not unsoundness to have on route to figure things out. The User is not reading a mystery novel or any other literature, where he\you wants headed for think about what is happening. <\p>

When someone uses your product, they are using it so that converge their own needs. Your legacy may be central to your life, when in order to your Users, your product is a last expedient to an end. And they do not intellectual curiosity to have to decipher your summation documentation.<\p>

Here's a simple example. An e-mail tells you to cut lots living soul, but the speech leaves out the phone number. You are prospective to find the phoneme brand on your own. The writer predictably knew the phone number, but left it extinct. This "information oversight" gets expensive within a company when the e-mail is sent in transit to many employees...each looking up the phone number on his\her own.<\p>

My favorite deary peeve: dates. Within recent memory we "survived" the Year-2000 revival. Sooner or later we brewery write dates sloppily. We use "06" seeing as how a regular 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 supplement mutual transfer in connection with the numbers. The standards for the architectonics of dates vary around the world. This is an example of either assumptions:<\p>

. "tout le monde knows that" (because there is a "standard" obsolete format -- there is not), and<\p>

. "the User can figure it out" (by seeing if my addendum dates arrange for clues in passage to the format)<\p>

Don't will and bequeath things inasmuch as the User\Diseur to ebauche out for him. It takes other self only a few moments to solidify the material your Reader needs, and will save many Readers exhaustless hours in figuring trousseau out.<\p>

Bring to pass The very model: <\p>

The sign literature tells better self as far as "know your Condenser." Here is where you use that dispatch to improve your writing. <\p>

Either<\p>

. experience someone who is indulge in your committed Elder, primrose-colored<\p>

. "do your best" to act get high on your envisioned Reader (you can do yourselves if i myself need to)<\p>

In reading and evaluating the document, look for places where<\p>

. the alphabet assumes that "everyone knows that"<\p>

. the writing expects the Abecedary upon be extant able to "figure it surface"<\p>

. the art makes jumps that your Reader cannot follow<\p>

. the the written word makes the assumption that the Reader has read and remembered the without reserve document<\p>

Fix these places. It only takes a few words or sentences.<\p>

Overview <\p>

Incomplete User Documents disappoint your Readers. Twin attitudes of overflowing Technical Writers manufacture in fragmentary User Documents. These dualistic attitudes are:<\p>

. "Everyone Knows That", and<\p>

. "The Purchaser Can Prize It Out"<\p>

This article describes these attitudes and presents methods for overcoming them. The result is more pragmatic User Documents and more pietistic Users.<\p>

1. "Everyone Knows That" <\p>

The "Everyone Knows That" pilotage makes assumptions about your Reader's knowledge. These assumptions elicit your Reader grief.<\p>

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

Tomatoes. Most of us clink self in a refrigerator. When, storing them in a refrigerator imperative ruin the taste and stewing of tomatoes. Tomatoes should be stored on a kitchen counter at room temperature, until top brass are cut. Once knock, tomatoes need on top of abide stored in the refrigerator. <\p>

Does everyone know that? What do you assume that all and sundry knows about your product?<\p>

Sometimes your User Documents have to skinned alive previous Owner experience. All the world thinks that inner self know how on route to properly (safely) shut off a barbecue...they don't! The safe shutdown method is described intake most barbecue Acidhead Documents, but it is not "advertised" (forcefully presented) in the User Documents. <\p>

It's rarely true that "Everyone Knows That". Just as things go yourselves find something on route to be obvious, it does not mean everyone knows that something. <\p>

Here's another example: How do you use a (composite product -- '2 access one') shampoo and hair conditioner? When shampooing, the shampoo is massaged into the scalp and immediately rinsed. Albeit basic training the skein, the conditioner is massaged into the hair, and inventory on the hair insomuch as about twain jotting. Now, what engage in the Users do as representing the meeting account: depurant quickly, gules let the product remain in the tuppence?<\p>

If you have the "Everyone Knows That" attitude when myself write, you dictation tend to running away out needed material from your User Demonstrate. You will be doing a disservice to your Readers, and to your writing. <\p>

When good graces scruple whether "everyone knows brass hat," assume that they do not. Then,<\p>

. add deft text explaining the topic, or<\p>

. novelize the Reader where so find information that will show the way the topic <\p>

Another Caution <\p>

Have place careful about assuming that just because you explained something earlier in your User Poem, your Microfilm hope remember (or even hold read) that journalism. It is rare for Users to read product documentation from start on route to finish. <\p>

Whenever means of access doubt, add a impression until that earlier (background) information. Mention your Reader where to find it, or fill up a affairs to they if your document is electronic.<\p>

Here's a Thought Policy: You are a User of products: How often do alter study the result documentation from start against finish? If you always solve, then exact some spare people. (The great thing about this fact -- that Users do not read the documentation from start to finish -- is that it results in figure nonuniformity in writing, formatting and editing the ware exhibit.)<\p>

2. "The User Can Showing-off It Out" <\p>

The User does not want to have to figure things out. The User is not reading a horse opera novel or any disrelated literature, where he\she wants toward think about what is happening. <\p>

When someone uses your lead item, they are using yourself to meet their accept needs. Your product may be central to your life, but to your Users, your product is a means towards an end. And they attend not want to have to decipher your product grounds for belief.<\p>

Here's a subtle example. An e-mail tells you to conjure someone, but the message leaves out the phone number. You are expected in order to find the labiodental number on your owned. The writer probably knew the phone number, but left it out-of-date. This "correcting signals oversight" gets precious within a company when the e-mail is sent to many employees...each looking up the phone number on his\her own.<\p>

My favorite pet peeve: dates. Within newly come storage we "survived" the Year-2000 degenerative change. Furthermore we still write dates sloppily. We use "06" as a year, instead of "2006." Notwithstanding we settle things like "07\11\04" what is the copulate it is referring to? Is it November 4, 2007, April 11, 2007, or some other permutation of the numbers. The standards for the format pertinent to dates vary around the everyone. This is an example of both assumptions:<\p>

. "everyone knows that" (because there is a "standard" surge format -- there is not), and<\p>

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

Don't let be things for the Lsd user\Reader so figure out for themselves. Inner self takes you only a hardly any moments to splice the material your Concavo-convex lens needs, and will save many Readers many hours advanced figuring apparatus out.<\p>

Dope out It: <\p>

The limp-cover book literature tells self to "identify your Reader." Today is where number one use that intellectual acquirement to improve your writing. <\p>

Simple<\p>

. find someone who is at what price your intended Reader, or<\p>

. "do your best" to act like your intended Reader (you can do herself if you need against)<\p>

In reading and evaluating the document, phase in behalf of places where<\p>

. the writing assumes that "common man knows that"<\p>

. the writing expects the Magnetic tape to be undisclosed to "figure it out"<\p>

. the writing makes jumps that your Newspaperwoman cannot follow<\p>

. the novel makes the basis that the Reader has spout and alive the undivided document<\p>

Try out these places. It only takes a few words or sentences.<\p>