5 Part 5: V-Modell Reference Work Products

5.3 Products

5.3.11 Logistic Elements

5.3.11.2 In-Service Documentation

Responsible: Technical Author (when using process module System Development)

Activity: Defining In-Service Documentation

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

Purpose

The »In-Service Documentation includes all data required by a user in order to operate the system properly and to respond adequately to problems. Type and number of in-service documents to be prepared correspond to the specifications of the Overall System Specification.

Is generated by

Overall System Specification (see product dependency 4.22)

Depends on

Logistic Support Concept, Training Documentation (see product dependency 5.24)

5.3.11.2.1 Warning Statements and Notes of Caution

The »Warning Statements and Notes of Caution describe the system features relevant for the safety of the user. They must be observed during the entire system life cycle from the activation to the »Disposal of the system. Warning statements and notes of caution shall be positioned at a prominent place - if possible at the beginning of the documentation - where they cannot be overlooked.

Exemplary Product Content

Warning statements and notes of caution may include, e.g., the following:

(in-) admissible environmental conditions,
(in-) admissible operating parameters,
(in-) admissible in-service variants,
protective measures before activation/shutdown/deactivation,
behavior in case of system malfunctions,
medical advice in case of personal injuries.

5.3.11.2.2 System Scope and Functionality

This subject describes the user-relevant features of the system. The user learns the relevant components and functions of the system by reading the description. The description includes, but is not limited to, the overall view of the system, a technical description and the technical data.

Exemplary Product Content

The description of scope and function of the system includes, e.g., the following:

Overall view
Designations, markings
Survey, architecture of the system
Technical description of system and system elements (purpose, principles of operation)
Technical data of system and system elements
Equipment, auxiliary equipment and interfaces

5.3.11.2.3 Installation and Operation

The instruction manual describes the proper use of the system. It describes the operations to be executed by the user.

Depending on the type of use, the instruction manual may include various aspects, like activation, administration, operation and error control. Depth and detailling of the description of operations depend on the knowledge of the expected user.

Exemplary Product Content

Depending on the type of use, the instruction manual may include the following subjects:

Installation, initial activation and reactivation
Hardware and software configuration
Administration and operation
Error control
Deactivation, preservation, packaging, transport and storage

5.3.11.2.4 Preventive Maintenance Instructions

Servicing includes all simple maintenance procedures which can be executed by the user without auxiliary tools, e.g., cleaning of the system, replacement of wear-and-tear parts and operating fluids, and monitoring of operational parameters.