Benefits Of Creating Person Documents In-House
- Posted by Essays Blog in Essays Blog |
- November 11th, 2008 |
- Comments
OVERVIEW
For bantam companies, creating their product’s Person Documentation in-house, provides benefits to the company, to (idle) body, and to the product. This article describes the benefits and any downsides of producing Person Documents in-house.
III OPTIONS
If you have no in-house writing body you have III options:
1. No Person Document for the product. This is NOT a binding option. Every product needs Person Documentation. It completes your product package, and enhances the Person’s experience with your product. Here are cardinal examples of non-existent Person Documentation:
* Tomatoes. Most people don’t know that before consume, tomatoes should not be refrigerated. Refrigerating tomatoes before consume will reduce their flavor and nutrition duration.
* A Manual Can Opener. This can opener clamps on the can, thusly the person does not have to attempt the handles piece operating the can opener. It came with no Person Documentation, as “everyone could probably figure out how to consume it.” This is wrong. After a few uses, the blades become somewhat dulled, and the handles are real difficult to clamp and lock.
The simple advise of movement the knob piece compression the handles makes the can opener easy to consume. That advise could form the basis of a Person Manual for the product. The manual should include instructions for care of the can opener. Absurd situation is that this clamp feature was the single aspect of the product; but the feature becomes unserviceable because of no Person Document.
How have you felt about products that came without Person Documentation? Were you confused about the product and getting the most from it? Person Documentation adds to the duration of the product. Let’s look at how we can get it created.
2. Consume an outside writing service or consultant. Abstract writers may be an excellent choice to create your Person Documentation. However, thither may be downsides to exploitation them.
* When documentation changes have to be made, the company has to re-hire the writer. If the writer were inaccessible, so you have to act or examine for a new writer. When the new writer gets hired, a new orientation to the company and the project would have to start. Delays, delays, delays.
* An even more horrible cerebration is that the outside writer old any fancy piece of code to create the Person Document, and you do not own that code. Thusly you could not make any changes until you bought and learned that code, or hired an outside writer who uses the same code. (Most abstract writers are enamored with a particular piece of esoteric writing code.)
Exploitation the outside writer will force you to batch your documentation changes, making the literature out of date. (How many times have you seen product documentation that does not match the product? This happens because the company was inactivity for the next major advance to update the Person Documentation.)
3. Exploitation idle employees in your company to create the Person Documentation. The remainder of this article will focus on this option.
STAFFING BENEFITS
In most organizations, thither is any body down-time. By assigning these body to create Person Documents you benefit from effective consume of this down-time, and the employees benefit from experience in a new field.
These staffing benefits include:
* Consume body who may be idle between projects
* Your body know the company’s culture and their fellow body
* Your body consume existing company-wide writing tools (your morpheme processor)
* No time needed to get oriented with the physical aspects of the job
* You have created a new resource inside company
BENEFITS TO YOUR Person DOCUMENTS
If you have in-house writers (even if they are not formally trained as “abstract writers”) you can just have “Sue, could you or Tomcat update the document where the sign-in pane is presented.” Much faster and more flexible so having to go to an outside author. Sue and Tomcat have ownership of the document, and would activity to improve it. They would consume code resources available in your organization.
The benefits of in-house writers to your Person Documents include:
* You can make corrections as you find the errors.
* You are able to update your Person Document when you update your product.
* Better control of timing and resources
* No fear in dealing with the Person Document in electronic form. From your morpheme processor or add-ins, you can publish your Person Document as a portable data format (.pdf) file, or as HTML for display on the Internet.
DOWNSIDES OF IN-HOUSE WRITING
The primary downsides of in-house Person Document creation are the attitude and emotions of your newly-appointed writer. These include:
* Fear (”I don’t know how to compose”)
* Anger (”Why me? This is cheating”)
* Incertitude (”I don’t know what to compose”)
* Isolation (”I’ve been cast into this writing abstraction”)
You can reduce these negative emotions if you encourage and activity your New Writer.
Activity YOUR NEW WRITERS
It is cheating to assign a non-writer to create a Person Document without activity him/her. You have to activity your writer with:
* Training;
* Access to the development and marketing teams for product information;
* Consume of the development group to evaluate their writing (bantam chunks);
* Access to the product, industry literature, and marketing materials;
* Communication manual;
* Editor — your writing expert;
* Time to do a good job.
Other articles in this broadcast (accompany the links in the “Resources” or “About the Author” area of this article) present more information about activity your New Writer.