Beispiel: Data Warehouse dokumentieren

Fakten

Anwenderhandbuch 280 Seiten; Auslieferungsformat PDF und CHM inkl. 2 Tutorials im AVI-Format;
Referenzhandbuch 180 Seiten; Auslieferungsformat PDF

Ausgangsbasis

Eine bestehende Dokumentation liegt in einem gängigen Textverarbeitungsprogramm vor. Die bisherige Auslieferung erfolgt als PDF. Es gibt drei Programmvarianten.
Der Datenumfang des Data Warehouse wird erheblich erweitert. Durch einen erweiterten Einsatz werden in Zukunft acht Programmvarianten nötig.
Die Programmvarianten unterscheiden sich in den Schnittstellen für die Datenübernahme und in der Datengrundlage. Daraus resultieren auch Unterschiede in der Funktionalität.

Aufgabe

Die Gliederung soll sich an den Nutzergruppen orientieren. Die Dokumentation soll so wenig Varianten wie möglich haben.
Die Dokumentation soll in Zukunft als PDF- und als CHM-Datei vorliegen. Die Onlinehilfe soll kontextsensitiv sein, außerdem sollen kleine Tutorials im AVI-Format eingebunden werden.

Lösung

Analyse der Programmvarianten

Eine Informationsmatrix zu den Programmvarianten wird erstellt. Die Matrix stellt die Versionsunterschiede übersichtlich dar und ist Informationsgrundlage für alle am Projekt beteiligten Personen.
Die Gliederung, variable Textblöcke und variable Bilder werden mit Hilfe der Matrix festgelegt.

Layout

Ein neues Layout macht das Dokument lesefreundlicher. Die Layoutvorgaben werden in einem Dokumentationsleitfaden festgeschrieben.

Dokumentationsleitfaden

Folgende Festlegungen werden beschrieben:

• Prozesse der Zusammenarbeit und des Informationsflusses
• Ansprechpartner
• Layoutvorgaben
• Bildaufbereitung
• Gliederungsvorgaben
• Terminologieliste

Gliederung der Dokumentation

Die Dokumentation erhält drei Schwerpunkte:

• Administration
  Installation, Datenübernahme und -aktualisierung
• Anwenderhandbuch
  Aufbau der Datengrundlage, Kombinationsmöglichkeiten der Daten, Programmfunktionalität
• Referenzbereich
  Datenvariablen werden nach Schwerpunkten tabellarisch gelistet

Texte und Bildgestaltung

Texte werden möglichst variantenneutral formuliert. Schritt-für-Schrittanleitungen machen die Funktionalität nachvollziehbar. In Bildschirmfotos werden zusätzliche Informationen integriert, die Lesenden erhalten dadurch kompakte Informationen.

Autorensystem

Als Erstellungsprogramm wird AuthorIT gewählt, ein Autorensystem für single source publishing. Textbausteine und Bilder können als Variable angelegt werden. Die Variablen werden dokumentenweit ausgetauscht. Aus den Quelltexten werden sowohl ein Worddokument als auch eine CHM-Datei erstellt. Die Verwaltung der verschiedenen Varianten ist einfach möglich.

Vorteile

Die acht Varianten werden gleichzeitig gepflegt und in einer Datenbasis verwaltet. Printversion und Onlinehilfe werden gleichzeitig fertiggestellt.
Die Arbeitsprozesse und die Zusammenarbeit werden standardisiert und optimiert.
In der Endphase der Softwareentwicklung wird die Dokumentation erstellt und steht zeitgleich mit der Auslieferung der Software zur Verfügung.