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

Standard end user manuals

The following basic manual types are defined by Kongsberg Maritime AS. All end user manuals must be identified with a standard manual title specified on this page, or a special end user manual title.

Quick start guide

This manual contains the basic instructions required to get started with the product. The book mainly provides operational principles and basic and uncomplicated operational procedures.

  • Target audience: New and casual users without expert skills.
  • Contents and structure: Quick start guide

Operator manual

This manual contains the basic instructions required to use the product safely and efficiently. The book mainly provides descriptions and operational procedures.

  • Target audience: Basic users without expert skills.
  • Contents and structure: Operator manual

Reference manual

This manual contains the detailed instructions required to use the product safely and efficiently. The book provides the same information as the operator manual, but it also includes reference information about dialogs, advanced functions, telegram formats etc.

Installation manual

This manual contains the information required to install the product and make sure that it is ready for safe and efficient use. The book provides technical descriptions and procedures, as well as relevant mechanical and electrical drawings.

  • Target audience: Naval architects and shipyard supervisors.
  • Contents and structure: Installation manual

Maintenance manual

This manual contains the instructions and descriptions required to carry out repairs to the defined maintenance level. The book provides technical descriptions, troubleshooting and replacement procedures, as well as an illustrated spare part catalogue. It will also provide relevant mechanical and electrical drawings, circuit board descriptions, and reference information about functionality provided for maintenance purposes.

  • Target audience: Maintenance personnel, typically skilled and experienced technicians and engineers.
  • Contents and structure: Maintenance manual

Instruction manual

On a small product, information about operation, installation and/or maintenance may be collected in a common book. It contains various instructions for use, maintenance or installation, or a combination of these topics.

Note that this manual type must be used with great care. Even on small products, the target readers may differ for the different types of information provided.

Topics

Back to