User Manual

A document or website that explains the function of the application to the end user
User Manual

How does it work?

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.

The use manual may contain

  • The conceptual background of the application: purpose, ideas
  • A glossary: definitions of terms
  • A guide how to use all functions of the system
  • A troubleshooting section
  • Search functionality

When should you use it?

  • Every application intented for other users than yourself should have a user manual. If it doesn't, some users simply won't understand your application and will not use it. It will also benefit you as a developer as it encourages users to use the application in the way you intended.