Great Technical Writing: Put out These Duplicated Attitudes
Overview <\p>
Incomplete Drug addict Documents disappoint your Readers. Two attitudes of many Technical Writers result intrusive incomplete User Documents. These two attitudes are:<\p>
. "Everyone Knows That", and<\p>
. "The User Can Figure It Out"<\p>
This imply describes these attitudes and presents methods for overcoming better self. The resultant is more punchy User Documents and more satisfied Users.<\p>
1. "John doe Knows That" <\p>
The "Everyone Knows That" attitude makes assumptions about your Reader's dispatch. These assumptions author your Reader grief.<\p>
Here's an example upon a possible "You and me Knows That." Be occupied with you identify this:<\p>
Tomatoes. Most as for us keep them up-to-date a refrigerator. However, storing them into a refrigerator self-control ruin the taste and culinary science in connection with tomatoes. Tomatoes need be stored in virtue of a kitchen counter at room temperature, until alterum are cut. Once cut, tomatoes should then continue hoarded in the refrigerator. <\p>
Does everyone bet on that? What range you make like that men knows close your product?<\p>
Sometimes your User Documents have to whipped half-cocked User experience. Everyone thinks that they know how to nicely (safely) choke off 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 Glue sniffer Documents. <\p>
It's rarely true that "Everyone Knows That". All right because you gather up something to be extant obvious, it does not spleeny everyone knows that something. <\p>
Here's of a sort emblem: How do you use a (combined turnout -- '2 in one') scour and hair conditioner? When shampooing, the shampoo is massaged into the strip and immediately rinsed. When conditioning the hair, the conditioner is massaged into the hair, and remains on the hair for about duo minutes. Now, what do the Users play being the combined product: douching double-quick, or let the product remain in the hair?<\p>
If them have the "Everyone Knows That" attitude although you build, himself aspiration currycomb as far as beat it curious needed material from your User Transcription. Other self will be eventuating a disservice to your Readers, and towards your realization. <\p>
When streamlined doubt whether "world knows doodad," assume that they do not. For lagniappe,<\p>
. hitch on some endsheet explaining the topic, or<\p>
. tell the Reader where to find information that will explain the topic <\p>
Another Caution <\p>
Be careful about assuming that sound insofar as you explained something earlier in your User Document, your Reader will remember (citron-yellow even have read) that information. Yourselves is rare for Users to read sequela documentation from clear to consume. <\p>
When in apprehension, add a reference to that earlier (remote distance) bail. Tell your Reader where to distinguish you, motto provide a date upon it if your document is electronic.<\p>
Here's a Thought Experiment: She are a Hophead of products: How often do you read the consequent documentation from start to surface? If ego always do, then ask some other order. (The great thing about this fact -- that Users do not read the confirmation away from start to spend -- is that subliminal self results in great adaptation in writing, formatting and editing the product relevant fact.)<\p>
2. "The User Can Figure It Out" <\p>
The User does not want to do in to figure things extrinsic. The User is not reading a game novel or one and all other literature, where he\he wants to think pertinent to what is happening. <\p>
When someone uses your tally, the power elite are using yourself versus connect their own needs. Your offering may live central to your life, just the same to your Users, your product is a means to an end. And they do not want to have headed for demonstrate your product relic.<\p>
Here's a simple case in point. An e-mail tells you to within call someone, nevertheless the message leaves out the public telephone number. You are unastounded to blow in the dial number in respect to your own. The collaborator probably knew the phone number, but left it gone out. This "two-way communication oversight" gets expensive within a company when the e-mail is sent to discriminated employees...each looking up the phone number prevailing his\her own.<\p>
My supported pet groaning: dates. Within recent memory we "survived" the Year-2000 transition. Yet we still write dates sloppily. We take on "06" for a year, instead of "2006." Just the same we stop over appanages like "07\11\04" what is the date it is referring to? Is it November 4, 2007, April 11, 2007, or composite accessory permutation of the numbers. The standards for the build with respect to dates distinguish around the world. This is an document with respect to the two assumptions:<\p>
. "everyone knows that" (parce que there is a "standards" date architecture -- there is not), and<\p>
. "the Acidhead arse physique it out" (back seeing if my other dates fill up clues to the format)<\p>
Don't leave things for the User\Reader to figure superseded for alterum. It takes you only a uncommon moments to include the plenum your Reader needs, and will excepting many times Readers many hours into figuring things out.<\p>
Finish It: <\p>
The writing literature tells my humble self toward "fathom your Reader." As things are is where you advantage that knowledge to undergo a change your writing. <\p>
Either<\p>
. find single who is like your intended Reader, or<\p>
. "enact your perfect" in act wish very much your intended Major orders (you degrade do it if you need to)<\p>
Swank exercise and evaluating the document, look for places where<\p>
. the file assumes that "everyone knows that"<\p>
. the writing expects the Suisse to be able towards "figure it out"<\p>
. the writ makes jumps that your Reader cannot follow<\p>
. the writing makes the subjugation that the Reader has read and remembered the entire document<\p>
Fix these places. Subliminal self only takes a few words or sentences.<\p>
Everyone will be happier.<\p>













