8.2.10.2 Information for the Diagnosis Manual



		8.2.10.2 Information for the Diagnosis Manual (DiagMa)

Informationen zum Diagnosehandbuch

Contents
Introduction
Document Index
Document Structure

Contents		Introduction Document Index Document Structure

Introduction

The Information for the Diagnosis Manual supplies the information required for the SWMM and diagnosis activities with respect to the System. The function of the System and the diagnosis environment are described, thereupon each individual diagnosis feature and error message is referred to.

Document Index

1. General Information
2. Function of the System to be Maintained
3. Diagnosis Environment
3.1. Required Software Tools
3.2. Required Computers and Devices
3.3. Other Equipment and Tools
3.4. Provisioning the Environment
3.5. Operation of the Environment
4. Diagnosis
4.1. Diagnostic Possibilities
4.2. Diagnosis Tools
4.2.t. Tool (t)
4.3. Errors during Operation
4.3.e. Error Message (e)
4.4. Reference to the User Manual
5. Other General Information

Document Structure

1. General Information

See schema 1. General Information.

2. Function of the System to be Maintained

The overall function is described with regard to SWMM tasks. The descriptions from the development documents have to be used as a source.

3. Diagnosis Environment

3. 1. Required Software Tools

3. 2. Required Computers and Devices

3. 3. Other Equipment and Tools

3. 4. Provisioning the Environment

This describes how the named software tools, computers, devices, and equipment for the diagnosis environment have to be combined. While doing so, the interfaces to the System (or to parts thereof) must be considered. If necessary, references to the appropriate manuals have to be included.

3. 5. Operation of the Environment

Notes about the general operation of the environment (resources, data media, general handling of devices and tools, etc.) are given. This does not yet include the realization of the actual diagnosis activities.

4. Diagnosis

4. 1. Diagnostic Possibilities

The tools to be used to diagnose situations, errors and defects must be listed in a clearly defined way. It is also necessary to state when a diagnosis is not possible or when it would not be very successful.

4. 2. Diagnosis Tools

If a large number of diagnosis tools is available they have to be collected in the form of an overview.

4. 2. t. Tool (t)

The individual tools available (computers, testbench, software, etc.) are described on the basis of their application fields and goals.

Note: "t" is used for consecutive numbers of diagnosis tools from 4.2.1 to 4.2.n and as place holder for the tool identifier.

To realize a diagnosis, the following items have to be described:

tool operation and supply with input information like selection of tool functions/options

operating the object to be assessed, supply with required information, acceptance of output information, and registration of impacts on the environment

For the evaluation of the diagnosis, the following items have to be described:

set of possible diagnosis results and their evaluation

explanations and references to other assessment procedures, by taking into consideration the evaluation results

measures to remedy error or problem thus discovered

list of failures that may cause the deactivation of certain security functions

4. 3. Errors during Operation

In addition to the User Manual where error messages are described from the user's point of view and with regard to the assistance of a user, the diagnosis manual describes error messages in much greater detail and from maintenance aspects in order to better support the system operation.

4. 3. e. Error Message (e)

The exact wording of the error message or the warning/error signals to the operator have to be listed in the form of an overview.

Note: "e" is used for consecutive numbers of the error messages from 4.3.1 to 4.3.n and as place holder for the name of the error.

The following information must be listed for each error message:

Meaning and Context
This contains a detailed description of how the error occurred and which parts of the System (in the case of software particularly processes, SW Components, SW Modules, Databases) do not function correctly.

Remedial Measures
The required measures to remedy errors/problems comprise:
- correct operation of the System, device, software,
- correct supply with required information; correct operation of the interfaces,
- required system repair works.

4. 4. Reference to the User Manual

In the case of errors that usually result from operating errors, references should be made to the corresponding passages in the User Manual.

5. Other General Information

This is where further relevant information can be found. Particularly the information on how to handle and support off-the-shelf-products and how to process SWMM (in submodel CM) are very important.

GDPA Online Last Updated 01.Jan.2002 Updated by Webmaster Last Revised 01.Jan.2002 Revised by Webmaster