Section 6 User's Manual

6.1 A user's manual is to be provided for the program and submitted at the General Approval stage for review.

6.2 A general description of the program should be included in the manual together with a list of all terms, definitions, error messages and warnings likely to be encountered by the user. In the case of error messages and warnings, there should be unambiguous user instructions for subsequent action to be taken in each case.

6.3 The user's manual is to be accompanied, if necessary, by a translation in the English language. The ship's copy of the manual must be in English in addition to a language readily understood by the user if this is not English. The manual should be worded in a concise and unambiguous manner and the use of flow charts, diagrams and well-illustrated examples is recommended.

6.4 The documentation should be prepared such that it will be able to contain full information for each specific ship and include at least the following:

• General Particulars (see Table 1.7.2 General Particulars Form);

• Copy of the “Certificate of Approval”;

• Lightship weight and co-ordinates of its centre of gravity;

• Full deadweight description of each test condition;

• A list of the maximum and/or minimum permissible still water shear force and bending moment limits assigned by Clasification Society in addition to the permissible cargo torque and bulkhead shear force correction factors, where appropriate;

• Details of the permanently stored test conditions, limiting KG/GM curves and/or damage stability cases as appropriate;

• An example of a non-standard calculation supported by illustrations and sample computer output;

• Example print-outs of the most common screen displays, complete with explanatory text, to ensure that the user does not encounter any unfamiliar output;

• Details of the frequency of testing of the program;

• Statement appertaining to the vessel’s minimum draught forward (see Table 1.7.3 Statement For Minimum Draught Forward);

6.5 A record of amendments identifying the nature of the revisions made to the program should be included in the manual.