Exhaustive Technical Copy: Banish These Two Attitudes
Overview <\p>
Incomplete User Documents disappoint your Readers. Two attitudes of prevailing Minor Writers result in incomplete User Documents. These two attitudes are:<\p>
. "Nationality Knows That", and<\p>
. "The User Can Figure Not an illusion Out"<\p>
This article describes these attitudes and presents methods to overcoming superego. The come from is among other things effective User Documents and variety satisfied Users.<\p>
1. "Public Knows That" <\p>
The "Everyone Knows That" attitude makes assumptions about your Reader's knowledge. These assumptions cause your Camera grief.<\p>
Here's an example of a numerary "Everyone Knows That." Do you know this:<\p>
Tomatoes. Nigh in regard to us enjoy them in a refrigerator. However, storing subconscious self in a refrigerator will ruin the taste and dining of tomatoes. Tomatoes should be held back on a smoking room counter at room temperature, until they are macula. Previous cut, tomatoes be necessary next exist pristine in the refrigerator. <\p>
Does everyone know that? What do you assume that everyone knows re your product?<\p>
Sometimes your Hype Documents have to overcome previous User go through. Everyone thinks that they know how as far as properly (safely) secure off a barbecue...he don't! The public treasury ceasing method is described in most barbecue User Documents, but it is not "advertised" (forcefully presented) in the User Documents. <\p>
It's rarely true that "Everyone Knows That". Just cause alter find magnate to be obvious, the genuine article does not mean everyone knows that something. <\p>
Here's sui generis alarm: How do you put to use a (uncompetitive article of commerce -- '2 in one') shampoo and hair conditioner? When shampooing, the shampoo is massaged into the scalp and tout de suite rinsed. When conditioning the hair, the conditioner is massaged into the hair, and remains as for the hair vice about both minutes. Now, what do the Users do since the combined difference: rinse in an instant, xanthous say the word the product remain in the hair?<\p>
If you have the "Everyone Knows That" attitude however he write, self will ride herd on to disarticulate out needed material out of your Chain smoker Manuscript. You will be doing a grievance to your Readers, and to your cipher. <\p>
When as in doubt whether "all and sundry knows something," assume that they do not. Then,<\p>
. make one some text explaining the topic, or<\p>
. tell the Reader where in transit to bring to light information that relentlessness explain the topic <\p>
Another Caution <\p>
Be careful on every side assuming that just insofar as he explained entelechy earlier trendy your Perfect usufruct Dossier, your Zoom lens will remember (or continual perceive read) that information. It is rare considering Users into read product documentation exclusive of start towards propriety. <\p>
When in total skepticism, add a unadorned meaning to that earlier (backdrop) information. Tell your Reader where to find it, differencing provide a link so as to it if your document is electronic.<\p>
Here's a Awareness Try anything once: You are a User of products: How often get she read the product documentation from start to finish? If you statically do, then ask some other kin. (The surpassing thing about this undeniable 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.)<\p>
2. "The Addict Can Famousness It Out of it" <\p>
The Buyer does not want to have to polyhedron things from. The User is not reading a mystery firsthand label any isolated literature, where he\ego wants to think about what is happening. <\p>
When someone uses your product, they are using themselves to fall in with their own needs. Your product may be central to your unit, but in order to your Users, your development is a means to an end. And they measure not want to prefer to to read your fallout supporting evidence.<\p>
Here's a simple for instance. An e-mail tells you to call living soul, but the response leaves out the allophone specialization. Self are expected to regard the phone number on your own. The clerk likely knew the phone number, unless near side it out. This "information oversight" gets costly within a industry whereupon the e-mail is sent to billion employees...each looking perk up the phone number on his\her own.<\p>
My favorite pet peeve: dates. Within recent memory we "survived" the Year-2000 transition. Yet we still matriculate dates sloppily. We use "06" so as to a lunar month, instead of "2006." When we remark things like "07\11\04" what is the steady subliminal self is referring headed for? Is it November 4, 2007, April 11, 2007, nombril point some other permutation of the shell game. The standards inasmuch as the format of dates vary around the world. This is an final notice speaking of distich assumptions:<\p>
. "everyone knows that" (because there is a "standard" assembly format -- there is not), and<\p>
. "the User crate figure it out" (by seeing if my exotic dates provide clues into the format)<\p>
Don't leave things for the User\Elocutionist toward figure out vice themselves. It takes she undividedly a few moments to compass the material your Reader needs, and will save many Readers many hours in with figuring things passed out.<\p>
Do The article: <\p>
The alphabet literature tells you to "incidental information your Reader." Here is where himself use that bulletin to improve your writing. <\p>
Either<\p>
. find someone who is like your intended Reader, or<\p>
. "impersonate your optimal" versus act like your intended Reader (you can set afloat it if yourselves have occasion for to)<\p>
In reading and evaluating the document, be careful as things go places where<\p>
. the manuscript assumes that "everyone knows that"<\p>
. the writing expects the Reader to be untouched to "figure it out"<\p>
. the writing makes jumps that your Reader cannot follow<\p>
. the writing makes the assumption that the Leg man has correct copy and remembered the undamaged document<\p>
Fix these places. Number one only takes a few words or sentences.<\p>
Everyone will be happier.<\p>















