Every system will have a specific user interface which will needs to be used in order to interact with it. The user will, in most circumstances, require training in order to use the system. Additional to that there will be a user guide or manual in order to act as a reference for users. It will also be used for new users who come to use the system some time after its initial launch (as they may not receive training).

The user documentation should be very carefully targeted towards the correct audience. If the audience is novice users then the documentation should be very straight forward and avoid technical terms. It should act as a complete reference for all features in the system. The user should be able to find out how to perform any task in this document.

The main sections of user documentation are -

  • Frequently asked questions (FAQ's) detailing common questions and problems.
  • Step by step guides or tutorials for every feature of the system.
  • Installation / set up guide for getting users started.