6 Teil 6: V-Modell-Referenz Aktivitäten

6.3 Aktivitäten

6.3.11 Logistikelemente

6.3.11.2 Nutzungsdokumentation erstellen

Sinn und Zweck

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.

6.3.11.2.1 Nutzungsdokumentation entwerfen

Für jedes Dokument ist ein Inhaltsverzeichnis zu erstellen. Vom Auftraggeber geforderte beziehungsweise allgemein geltende Normen und Standards sind dabei zu berücksichtigen.

Für militärische technische Handbücher gelten spezielle Standards, diese sind vor Projektbeginn mit dem Auftraggeber festzulegen. Für eine Interaktive Elektronische Technische Dokumentation (IETD) werden beispielsweise die Standards »ASD Spec 1000D und »AECMA Simplified English vorgeschrieben. Für Papierdokumentationen sind beispielsweise Standards wie »GAF T.O. C-2-1 oder »H011 zu verwenden.

Für multimediale Dokumentation sind Drehbücher beziehungsweise andere geeignete »Vorlagen zu erstellen. Titelseiten, Vorspann, Formatvorlagen, DTDs und Layouts sind als Muster zu definieren.

6.3.11.2.2 Daten für Nutzungsdokumentation akquirieren

Die Beschaffung aller zur Erstellung der Dokumentation erforderlichen Informationen (Texte, Bilder, Stromlaufpläne, Bauschaltpläne, Blockschaltbilder usw.) geht der Manuskripterstellung voraus.

Informationsquellen sind unter anderem vorhandene Dokumente, logistische oder sonstige Datenbanken, Zeichnungen aus CAD-Systemen sowie alle relevanten Dokumente, die im Rahmen des Entwicklungsprozesses entstehen. Falls für die Dokumentationserstellung benötigte Dokumente fehlen, sind diese umgehend einzufordern.

Darüber hinausgehende Informationen sind bei Bedarf durch Interviews einzuholen. Falls die Dokumentationserstellung in Verbindung mit der Ausbildungsvorbereitung erfolgt, sind die Datenbeschaffungsaktivitäten zu koppeln. Die Fotoerstellung und die Beschaffung multimedialer Beiträge (Videos, Tonaufnahmen) gehören ebenfalls zur Datenakquisition.

6.3.11.2.3 Nutzungsdokumentation redaktionell erstellen

Bei der redaktionellen Erstellung der »Nutzungsdokumentation sind bestehende Texte kundengerecht zu formulieren und an die geforderte Informationstiefe anzupassen. Es sind eindeutige, verständliche und anwendergerechte Formulierungen zu verwenden. Abhängig vom Ausgabemedium sind die Informationen text- oder bildorientiert aufzubereiten.

Vorhandene Zeichnungen, Blockschaltbilder, Diagramme und Fotos sind an die Belange der Dokumentation anzupassen und zu vereinheitlichen. Bei Bedarf sind Positionsnummern einzufügen und nicht verfügbare Zeichnungen und Grafiken zu entwerfen. Animationen, Simulationen, interaktive Präsentationen, Audio- und Videoanteile, die bei multimedialer elektronischer Dokumentation eingesetzt werden, sind zu erstellen.

Schließlich sind Sicherheitshinweise und Hinweise auf elektrostatisch gefährdete Baugruppen einzuarbeiten.

6.3.11.2.4 Nutzungsdokumentation zusammenstellen und integrieren

Die erstellten Dokumentationen sind gemäß dem vorliegenden Inhaltsverzeichnis in das vorgesehene Layout zu integrieren - je nach Medium als Handbücher oder elektronische Dokumentationen. Zugelieferte Bestandteile von »Unterauftragnehmern oder Konsortialpartnern sind in das einheitliche Layout zu bringen und ebenfalls in die Dokumentation zu integrieren.

Animationen, Simulationen, Interaktionen, Audio- und Videoanteile, die bei multimedialer elektronischer Dokumentation eingesetzt werden, sind gemäß Drehbuch einzubauen.

Die Einheitlichkeit der Darstellung von Text und Grafik ist sicherzustellen. Nummerierungen und Abbildungsnummern sind konsistent einzufügen und Querverweise und Hyperlinks sind zu erstellen beziehungsweise zu aktualisieren.

Nach der Integration der Inhalte sind diese mit der erstellten HW/SW des Systems zu vergleichen. Dabei sind insbesondere die Sicherheitshinweise zu prüfen. Danach findet die Endredaktion (das Lektorat) statt.