Home> About us > Branding guidelines > Documents > Manufacturing documents >

Document structure: Installation manual

Purpose of manual

The purpose of an installation manual is to provide the reader with the required knowledge to:

  • recognize the product’s main components
  • prepare the installation facilities and tools
  • do the required physical installation
  • do the required wiring (cables and connections)
  • power up, configure and test the product prior to operational use

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 installation manual is primarily intended for either the installation shipyard, or an authorized dealer with workshop facilities.

In some cases, the installation manual may contain information that is not found in the other manuals included with the product. In such cases, the installation manual is also intended as reference material for the maintenance personnel. It must then be clearly specified in the installation manual’s front matters that the manual must be kept for later use.

Organization

Based on the NS5820, Form 5008 and IEC 62079 standards, this is the standard structure of an installation 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. Preparations
  4. Installation procedures (*1)
  5. Cable layout and interconnections
  6. Interfacing peripheral equipment
  7. Setting to work
  8. Drawing file
  9. Technical specifications
  10. References (if applicable)

Appendices to be included whenever applicable:

  1. General safety rules
  2. General supply conditions
  3. Equipment handling
  4. Basic cabling requirements
  5. Telegram formats

(*1) Use one chapter for each physical unit.

Topics

Back to