Bild, das nachschlagen symbolisiert - Ein Gans, die nach einem Zweig greift.

Beispiel: Data-Warehouse dokumentieren

Fakten

Anwenderhandbuch 200 Seiten; Auslieferungsformat PDF und Webhelp inkl. 2 Tutorials im AVI-Format;
Referenzhandbuch 120 Seiten; Auslieferungsformat PDF

Ausgangsbasis

Eine Dokumentation liegt in einem gängigen Datenformat vor. Die bisherige Auslieferung erfolgt als PDF. Es gibt zwei Programmvarianten.
Der Datenumfang des Data-Warehouse wird erheblich erweitert. Durch einen erweiterten Einsatz werden in Zukunft sechs 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 Webhelp 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:

Gliederung der Dokumentation

Die Dokumentation erhält drei Schwerpunkte:

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 Variablen angelegt werden. Die Variablen werden dokumentenweit ausgetauscht. Aus einer Source werden Print- und Onlineversionen generiert. Die Verwaltung der verschiedenen Varianten ist einfach möglich.

Vorteile

Die sechs 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.

Anders & Szeifert

Postfach 11 02 07
69071 Heidelberg
+49(0)6221/184220
info@softaid.de

Miniaturbild zu Dokumentation



Zurück gehen...




Impressum