G Referenz Arbeitshilfen

G.1 Aktivitäten

G.1.8 Logistikelemente

G.1.8.2 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.