5 Part 5: V-Modell Reference Work Products

5.3 Products

5.3.11 Logistic Elements

5.3.11.3 Maintenance Documentation

Process module: Integrated Logistic Support

Responsible: Technical Author (when using process module Integrated Logistic Support)

Activity: Preparing Maintenance Documentation

Participating: Hardware Architect, Hardware Developer, QA Manager, Software Architect, Software Developer, System Architect

Purpose

The »Maintenance Documentation describes all measures required in order to ensure and maintain the functional capability of the system. Maintenance is scheduled and executed at certain intervals, in case of a vehicle, for example, annually or every 15,000 km. The maintenance documentation is intended for persons planning and executing the maintenance procedures.

Is generated by

Logistic Support Concept (see product dependency 4.11)

5.3.11.3.1 Maintenance Plan

The »Maintenance Plan describes the individual maintenance measures and their schedule. The maintenance measures may be summarized in maintenance levels. Maintenance procedures may be executed during operation or if the operation is interrupted.

The maintenance plan may also include the equipment maintenance record if an individual maintenance plan exists for every system. If this is not the case, the equipment maintenance record shall be conducted in suitable form, e.g., as service manual, maintenance manual or material history report.

Exemplary Product Content

A maintenance plan may include the following:

• Warning statements and notes of caution
• Serial number
• System element or test location of the measure, possibly with item number of the spare parts catalog
• Standard/special tools, measuring and test equipment
• Procedure to be executed
• Statement on admissible wear-and-tear parts, operating fluids and tolerances
• Work schedule, depending on operating parameters (e.g., hours, time, number and type of use)

5.3.11.3.2 Maintenance Instructions

The »Maintenance Instructions describes the execution of the different maintenance measures in repeatable procedural steps. The maintenance instruction will only be prepared for measures which require additional explanations not included in the »Maintenance Plan. The disposal of wear-and-tear parts and operating fluids must be considered. The use of measuring and test equipment and necessary tools will be explained.

Exemplary Product Content

The maintenance instruction may include, but not be limited to, the following:

• Warning statements and notes of caution
• Cleaning of the system
• Standard/special tools, measuring and test equipment
• Replacement of wear-and-tear parts and operating fluids
• Monitoring of operating parameters