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

Document structure - Reference manual

Purpose of manual

The purpose of an reference 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
  • take full advantage of the functionality and parameters provided by menu system, tool bars, dialogs and other user interfaces
  • understand technical specifications and interface requirements

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 reference manual is primarily intended for expert users.

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

Organization

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

NOTE: 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. Presentation modes (if applicable)
  7. Menu system (if applicable)
  8. Functions and dialog boxes
  9. Preventive maintenance procedures
  10. Technical specifications
  11. Theory of operation (if applicable)
  12. Telegram formats (if applicable)
  13. Software installation (if applicable)
  14. Practical exercises (if applicable)
  15. References (if applicable)

Topics

Back to