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

Document structure - Maintenance manual

Purpose of manual

The purpose of a maintenance manual is to provide the end user with the required knowledge to:

  • Recognise the product's main components
  • Know the main operational features
  • Recognise technical specifications and interface requirements
  • Recognise the theory of operation
  • Recognise how the various parts of the product work together
  • Do preventive and corrective maintenance up to the defined maintenance level
  • Replace the line replaceable items defined for the maintenance level
  • Recognize the spare parts available

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 maintenance manual is primarily intended for maintenance technicians and engineers.

Organization

Based on the NS5820, Form 5008 and IEC 62079 standards, this is the standard structure of an maintenance 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. Functional description
    • Functional block diagram(s)
    • Theory of operation
  4. Technical specifications
  5. Troubleshooting procedures
  6. Preventive maintenance procedures
  7. Corrective maintenance procedures
    • Software procedures
    • Alignment procedures
    • Test procedures
    • Other procedures
  8. Parts replacement procedures
  9. Unit descriptions (technical description of each main unit)
  10. Software applications (descriptions of software applications for operation and test – if applicable)
  11. Cable layout and interconnections
  12. Interfacing peripheral equipment
  13. Messages
  14. Illustrated spare parts catalogue
  15. Telegram formats (if applicable)
  16. Drawing file

Appendices to be included whenever applicable:

  1. General safety rules
  2. Equipment handling
  3. Basic cable requirements
  4. References

Topics

Back to