188.8.131.52 Information for the User Manual (UMa)
Informationen zum Anwendungshandbuch
The Information for the User Manual includes all information required by the user of a System to operate the System properly and to be able to react appropriately when problems arise. This product must contain detailed descriptions about each individual function in order to meet the requirements of users with different skill levels.
1. General Information
2. User Functions
2.f. Function (f)
2.f.2. Instructions for Use and Operation
2.f.3. Error Handling
See schema 1. General Information.
This must contain an overview.
Note: "f" is used for consecutive numbers of user functions from 2.1 to 2.n and as place holder for the function identifier according to the conventions for identification defined in the CM Plan.
Based on a brief description, the task of the function is identified to fulfill the overall task.
The term "use" does not only refer to the operation by the staff (user interfaces), but also by other Systems, Segments, SW Units, or HW Units. The following steps must be well described:
The overall number of the possible error situations that might occur while function execution has to be described; the following items must be more closely documented:
This includes measures for the preparation of the operation (necessary equipment, turning on, system preparations, supply with initial information, etc.).
This includes all knowledge required for the regular operation and use of the function:
- Execution Options
Provided that the function can be operated with different options, they are briefly described here with respect to syntax and semantics.
- User Input
It is stated for every item of information required by the function how it has to be entered (operation of external interfaces).
Information such as length of time, signals, messages that are indicators for regular processing, are described. If required, this also contains a description of the actions and services required during operational function execution.
- Expected Output
It is stated for every function how information sent in during proper operation has to be received (operation of external interfaces).
- Relationships to other functions
Measures must be described, both for the regular termination and for the interruption of the function execution.
Measures for the explicit restart are described. Initialization steps might be necessary for this purpose.
- Supervisory Measures
Methods and measures for the supervision of operation (monitoring, watchdog, etc.) will be described. In this connection, the handling of the corresponding external interfaces is important.
- Error Messages
Messages for the user are listed and explained in more detail, with regard to content and context.
- Possibilities of Error Diagnosis
Along with the possible errors, the closely described causes (operating error, false information, malfunctioning device, etc.) are documented and the available possibilities for finding the causes are listed (e. g. tools). References to the diagnosis manual must be included here.
- Error Correction Measures
This contains measures to repair any errors which have occurred (demotion, supply with correct information, hardware exchange, etc.).
- Recovery Procedures
In the case of a serious breakdown, it might become necessary to use a special restart procedure. This procedure has to be described in detail (switching to emergency operation, other channel in the case of a redundant structure, recovery to defined information status, etc.). In contrast to a deliberate restart, this item stresses the mandatory completion of the function.
Last Updated 01.Jan.2002
Updated by Webmaster
Last Revised 01.Jan.2002
Revised by Webmaster