4 Training and documentation
Clasification Society 2024 - Version 9.40
Statutory Documents - IMO Publications and Documents - Circulars - Maritime Safety Committee - MSC/Circular.891 – Guidelines for the On-Board Use and Application of Computers – (Adopted on 21 December 1998) - Annex - Guidelines for the On-Board Use and Application of Computers - Appendix - Guidelines for Shipboard Loading and Stability Computer Programs - 4 Training and documentation

4 Training and documentation

  4.1 User training. Training/tutorial material should be provided, as appropriate, for the sophistication of the program. This may range from formal classroom sessions to tutorial videotapes and/or self-study lesson plans.

  4.2 Documentation. The software should be accompanied by a user's manual and a programmer's manual.

  • 4.2.1 The user's manual should be written for the direct user (ship's officers) and should include the following elements:

    • .1 Identification: the manual should have a unique identification number that matches an on-screen ID number in the program. It should also clearly identify the stability booklet from which the lightship data is taken.

    • .2 System requirements: identifies computer system hardware and software requirements such as compatible computers, operating system, memory requirements and other special requirements, such as video graphics, mouse, printer, etc.

    • .3 File management: a list of all relevant software files, giving name, size, date and a brief description of each. The manual should also explain how any user-generated files, such as saved loading conditions, are named. These measures should allow the user to review the disk directory and verify that the correct current files are present.

    • .4 Instructions: a clear explanation of how to install, use, and troubleshoot the program. The instructions should be user-friendly, recognizing that the user is a ship officer.

    • .5 Information sources: a list of all ship-specific plans, drawings, tables, other documents, etc., which provided information used in the program. In most cases, this information will probably come from the ship's approved stability booklet; however, other sources should be clearly identified. Ideally, all such information sources should themselves be annotated to the effect that they were used in developing the program (so that future revisions to the drawing will also prompt a review of the program).

  • 4.2.2 The programmer's manual is not expected to be furnished to the ship; it is for use by select persons familiar with programming (but who may not necessarily be the original program writers) when it becomes necessary to revise the program as a consequence of changes to the ship. The programmer's manual should carefully document the program's workings, and include a flowchart and an annotated program listing. This manual should explain how to edit the program, especially to revise ship-specific data (lightship data, hydrostatic characteristics, weight and moment data, tank capacities, etc.).

  4.3 Program and documentation control: A careful procedure should be established so that revisions to the program are properly tracked and forwarded to the ship. Each revision delivered to the ship should include change pages to the user's manual and instructions on how to delete obsolete files and install replacement (revised) files. The process should include an "action complete" report back to shoreside management.

Parent topic: Appendix - Guidelines for Shipboard Loading and Stability Computer Programs
Copyright 2022 Clasifications Register Group Limited, International Maritime Organization, International Labour Organization or Maritime and Coastguard Agency. All rights reserved. Clasifications Register Group Limited, its affiliates and subsidiaries and their respective officers, employees or agents are, individually and collectively, referred to in this clause as 'Clasifications Register'. Clasifications Register assumes no responsibility and shall not be liable to any person for any loss, damage or expense caused by reliance on the information or advice in this document or howsoever provided, unless that person has signed a contract with the relevant Clasifications Register entity for the provision of this information or advice and in that case any responsibility or liability is exclusively on the terms and conditions set out in that contract.