5 Part 5: V-Modell Reference Work Products

5.3 Products

5.3.11 Logistic Elements

5.3.11.4 Repair Documentation

Process module: Integrated Logistic Support

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

Activity: Preparing Repair Documentation

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

Purpose

The »Repair Documentation describes all measures required for re-establishing the functional capability of the system. The repair documentation specifies how the cause for a system failure can be discovered and how the discovered malfunction can be repaired afterwards.

Is generated by

Logistic Support Concept (see product dependency 4.11)

5.3.11.4.1 Diagnosis Instructions

The »Diagnosis Instructions describes how the reasons for a system failure can be determined and analyzed. The use of the measuring and test equipment required for the diagnosis will be explained. In the most simple case, the diagnosis instruction is a list with error messages and the corresponding potential reasons. For complex systems, a diagnosis instruction can be supported by fault trees, decision trees and expert systems.

Exemplary Product Content

The diagnosis instruction may include, e.g., the following:

• Warning statements and notes of caution
• Diagnostic routines
• Standard/special tools to be used, measuring and test equipment

5.3.11.4.2 Repair Instructions

The »Repair Instructions describes the execution of individual repair procedures in repeatable steps. The use of the measuring and test equipment and required tools will be explained

Exemplary Product Content

The repair instruction may include, e.g., the following:

• Warning statements and notes of caution
• Standard/special tools to be used, measuring and test equipment
• Diagnostic procedures which were not described in the diagnosis instruction
• Repair procedures, i.e., replacement of defect parts or correction of damage
• Check as to whether the repair was successful (e.g. by a test run).