Flexibel dokumentieren mit DITA

Text: Regine Ceglarek Markus Wiedenmaier

Wie kann eine Technische Redaktion eine Softwaredokumentation auf dem aktuellen Stand halten? Etwa mit Elementen aus dem DITA-Standard. Dafür benötigt sie das DITA-Open-Toolkit, außerdem eine neue Sichtweise auf ihre Arbeitsabläufe.

Inhaltsübersicht

Lesedauer: 10:25 Minuten

Standardsoftware wird mit Standarddokumentation ausgeliefert. Für den konkreten Einsatz beim Kunden wird Software oft kundenspezifisch angepasst. Damit ergibt sich die Aufgabe, die Standarddokumentation um die kundenspezifischen Funktionen zu erweitern. Aus der Standarddokumentation entsteht eine Projektdokumentation.

Wie schafft man es, dass Standarddokumentation und Projektdokumentation auch bei Updates und Weiterentwicklung der Standardfunktionen noch synchron laufen und man nicht zwei Dokumentationsstände parallel pflegen muss? Dieser Beitrag zeigt, wie durch intelligente Reuse-Mechanismen die parallele Dokumentation von Standardsoftware und kundenangepasster Software gelingen kann. Die Lösung liegt in Mechanismen, die die mittlerweile etablierte Darwin Information Typing Architecture bereithält, kurz „DITA“.

Dieser Beitrag richtet sich an Leserinnen und Leser, die erste ...

Titelmotiv von Ausgabe 03 2021 der technischen kommunikation