 |
 |
 |
|
 |
|||
| RE.3.12 a) Information for the Anwendungshandbuch (AHb) |
Information for the User Manual
 Inhalt
|
|
|---|
Einleitung
Die Informationen zum Anwendungshandbuch beinhalten alle Angaben, die der Anwender eines Systems benötigt, um das System ordnungsgemäß bedienen und im Falle von Problemen richtig reagieren zu können. Über jede einzelne Funktion werden hier detaillierte Ausführungen erwartet, die die Anforderungen verschieden geübter Nutzer erfüllen.
Inhalt des Dokuments
1. Allgemeines2. Anwenderfunktionen
2.f. Funktion (f)
2.f.1. Aufgabe
2.f.2. Instruktionen zu Anwendung und Betrieb
2.f.3. Fehlerfall
Aufbau des Dokuments
1. Allgemeines
Siehe Gliederungspunkt 1. Allgemeines.2. Anwenderfunktionen
Hier ist eine Übersicht anzugeben.2. f. Funktion (f)
Hinweis: "f" wird verwendet für eine fortlaufende Numerierung der Anwenderfunktionen von 2.1 bis 2.n und als Platzhalter für den Funktionsbezeichner gemäß den im KM-Plan festgelegten Konventionen zur Identifikation.2. f. 1. Aufgabe
Anhand einer Kurzbeschreibung wird die Aufgabe der Funktion zur Erfüllung des Gesamtauftrags identifiziert.2. f. 2. Instruktionen zu Anwendung und Betrieb
Anwendung bedeutet nicht nur Bedienung durch Personal (Nutzerschnittstellen) sondern auch durch andere Systeme, Segmente, SW-Einheiten oder HW-Einheiten. Auf folgende Anwendungsschritte ist bei der Beschreibung näher einzugehen:- Initialisierung
Hierunter fallen Maßnahmen zur Vorbereitung des Betriebs (notwendige Ausrüstung, Einschalten, Systemvorbereitungen, Versorgung mit Anfangsinformationen, usw.). - Durchführung
Hierunter fallen alle zur regulären Bedienung und Nutzung der Funktion erforderlichen Kennntisse: - Ausführungsoptionen
Sofern die Funktion unter verschiedenen Optionen betrieben werden kann, werden diese in Syntax und Semantik hier kurz beschrieben. - Nutzer-Eingabe
Zu jeder von der Funktion benötigten Information wird angegeben, wie sie zugeführt werden muß (Bedienung der externen Schnittstellen). - Ausführung
Informationen, wie z. B. Zeitdauer, Signale, Meldungen, die Indikatoren für eine ordnungsgemäße Verarbeitung sind, werden genannt. Bei Bedarf wird aufgeführt, welche Handgriffe und Dienstleistungen während einer Funktionsausführung zum Betrieb notwendig sind. - Erwartete Ausgabe
Zu jeder von der Funktion bei korrektem Betrieb gelieferten Information wird angegeben, wie sie abgenommen werden muß (Bedienung der externen Schnittstellen). - Beziehungen zu anderen Funktionen
- Terminierung
Maßnahmen sowohl zum regulären Beenden als auch zur Unterbrechung einer Funktionsausführung werden beschrieben. - Restart
Maßnahmen zum bewußten Wiederanlauf werden beschrieben. Dazu sind eventuell Initialisierungsschritte notwendig. - Überwachungsverfahren
Methoden und Maßnahmen der Überwachung des Betriebs (Monitoring, Watchdog, usw.) werden beschrieben. Wichtig dabei ist die Bedienung der zugehörigen externen Schnittstellen.
2. f. 3. Fehlerfall
Die Gesamtmenge der möglichen Fehlersituationen bei einer Funktionsausführung ist zu beschreiben; dabei ist auf folgende Punkte näher einzugehen:- Fehlermeldungen
Meldungen an den Nutzer werden aufgelistet und dem Inhalt und Zusammenhang nach möglichst ausführlich erläutert. - Fehlerdiagnosemöglichkeiten
Zu den möglichen Fehlern werden die - möglichst eng eingegrenzten - Ursachen (Fehlbedienung, falsche Informationen, defektes Gerät, usw.) angegeben und die zur Verfügung stehenden Möglichkeiten zum Finden einer Ursache werden aufgeführt (z. B. Werkzeuge). An dieser Stelle sind Verweise auf das Diagnosehandbuch aufzunehmen. - Fehlerbehebungsmaßnahmen
Es werden Maßnahmen angegeben, die einen aufgetretenen Fehler wieder rückgängig machen (Rückstufung, Versorgung mit korrekter Information, Hardware-Austausch, usw. - Recovery-Verfahren
Bei schwerwiegenden Betriebsstörungen ist unter Umständen ein besonderes Verfahren zum Wiederanlauf notwendig. Das Verfahren ist exakt zu beschreiben (Umschaltung auf Notbetrieb, anderer Kanal bei redundantem Aufbau, Rückführung zu definiertem Informationsstand, usw.). Im Gegensatz zu einem gewollten Restart steht hier die zwingend notwendige weitere Funktionserfüllung im Vordergrund.
|
|
|
GDPA Online
Last Updated 01.Jan.2002
Updated by Webmaster
Last Revised 01.Jan.2002
Revised by Webmaster
|