Software-Dokumentation jetzt auch im DocBook-XML-Format

(openPR) Langenhagen/Hannover, 14.03.11

Ein Manko bei der Software-Dokumentation ist, dass sie sich meist nicht in beliebige Formate umwandeln lässt, wenn sie mit einem Text- oder Layoutprogramm geschrieben wurde. So muss ggf. doppelt dokumentiert oder die Texte aufwändig an ein anderes Format angepasst werden.

Eine flexible Lösung ist die Dokumentation im XML-Format mit DocBook*. Dipl.-Betriebswirtin Gabriele Palm, die sich als Fachautorin für Anwendersoftware auf verständliche Software-Dokumentation spezialisiert hat, bietet ab sofort DocBook*-XML-Dokumentationen für das Single-Source-Publishing an. DocBook* ist eine XML-Anwendung, die die Anforderungen der technischen Dokumentation abdeckt und ein plattformunabhängiges und medienneutrales Publizieren erlaubt. Aus einer einzigen Textquelle können je nach Anwendungszweck beliebige Formate erzeugt werden.

Gabriele Palm testet die Software auf Herz und Nieren, dokumentiert die Abläufe aus Anwendersicht und liefert dem Software-Hersteller XML-Dateien. Diese XML-Dateien brauchen dann nach Bedarf nur noch in das gewünschte Format umgewandelt bzw. in die Entwicklungsumgebung eingebunden zu werden, z. B. zur Veröffentlichung im Internet oder als Online-Hilfe, als PDF-Datei oder als E-Book. Software-Neuheiten lassen sich auf diese Weise flexibel dokumentieren und publizieren, so dass die Software-Dokumentation der Entwicklung nicht mehr hinterher hinkt.

(*DocBook ist ein Markenname und unterliegt dem Markenschutz)