Are you an EPFL student looking for a semester project?
Work with us on data science and visualisation projects, and deploy your project as an app on top of Graph Search.
Concept
User guide
Summary
A user guide, also commonly known as a user manual, is intended to assist users in using a particular product, service or application. It's usually written by a technician, product developer, or a company's customer service staff.
Most user guides contain both a written guide and associated images. In the case of computer applications, it is usual to include screenshots of the human-machine interface(s), and hardware manuals often include clear, simplified diagrams. 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 Purpose section. This should be an overview rather than detail the objective of the document
An Audience section to explicitly state who is the intended audience who is required to read, including optionals
A Scope section is crucial as it also serves as a disclaimer, stating what is out-of-scope as well as what is covered
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
User guides have been found with ancient devices. One example is the Antikythera Mechanism, a 2,000 year old Greek analogue computer that was found off the coast of the Greek island Antikythera in the year 1900. On the cover of this device are passages of text which describe the features and operation of the mechanism.
As the software industry was developing, the question of how to best document software programs was undecided. This was a unique problem for software developers, since users often became frustrated with current help documents.
Official source
About this result
This page is automatically generated and may contain information that is not correct, complete, up-to-date, or relevant to your search query. The same applies to every other page on this website. Please make sure to verify the information with EPFL's official sources.