What is a User Guide?

Technical communication is the process of conveying information about technology to an intended audience.

A user guide, also commonly known as a manual, is a technical communication document intended to give assistance to people using a particular system. They are written by a technical writer.

User guides are most commonly associated with electronic goods, computer hardware and software.

User Guide Contents

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

Definitions of Technical Documentation?

"Technical writing is the presentation of information that helps the reader solve a particular problem. Technical communicators write, design, and/or edit proposals, manuals, web pages, lab reports, newsletters, and many other kinds of professional documents."

This article is licensed under the GNU Free Documentation License. It uses material from the Wikipedia article Technical Writing.

Your Thoughts?

What are your thoughts on this? Drop me a line at ivan at klariti dot com