C Referenz Produkte

C.1 Produkte

C.1.13 Logistikelemente

C.1.13.2 Nutzungsdokumentation

Die Nutzungsdokumentation enthält alle Angaben, die ein Nutzer benötigt, um das System bestimmungsgemäß bedienen zu können und bei Problemen richtig zu reagieren. Die Art und Anzahl der zu erstellenden Nutzungsdokumentationen entspricht den Vorgaben der Gesamtsystemspezifikation (Pflichtenheft).

Verantwortlich

Technischer Autor

Mitwirkend

Ergonomieverantwortlicher, QS-Verantwortlicher, SW-Architekt, SW-Entwickler, Systemarchitekt

Hilfsmittel

Nutzungsdokumentation erstellen (Aktivität), Nutzungsdokumentation(.odt|.doc)

Teil von

Logistische Unterstützungsdokumentation

Erzeugt durch

Systemspezifikation:

Gesamtsystemspezifikation (Pflichtenheft) (Lebenszyklusanalyse und Gesamtsystemarchitektur)

C.1.13.2.1 Warn- und Sicherheitshinweise

Die Warn- und Sicherheitshinweise beschreiben die für den Nutzer sicherheitsrelevanten Aspekte des Systems. Diese müssen während des gesamten Systemlebenszyklus beachtet und eingehalten werden, angefangen von der Inbetriebnahme bis zur Aussonderung des Systems. Warn- und Sicherheitshinweise müssen unübersehbar, möglichst am Anfang der Dokumentation, eingebracht werden.

C.1.13.2.2 Umfang und Funktionsweise des Systems

In diesem Thema wird das System ausgerichtet auf den Nutzer dargestellt. Über die Beschreibung lernt der Nutzer die für ihn relevanten Bestandteile und die Funktionsweise des Systems kennen. Die Beschreibung des Systems beinhaltet unter anderem eine Gesamtansicht des Systems, eine technische Beschreibung des Systems und dessen technische Daten.

C.1.13.2.3 Installation und Bedienung

Die Bedienungsanleitung beschreibt den sachgerechten Gebrauch des Systems. Sie beschreibt Arbeitsabläufe, wie sie Nutzer mit dem System ausführen.

Abhängig von der Nutzungsart kann die Bedienungsanleitung verschiedene Aspekte beinhalten wie beispielsweise Inbetriebnahme, Administration, Bedienung und Fehlerüberwachung. Die Beschreibung der Bedienung muss sich in Tiefe und Detaillierung an den Kenntnissen der zu erwartenden Nutzer orientieren.

C.1.13.2.4 Pflegeanleitung für das System

Die Pflege umfasst alle einfachen Instandhaltungstätigkeiten, die der Nutzer ohne Hilfsmittel durchführen kann, zum Beispiel die Reinigung des Systems, Austausch von Verschleißteilen und Betriebsflüssigkeiten und Überwachung von Betriebskennzahlen, Update des Antivirenschutzes oder Durchführung eines Backups.