End User Guide | enduserguide.com

End User Guide - enduserguide.com

End User Guide	End User License Agreement	Documentation	Technical Writer	User Documentation	Software Documentation	End User Guide Resources

End User Guide

end user guide

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 written by a technical writer.

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.

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

The written text in the computer software

Software Documentation or Source Code Documentation is written text that accompanies computer software. It either explains how it operates or how to use it. In fact, the term software documentation means different things to different people. This article describes the term as used by the largest groups of users.

More >>>

Some images compliments of morguefile.com and phototakeout.com Text from wikipedia.org

Contents