Home> About us > Branding guidelines > Documents > User manuals >

Document structure - Operator manual

Purpose of manual

The purpose of an operator manual is to provide the end user with the required knowledge to:

  • recognise the product's main components
  • know the main operational features
  • use the basic functions of the product in a safe and efficient matter

Before writing can commence, you must know you target group: who will use the manual. If required, the knowledge and experience level of the expected reader may be defined in the chapter “About this manual”. However, it is generally recognized that the operator manual is primarily intended for non-expert or incidental users.

As a general rule, all the information in the operator manual is also found in the reference manual.

Some of the information in the operator manual is also used in the quick start guide.

Organization

Based on the NS5820, Form 5008 and IEC 62079 standards, this is the standard structure of an operator manual provided by Kongsberg Maritime AS.

In order to offer consistent documentation, the chapters in this manual must use the names listed. The book must also provide the chapters in the specified order.

  1. About this manual
  2. Introduction
  3. Getting started
  4. Operational procedures
  5. User interface and/or Display views and/or Operator panel
  6. Menu system

Optional chapters or appendices are:

  1. Theory of operation
  2. Technical specifications
  3. Practical exercises
  4. References

Topics

Back to