Home >

Writing rules: Cable plans

Identifying and documenting cables

Several of our product installation and maintenance manuals are provided with a dedicated chapter to explain the cabling. Each cable between system units and from the system to peripheral units or systems is identified and explained, and – if necessary – relevant procedures are included.

To maintain consistency, we need to define a set of rules related to cable documentation. This is especially important for “full picture” deliveries, in which several standard products are collected and sold to specific vessels as a package.

Note that these rules only apply to relevant standard products.

For more information about the relevant cabling chapter, see Cable layout and interconnections.

Cable plans

  1. The product cabling for the product shall be visualized in a cable plan (drawing).
  2. All cable plans shall identify each product cable with a number Cx , where x is an integer starting with cable number 1.
  3. If parallel cables are used several places in the system– for example for two displays, dual Ethernet lines or identical serial lines – cables may be identified with CxA, CxB etc.
  4. In order to offer future expansions, or for other reasons, a few Cx numbers may be left unused.
  5. Whenever required, specific sockets or connectors on the physical system units shall be identified with the characters “A”, “B”, “C” etc. These identifiers must be shown on illustrations or photos in the relevant descriptions and/or procedure(s).
  6. The cable plan drawing may include call-out labels to identify units and/or specific cables. The appurtenant list with call-out explanations must be placed immediately below the drawing.

Example:

Cable plan example

All cables identified with an asterisk (*) are provided with the product.

  1. Transceiver Unit with heat exchanger
  2. Uninterrupted power supply
  3. Motor Control Unit
  4. Hull unit
  5. Transducer
  6. High voltage 3–phase power
  7. Ethernet to Processor Unit on the bridge
  8. Ethernet to Motor Control Unit for hull unit control
  9. Transducer cable

Cable lists

  1. Each cable plan drawing (or a set of drawings for large products) shall have a dedicated list of cables.
  2. The list refers to the cable plan drawing(s) using the cable numbers Cx.
  3. The name of each cable is always a combination of product name and cable number, as follows: [product name]/Cx (Example: SX90/C15)
  4. Cable numbers that are not used shall be included and identified in the list with the text “Not used”.
  5. Each cable in the cable list shall be provided with the following information:
    • Cable name with connections from/to system units
    • Description
    • Reference to cable drawing (if applicable)
    • Reference to cable procedure (if applicable)
    • Order number (if the cable is provided by Kongsberg Maritime, and/or provided as a spare part)

Cable drawings

The purpose of the cable drawings is to provide information related to installation and maintenance.

  1. Each cable drawing shall contain the terminations on each end of the cable.
  2. Each drawing shall attempt – as far as possible – to be generic. Product specific information shall be provided in the XML element using relevant profiles.
  3. Each cable drawing shall have a number CDCxxx where x is an integer starting with cable number 1.
  4. Each drawing must be made according to the relevant specifications to avoid personal “voice”.
  5. Cables that are manufactured by ourselves or third party providers, or that are included as a spare parts, may not need to be used in the cable documentation. In such cases, refer to the cable by its part number.
  6. Standard computer cables (display, mouse, keyboard etc) may not need to be used in the cable documentation.

Example:

Cable drawing example

Cable procedures

Dedicated cable procedures are not mandatory, but may provide useful information to installation personnel that are not familiar with the product (typically dealers or distributors).


Writing rules

Related topics

Standards for writing and grammar rules

  • Microsoft Style Guide, 4th Edition, Microsoft Press, Washington, 2012, ISBN 978-0-7356-4871-5
  • Chicago manual of Style, 16th Edition, University of Chicago Press, Chicago, 2012, ISBN 978-0-226-10420-1

Topics