4 Teil 5: V-Modell-Referenz Produkte
4.3 Produkte
4.3.10 Logistikelemente
4.3.10.2 Nutzungsdokumentation
|
Vorgehensbaustein |
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).
Wann ist das Produkt entscheidungsrelevant?
|
Entscheidungspunkt |
Das Produkt ist zu keinem Entscheidungspunkt entscheidungsrelevant. |
Wer ist beteiligt?
|
Verantwortlich |
|
|
Mitwirkend |
Ergonomieverantwortlicher, QS-Verantwortlicher, SW-Architekt, SW-Entwickler, Systemarchitekt |
Womit kann das Produkt erstellt werden?
|
Werkzeuge |
Keine |
|
Methoden |
Keine |
Welche Vorlagen sind verfügbar?
|
Vorlagen |
Produktvorlage wird generiert. |
|
Beispielprodukte |
Keine |
Wie erstellt man das Produkt?
|
Aktivität |
Nutzungsdokumentation erstellen |
Die Nutzungsdokumentation versetzt die Anwender eines Systems in die Lage, dieses bestimmungsgemäß zu bedienen. Sie richtet sich an Personen, die sich der Regel unterscheiden durch den Bildungsgrad, die fachliche Qualifikation und das Hintergrundwissen, die Vertrautheit mit dem System (Anfänger, Fortgeschrittener, Experte) und das Tätigkeitsprofil innerhalb des Auftrags. Bei der Erstellung der Dokumentation sind daher die Bedürfnisse der Adressaten zu berücksichtigen. Das System muss sich allein unter Verwendung der Dokumentation für jeden Nutzer erschließen. Bei Adressatenkreisen mit großen Unterschieden in ihren Profilen sind mehrere Nutzungsdokumentationen zu erstellen, beispielsweise ein Tutorial für Einsteiger und ein Referenzhandbuch für Experten.
Die Erstellung der Nutzungsdokumentation wird kurz am Beispiel einer Dokumentation für Installation und Bedienung aufgezeigt. Zunächst ist die Struktur, z.B. mit Hilfe eines Inhaltsverzeichnis, zu entwerfen. Um die Struktur mit Inhalten zu füllen, werden dann die benötigten Informationen gesammelt. Als nächstes werden die vorhanden Informationen kundengerecht und redaktionell aufbereitet. Abschließend werden alle zur Installation und Bedienung gehörenden Anteile in das entsprechende Layout bzw. ausgewählte Medium integriert.
Welche Abhängigkeiten hat das Produkt?
|
Erzeugt durch |
Systemspezifikationen |
|
Erzeugt |
Das Produkt erzeugt keine weiteren Produkte. |
|
Hängt inhaltlich ab von |
Das Produkt hat keine inhaltlichen Abhängigkeiten. |
4.3.10.2.1 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.