How to write a user manual

No matter how brilliant the inventor, programmer, innovator, and sometimes his creations impossible to use as intended. The reason is an incorrectly-written manual or its absence. But even the brilliant inventors sometimes write such instructions, except for specialists none of these papers can not be read. So how to properly prepare such a document necessary?

You will need

• - wide knowledge of equipment or software for which is written the user;
• - knowledge in the field of linguistics;
• - the skills of creative writing.

Instruction

1. Guide user or in other words, a user manual, a document designed to provide assistance in the use of some system of its user. For the compilation of manual user you need to know this system a hundred percent, but look at her eyes do not know anything about student. Assume that the user user is written for a certain software utility, which is unique not yet exist. Imagine that you are facing this program for the first time. Where to begin? What you need to know in the first place? Systematize this knowledge by breaking them into categories of importance.
2. Smashing all the information relating to your creation for the group, you made a plan for writing manuals user. Start to describe your program with the basics, leaving finally the most complex details, for example, reprogramming capability, or work with a critical error. At this stage you should have finished the contents of the manual user is one of the mandatory parts of this document.
3. If your guide is intended for use in a large company, you should pay attention to adopted corporate standards. For example, in many companies the management user will not be accepted without illustrative support, in other words, the pictures, explaining it is written. In the manual user in addition to the content must be additional required parts:- abstract, that is, the clarification of General task leadership, and described the product;- the introduction, which explains associated with the management of user documents and how to use the manual;- sections explaining the usage of product at different stages of its use, for example, first steps, repair or prevention;- the section of frequently asked questions and answers; Glossary or index.
4. Usually the creation of manuals user deals with the technical writer – a man with all of the necessary knowledge in the language and in the described product. When work technical writer without proper training, you need to keep several rules in mind. First, you can not abuse the special terms that are not understandable for the average user. Second, each term used should be detailed and explained. Thirdly, you need to write most clearly and concisely. Finally, a technical writer needs to be able to look at your own text with the eyes of an ordinary userto see the shortcomings of their own text.
5. The text of the guide user a good experience in fact, offering it to the man, who had the case with the described product. Joint efforts it is possible to correct all the mistakes and pitfalls of the document.