How Bad In-house User Documents Price You Twice & What To Accomplish Approximately It
OVERVIEW
Abounding organizations make in-house tools or change commercially-available tools for their own employ. These tools should amuse documented so they are of employ to others in the group.
Provided this documentation is not created or is poorly written, it costs you twice:
* The aboriginal price (attributed to any bad user file) is the price of answering the Users’ questions (mechanical help).
* The moment price, arises from the absent age of your employees trying to accept the bad User File.
Psychological costs again act on both the alien and the in-house User.
THE Aboriginal Price: Mechanical Help
This is the price you incur whenever you make bad (or no) User Documents. It arises for any User when he/she needs mechanical help. For alien Users, the price is your mechanical help staff, toll-free phone lines, etc.
For internal Users the price is the age spent by the developer or modifier of the thing to reply the questions of his/her person employee. This is an expensive mechanical help price…these bodies are normally paid added than your mechanical help staff. Thus this aboriginal price is much better for bad in-house documentation than for shoddy documentation released to the general.
THE Moment Price: USERS’ Age AND Means
For Users out your corporation, the moment price is assumed by the Users themselves or their employers. These abashed Users are expending their corporation’s age: the age absent trying to receive the product to assignment, and the age spent dealing with your mechanical help.
For your in-house Users, this price is borne by your corporation. It is your employee–on your time– that is wasting your corporation means trying to employ an arcane product or file. Here is where your bad in-house documentation costs you twice.
PSYCHOLOGICAL COSTS Act on ALL READERS
Moreover to these age and money costs, there are the psychological costs wreaked by bad User Documentation.
For frustrated Users out your corporation, your bad documentation results in a abrogating insight of your corporation and its products. This may aftereffect in loss of matter.
For users inside your corporation, the psychological price is decreased employee morale, as evidenced from these imaginable statements:
* Our corporation produced this junk?
* These bodies are not a sharp as I idea they were.
* Provided other employees can make this confusing thing, then I can assignment at that identical akin.
Thus the ill will out your corporation can price you prospect sales; the ill will inside your corporation can price in decreased employee morale.
Idea: Casual REVIEWS
Once someone writes a User File for an in-house thing, that file should be informally reviewed.
SELF-REVIEW
The author can perform the aboriginal discussion on his/her own.
Employ your chat processor’s spelling checker to right general errors. You can employ the chat processor’s grammer checker, but most of these are inaccurate.
Before doing this discussion, let the file sit for a time or two. This will advice you forget what you meant in your unclear writing. When you accomplish the discussion and you acquisition yourself asking “what did I beggarly here?” you will accept begin a put in the file that needs revision.
When doing the discussion, visualize you are user of the thing and reader of the file. Visualize the tasks that the thing user wants to accomplish. Does the file enable the Reader to acquisition what he/she needs? Is the writing accurate (right describes the thing), bright, and all? Accomplish the changes that would advance the file.
Alien Discussion
Then, provided imaginable, employ an alien reviewer (inside your corporation). To accomplish this, the writer should:
1. Acquisition a possible User of the thing. This should be someone who is not already known with the thing, and as agnate to the object audience of the thing as just.
2. Accept that reviewer employ the file to adviser him/her in employ of the thing. Ask comments on the file. Notice the suggested changes, additions, deletions, clarifications requested by the reviewer. Some questions to buzz might comprehend:
* Does the file impart you what you charge to understand?
* Is it accessible to acquisition what you charge in the file?
* Does the file return your questions? Provided not, what questions are unanswered?
* Is the file accessible to chase? Provided not, where are the botheration areas?
3. The writer should accomplish changes as needed.
Provided you cannot perform this “semiformal” discussion, then amuse anyone other than yourself to simply glance at the file, and accomplish suggestions for improvement.
CAUTION
Accomplish certain that the discussion action does not alter to an inhibition to those writing User Documentation for in-house Users. Stress a cooperative — not adversarial — mechanism whose aftereffect is affection assignment. Accomplish not best shot to actualize the complete User File.