Auf dem Weg von der Idee zur fertigen Software wird die Produktdokumentation häufig nachrangig behandelt. Sie wird zwar als zwingender Bestandteil des Gesamtproduktes gefordert, wird aber oft als notwendiges Übel gesehen. Bei genauerer Betrachtung wird allerdings der Wert einer effektiven und sorgfältigen Dokumentation deutlich: Onlinehilfen, Handbücher, Lernmaterialien, Kurzreferenzen und andere Dokumentationsformen sind die erforderliche Basis für die erfolgreiche Einführung, Nutzung und Weiterentwicklung eines Softwareproduktes.

In der Regel wird die Dokumentation von technischen Redakteuren gemacht. Tatsächlich umfasst der Prozess des eigentlichen Schreibens der Dokumentation nur einen kleinen Teil ihres Aufgabenbereiches. Daneben zeichnen sie verantwortlich für eine effiziente Verwaltung und Pflege der Dokumentation, sie schreiben und modifizieren anschließend Fragmente in verschiedenen Versionen, Releases und Varianten. Diese Abläufe verursachen ohne entsprechende Methoden viel Aufwand und führen schnell zu Inkonsistenzen. Mit zunehmendem Dokumentationsumfang steigen die Kosten für die Pflege und auch die Fehleranfälligkeit. Muss die Dokumentation mehrsprachig geliefert werden potenziert sich das Problem. Hier hilft das DITA CMS DITAworks.

Was ist DITA?

DITA ist ein eine Informationsarchitektur mit einem XML-Standard und hilft strukturierte Inhalte nach dem Single Source Prinzip zu managen. Dies bedeutet, dass ein Dokument aus zahlreichen Komponenten besteht, die in mehreren Dokumenten gleichzeitig wiederverwendet werden können. Diese Vorgehensweise eignet sich ideal um Handbücher, Lernmaterialien, Online-Hilfen und andere Dokumentationen aus nur einer Quelle zu erstellen. Ebenso werden zielgruppengerechte Publizierung, Versionen und Varianten unterstützt und dabei Redundanzen vermieden.

Wie hilft DITAworks in der Softwarebranche?

Betrachten wir folgendes Beispiel: ein Unternehmen entwickelt eine Software zur Administration und Kontrolle von Servern in der Cloud. Die Dokumentation für dieses Produkt soll in drei Sprachen und für drei unterschiedliche Zielgruppen (Benutzer, Administratoren, Entwickler) vorliegen. Zusätzlich sollen separate Dokumentationen für Produktvarianten für verschiedene Betriebssysteme unterstützt werden. Die Unterlagen sollen als Handbuch im PDF-Format, als Online-Hilfe und im Eclipse Help-Format zur Verfügung stehen. Das ergibt mehr als hundert verschiedene Varianten mit einem hohen Grad an Redundanzen.

Vor der Einführung von DITAworks wurde diese große Menge an Dokumentation in separaten MS Word-Dateien gespeichert, die jeweils – sofern benötigt – von Hand in verschiedene Formate konvertiert wurden. Die Redakteure waren gezwungen, Unmengen redundanter Inhalte in allen Dokumenten auf dem neuesten Stand zu halten, was zwangsläufig zu Fehlern führte und die Qualität der Dokumentation allgemein verschlechterte. Darüber hinaus wurde ein Dokument nur bei Bedarf in eine andere Sprachen übersetzt, was sich als ein kostspieliges Verfahren erwies.

Nach der Umstellung auf den Single-source Ansatz werden die Inhalte nur einmal in DITAworks gespeichert, was den Pflegeaufwand enorm reduzierte und gleichzeitig die Qualität besonders in Bezug auf Korrektheit und Konsistenz verbesserte. Die Übersetzungskosten betragen nun ein Fünftel der vorherigen Kosten. Die Dokumentationen für alle Produkte, Zielgruppen und Sprachen werden nun automatisch mit jedem Software Build erzeugt. Das Software-Produkt und die dazugehörige Dokumentation werden in der gleichen Versionsverwaltung gespeichert, was die Verwaltung der verschiedenen Versionen erheblich erleichtert.

Schlussfolgerung

DITAworks bietet für die Dokumentation eine völlig neue Arbeitsweise. Es verleiht technischen Redakteuren mehr Flexibilität und Kontrolle nicht nur darüber, wie sie die Dokumentation schreiben, sondern wie sie sie zusammenstellen und anschließend verwalten. DITAworks ermöglicht große Mengen an Unterlagen sicher zu steuern, den Aufwand an Bearbeitung zu senken und die Fehlerrate zu minimieren und reduziert so deutlich die Dokumentationskosten auf allen Ebenen.

Für weitere Informationen zum Thema DITAworks für die Software Entwicklung oder, um einen Termin für eine persönliche Demonstration zu vereinbaren, kontaktieren Sie uns bitte.