United Digital

USER MANUAL

                 


A user manual is a technical communication document intended to give assistance to people or real time users using a particular system. User guides are most commonly associated with all kinds of softwares.

Most user guides contain both a written guide and the associated images. In the case of computer applications, it is usual to include screenshots of the human-machine interfaces, and hardware manuals often include clear, simplified diagrams and flow charts. The language used is matched to the intended audience, with jargon kept to a minimum or explained thoroughly.


The sections of a user manual often include:

A cover page
A title page and copyright page
A preface, containing details of related documents and information on how to navigate the user guide
A contents page
A guide on how to use at least the main function of the system
A troubleshooting section detailing possible errors or problems that may occur, along with how to fix them
A FAQ (Frequently Asked Questions)
Where to find further help, and contact details
A glossary and, for larger documents, an index

© Copyright UNITED DIGITAL 2017. All Rights Reserved.