Benefits Of Creating User Documents In-House
OVERVIEW
For baby companies, creating their product’s User Documentation in-house, provides benefits to the corporation, to (lazy) staff, and to the product. This article describes the benefits and some downsides of producing User Documents in-house.
THREE OPTIONS
Provided you accept no in-house writing staff you accept three options:
1. No User File for the product. This is NOT a real choice. Every product needs User Documentation. It completes your product parcel, and enhances the User’s familiarity with your product. Here are two examples of non-existent User Documentation:
* Tomatoes. Most bodies don’t understand that before employ, tomatoes should not be refrigerated. Refrigerating tomatoes before employ will cut their flavour and nutrition amount.
* A Book Can Opener. This can opener clamps on the can, thus the user does not accept to squeeze the handles while operating the can opener. It came with no User Documentation, as “everyone could probably figure outside how to employ it.” This is amiss. After a hardly any uses, the blades alter to slightly dulled, and the handles are too hard to clamp and lock.
The child’s play gratuity of turning the handle while squeezing the handles makes the can opener accessible to employ. That gratuity could anatomy the reason of a User Book for the product. The book should comprehend directions for affliction of the can opener. The absurd bearings is that this clamp fact was the different angle of the product; however the fact becomes unusable as of no User File.
How accept you felt approximately products that came without User Documentation? Were you abashed approximately the product and getting the most from it? User Documentation adds to the amount of the product. Let’s attending at how we can amuse it created.
2. Employ an out writing supply or consultant. Mechanical writers may be an accomplished choice to actualize your User Documentation. But, there may be downsides to using them.
* When documentation changes accept to be fabricated, the corporation has to re-hire the writer. Provided the writer were unavailable, then you accept to wait or search for a fresh writer. When the fresh writer gets hired, a fresh orientation to the corporation and the project would accept to begin. Delays, delays, delays.
* An much added abhorrent idea is that the out writer used some fancy lot of software to actualize the User File, and you accomplish not own that software. Thus you could not accomplish any changes until you bought and learned that software, or hired an out writer who uses the identical software. (Most mechanical writers are enamoured with a specific lot of esoteric writing software.)
Using the out writer will arm you to batch your documentation changes, manufacture the literature old. (How abounding times accept you seen product documentation that does not match the product? This happens as the corporation was waiting for the abutting above upgrade to amend the User Documentation.)
3. Using lazy employees in your corporation to actualize the User Documentation. The the rest of this article will bull’s eye on this choice.
STAFFING BENEFITS
In most organizations, there is some staff down-time. By assigning these staff to actualize User Documents you help from able employ of this down-time, and the employees help from familiarity in a fresh world.
These staffing benefits comprehend:
* Employ staff who may be lazy between projects
* Your staff understand the corporation’s culture and their person staff
* Your staff employ existing company-wide writing tools (your chat processor)
* No age needed to receive oriented with the physical aspects of the activity
* You accept created a fresh resource within corporation
BENEFITS TO YOUR USER DOCUMENTS
Provided you accept in-house writers (much provided they are not formally trained as “mechanical writers”) you can aloof affirm “Sue, could you or Tom amend the file where the sign-in window is presented.” Even faster and added flexible then having to activity to an out source. Sue and Tom accept ownership of the file, and would assignment to advance it. They would employ software means available in your group.
The benefits of in-house writers to your User Documents comprehend:
* You can accomplish corrections as you acquisition the errors.
* You are able to amend your User File when you amend your product.
* Bigger ascendancy of timing and means
* No abhorrence in dealing with the User File in electronic anatomy. From your chat processor or add-ins, you can post your User File as a portable information format (.pdf) document, or as HTML for affectation on the Internet.
DOWNSIDES OF IN-HOUSE WRITING
The important downsides of in-house User File creation are the mind and emotions of your newly-appointed writer. These comprehend:
* Abhorrence (”I don’t understand how to address”)
* Acrimony (”Why me? This is arbitrary”)
* Uncertainty (”I don’t understand what to address”)
* Isolation (”I’ve been throw into this writing object”)
You can cut these abrogating emotions provided you animate and help your Fresh Writer.
Help YOUR Fresh WRITERS
It is arbitrary to post a non-writer to actualize a User File without supporting him/her. You accept to help your writer with:
* Experience;
* Access to the process and marketing teams for product advice;
* Employ of the process aggregation to assess their writing (baby chunks);
* Access to the product, industry literature, and marketing materials;
* Style book;
* Editor — your writing expert;
* Age to accomplish a acceptable activity.
Other articles in this series (look the links in the “Means” or “Approximately the Author” cut of this article) show added advice approximately supporting your Fresh Writer.