A user guide, also commonly known as a manual, is a technical communication document intended to give assistance to people using a particular system. It is usually written by a technical writer, although user guides could be written by programmers, product or project managers, or other technical staff, particularly in smaller companies.
User guides are most commonly associated with electronic goods, computer hardware and software.
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 how the program should look, and hardware manuals often include clear, simplified diagrams. The language is written to match up with the intended audience with jargon kept to a minimum or explained thoroughly.
Contents
The usual sections of a user manual often include:
- A preface, containing details of related documents and information on how to best use the user guide
- A contents page
- A guide on how to use at least the main functions 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
Car and owner´s manual
This section needs expansion. You can help by adding to it. |
See also
External links
- Online User Guides Tutorial at Klariti.com
- A Visual Guide To Documentation (User-Guide) Design and Layout
- Locate hard to find user manuals
 | This computing article is a stub. You can help Wikipedia by expanding it. |
 | This automobile-related article is a stub. You can help Wikipedia by expanding it. |