User manuals – a document containing information about the design, principle of operation, characteristics (properties) of the product, its constituent parts and instructions necessary for the correct and safe operation of the product and assessments of its technical condition when determining the need to send the product for repair, as well as information on the disposal of the product or its component parts.
The software manual is a document of a normative and technical nature, which is a part of the package of documentation attached to all technically complex products.
The software user manual is an explanatory document, which is obliged to provide buyers with all the basic information on the use of goods, the document contains not only textual information, but also various types of diagrams, drawings, graphs and photographs that allow you to visually familiarize yourself with certain processes during the operation of the product.
It should be noted that in certain cases, the software user guide is required for the execution of certain permits.
Other names or other forms of a user manual are the following:
The first goal of the web-manual is to assist a user. The second goal is to expand the customer experience. The third goal is to take into account all legal requirements for the sale of the product. However, the main goal is to give answers for HOW TO and WHAT questions.
Writing a user manual is fraught with various kinds of difficulties, therefore, competent people with sufficient knowledge in the field of development of design documentation for goods and able to correctly and clearly state the main points in the process of use should be involved in its development.
First, the user requirements document should contain the step-by-step instructions and information which helps the user to understand the procedural information.
Therefore, the user’s manual should contain the following mandatory sections:
These sections of user manual for software application should contain the following information: