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. Technical communication is the process of developing information products to convey complex information to an intended audience. ... A document contains information. ... A technical writer creates documentation for a field or technology. ...

User guides are most commonly associated with electronic goods, computer hardware and software. Computer hardware is the physical part of a |computer]], including the digital circuitas distinguished from the computer software that executes within the hardware. ... A screenshot of computer software running in Windows XP. Software is a program that enables a computer to perform a specific task, as opposed to the physical components of the system (hardware). ...

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. A screenshot of this page being displayed in the Mozilla web browser. ... Sample flowchart diagram A diagram is a simplified and structured visual representation of concepts, ideas, constructions, relations, statistical data, anatomy etc used in all aspects of human activities to visualize and clarify the topic. ... An audience is a group of people who participate in and experience or encounter a work of art, literature, theatre, music or academics in any medium. ... To meet Wikipedias quality standards, this article or section may require cleanup. ...

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

FAQ is an abbreviation for Frequently Asked Question(s). The term refers to listed questions and answers, all supposed to be frequently asked in some context, and pertaining to a particular topic. ... A glossary is a list of terms with the definitions for those terms. ... An index is a detailed list, usually arranged alphabetically, of the specific information in a publication, whether a book, periodical, database or multimedia collection. ...

Car and owner´s manual

See also

• Owner´s manual This page links here and is a redirect with possibilities . You can help by eliminating the redirect command and expanding the redirecting page.

• Release notes

A user guide, also commonly known as a manual, is a technical communication document intended to give assistance to people using a particular system. ... Image File history File links Redirect_arrow_without_text. ... Look up Page in Wiktionary, the free dictionary Page may mean: In graphic design, typography, or printing: Page header, typography Page footer, typography Page (paper), a leaf or one side of a leaf, as of a book An apprentice, assistant or errand boy: Page (servant), a servant or knights... For general info and coordination guidelines for all Wikimedia projects, on creating redirects see Help:Redirect. ... Expansion can have several meanings, including: In physics: Expansion of space, thermal expansion In computer hardware: an Expansion card In computer programming: In-line expansion In computer gaming: an expansion pack In mathematics: polynomial expansion or the expansion of a graph An expansion team in sports. ... Release notes are a document (usually printed) that is distributed with software products, often when the product is still a development or test state (e. ...

External links

• Online User Guides Tutorial at Klariti.com
• A Visual Guide To Documentation (User-Guide) Design and Layout