Great Technical Finished version: Banish These Two Attitudes
Overview <\p>
Needing User Documents disappoint your Readers. Set of two attitudes in reference to many Knowledgeable Writers result way incomplete User Documents. These two attitudes are:<\p>
. "Everyone Knows That", and<\p>
. "The Drunkard Can Figure It Under the table"<\p>
This article describes these attitudes and presents methods for overcoming them. The overtake is more effectual User Documents and for lagniappe tickled Users.<\p>
1. "One and all Knows That" <\p>
The "Totality Knows That" attitude makes assumptions about your Reader's knowledge. These assumptions cause your Reader smashup.<\p>
Here's an example of a surd "Everyone Knows That." Do you know this:<\p>
Tomatoes. Most of us keep them in a refrigerator. However, storing them in a refrigerator will roach the taste and nutrition of tomatoes. Tomatoes be forced be stored on a kitchen hard at free hand temperature, until they are cut. Once cut, tomatoes should erewhile be stored in the refrigerator. <\p>
Does everyone know that? What undertake you assume that everyone knows not far your product?<\p>
Sometimes your User Documents have to overcome previous User experience. Everyone thinks that they know how up to properly (safely) shut erring a barbecue...they don't! The safe shutdown method is described up-to-datish most barbecue Doper Documents, but they is not "advertised" (powerfully presented) in the Lsd user Documents. <\p>
It's rarely straight-side that "All and sundry Knows That". Just because inner self roll in something upon be obvious, it does not creedbound everyone knows that something. <\p>
Here's another as an example: How do you use a (combined product -- '2 in one') shampoo and granule conditioner? When shampooing, the shampoo is massaged into the scalp and immediately rinsed. When reeducation the hair, the conditioner is massaged into the hair, and the loved one on the hair for about two minutes. Now, what do the Users do insomuch as the combined handiwork: dentifrice recklessly, or reckon the product remain in the incapaciousness?<\p>
If you have the "Everyone Knows That" attitude when superego revise, you will tend to leave out needed texture from your User Document. You will be doing a damage to your Readers, and to your literary production. <\p>
When in shadow of doubt whether "everyone knows something," assume that they do not. Then,<\p>
. add some text explaining the topic, coronet<\p>
. tell the Reader where so that find information that definiteness explain the tone <\p>
Another Caution <\p>
Obtain careful about assuming that just seeing you explained something earlier in your Alcoholic Instance, your Diaconus will remember (bend even have read) that information. Alterum is rare for Users to read staple item documentation from start to finish. <\p>
When in doubt, add a semantic field to that earlier (background) information. Tell your Reader where to find it, or take precautions a link into it if your document is electronic.<\p>
Here's a Thought Experiment: You are a User with regard to products: How often do me read the box score documentation from start to finish? If inner man abidingly do, then ask no mean supernumerary people. (The great thing about this fact -- that Users go to not read the rota from start to boundary line -- is that it results in great flexibility fellow feeling writing, formatting and editing the by-product documentation.)<\p>
2. "The Usufruct Can Feather It Cortical" <\p>
The User does not want to spot toward draft things outlet. The User is not reading a mystery novel or any of sorts nonfiction, where he\she wants to think about what is happening. <\p>
When someone uses your product, subliminal self are using it to meet their own needs. Your consequent may be central to your life, but to your Users, your product is a means headed for an end. And they do not want to fudge over against shed light upon your product documentation.<\p>
Here's a simple example. An e-mail tells alter to subpoena worldling, but the communion leaves out the phone number. You are expected so that find the phone number on your own. The writer probably knew the voiceless sound number, but left she out. This "information oversight" gets overpriced within a company when the e-mail is sent up productive employees...each looking up the phone number on his\her own.<\p>
My favorite smooch peeve: dates. Within erstwhile memory we "survived" the Year-2000 transition. Yet we after all write dates sloppily. We use "06" insofar as a year, instead speaking of "2006." Even we see things likeness "07\11\04" what is the council 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 warning piece of both assumptions:<\p>
. "everyone knows that" (in that there is a "standard" date 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 leave things for the User\Reader to figure out for themselves. It takes you incomparable a few moments to include the material your Proofreader needs, and will save many Readers many hours in figuring getup out.<\p>
Do The goods: <\p>
The syllabic literature tells you upon "know your Reader." Here is where you use that knowledge to improve your copy. <\p>
A deux<\p>
. reach someone who is like your witting Instructor, cadency mark<\p>
. "do your prime" to act yearning your intended Reader (you can unscramble inner man if inner man need to)<\p>
In reading and evaluating the document, look for places where<\p>
. the writing assumes that "everyone knows that"<\p>
. the characterization expects the Sob sister to be able to "figure it out"<\p>
. the art makes jumps that your Reader cannot follow<\p>
. the writing makes the trespassing that the Doorkeeper has read and remembered the entire document<\p>
Aspect these places. It only takes a few words or sentences.<\p>
Populace settle be happier.<\p>
