5 Teil 5: V-Modell-Referenz Produkte

5.3 Produkte

5.3.11 Logistikelemente

5.3.11.2 Nutzungsdokumentation

Verantwortlich: Technischer Autor (bei Verwendung des Vorgehensbausteins Systemerstellung)

Aktivität: Nutzungsdokumentation erstellen

Mitwirkend: HW-Architekt, HW-Entwickler, QS-Verantwortlicher, SW-Architekt, SW-Entwickler, Systemarchitekt, Ergonomieverantwortlicher

Sinn und Zweck

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).

Wird erzeugt von

Gesamtsystemspezifikation (Pflichtenheft) (siehe Produktabhängigkeit 4.22)

Hängt inhaltlich ab von

Logistisches Unterstützungskonzept, Ausbildungsunterlagen (siehe Produktabhängigkeit 5.24)

5.3.11.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.

Beispielhafte Produktgestaltung

Warn- und Sicherheitshinweise können beispielsweise umfassen:

(un-) zulässige Umgebungsbedingungen,
(un-) zulässige Betriebsparameter,
(un-) zulässige Nutzungsvarianten,
Schutzmaßnahmen vor Inbetriebnahme / bei Abschalten / Außerbetriebnahme,
Verhalten bei Systemstörungen,
medizinische Hinweise bei Personenschäden.

5.3.11.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.

Beispielhafte Produktgestaltung

Die Beschreibung zu Umfang und Funktionsweise des Systems beinhaltet beispielsweise:

Gesamtansicht
Bezeichnungen, Kennzeichnungen
Übersicht, Architektur des Systems
Technische Beschreibung des Systems und der Systemelemente (Zweck, Wirkungsweise)
Technische Daten des Systems und der Systemelemente
Ausstattung, Zusatzgeräte und Schnittstellen

5.3.11.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.

Beispielhafte Produktgestaltung

Orientiert an der Art der Nutzung kann die Bedienungsanleitung folgende Themen enthalten:

Installation, Erstinbetriebnahme und Wiederinbetriebnahme
Konfiguration der Hardware und der Software
Administration, Betrieb und Bedienung
Fehlerüberwachung
Außerbetriebnahme, Konservierung, Verpackung, Transport und Lagerung

5.3.11.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.