Main menu


How poor in house user documents cost you twice what to do about it

How poor in house user documents cost you twice what to do about it

How poor In-house consumer files cost You two times & What To Do approximately It

Technical writing, in-house documents


Many agencies produce in-house equipment or adjust commercially-to be had equipment for his or her own use. These tools need to get documented so they may be of use to others within the corporation.

If this documentation isn't created or is poorly written, it fees you two times:

* the primary fee (attributed to any negative consumer report) is the price of answering the users' questions (technical guide).

* the second price, arises from the lost time of your employees looking to apprehend the negative consumer file.

Mental prices also affect each the external and the in-residence consumer.

The primary fee: TECHNICAL assist

That is the cost you incur on every occasion you produce terrible (or no) consumer documents. It arises for any consumer when he/she desires technical guide. For outside users, the value is your technical aid personnel, toll-unfastened cellphone strains, and many others.

For internal users the fee is the time spent through the developer or modifier of the device to reply the questions of his/her fellow employee. That is an expensive technical help price...These people are usually paid more than your technical support workforce. Consequently this first value is even more for bad in-residence documentation than for shoddy documentation released to the public.

The second price: customers' TIME AND assets

For customers out of doors your business enterprise, the second price is thought via the customers themselves or their employers. These harassed customers are expending their organization's time: the time misplaced seeking to get the product to work, and the time spent managing your technical support.

To your in-residence customers, this value is borne through your enterprise. It is your employee--for your time-- this is wasting your agency resources looking to use an arcane product or file. Here is in which your poor in-residence documentation expenses you two times.

Psychological costs have an effect on ALL READERS

In addition to these time and financial charges, there are the mental costs wreaked by way of terrible person Documentation.

For pissed off customers outside your business enterprise, your negative documentation consequences in a poor notion of your business enterprise and its products. This can result in loss of commercial enterprise.

For users interior your employer, the mental value is decreased worker morale, as evidenced from these feasible statements:

* Our company produced this junk?

* those humans are not a pointy as I concept they had been.

* If other employees can produce this difficult stuff, then i'm able to work at that identical degree.

Therefore the unwell will outdoor your company can price you future income; the ill will internal your organisation can price in decreased employee morale.

Answer: informal opinions

As soon as someone writes a person document for an in-house device, that record have to be informally reviewed.


The author can carry out the primary assessment on his/her very own.

Use your phrase processor's spelling checker to accurate common mistakes. You can use the word processor's grammar checker, however most of these are inaccurate.

Earlier than doing this evaluate, permit the report take a seat for an afternoon or two. This may help you forget what you intended for your uncertain writing. While you do the evaluation and also you discover yourself asking "what did I mean here?" you may have observed an area in the report that wishes revision.

When doing the assessment, consider you're consumer of the device and reader of the file. Imagine the tasks that the tool person desires to do. Does the record allow the Reader to find what he/she wishes? Is the writing correct (successfully describes the device), clean, and whole? Make the changes that would improve the record.

External review

Then, if possible, use an external reviewer (internal your enterprise). To do that, the writer need to:

1. Discover a capability user of the device. This have to be a person who isn't already familiar with the device, and as much like the target market of the device as reasonable.

2. Have that reviewer use the document to guide him/her in use of the device. Solicit feedback at the file. Be aware the recommended modifications, additions, deletions, clarifications asked by means of the reviewer. Some questions to ask might consist of:

* Does the file tell you what you need to know?
* Is it clean to locate what you need within the file?
* Does the document solution your questions? If now not, what questions are unanswered?
* Is the document smooth to observe? If now not, in which are the hassle regions?

Three. The writer need to make modifications as necessary.

If you can't perform this "semiformal" review, then get anybody apart from your self to surely examine the record, and make hints for development.


Ensure that the evaluation manner does no longer turn out to be an inhibition to those writing user Documentation for in-house customers. Pressure a cooperative -- not adverse -- mechanism whose result is first-rate work. Do now not try to create the proper user report.