DocBook: Clever dokumentieren

DocBook: Clever dokumentieren

Artikel erschienen in IT Magazine 2007/10

Weg mit dem Wortprozessor

Wortprozessoren wie Microsoft Word oder der Writer aus OpenOffice.org eignen sich daher denkbar schlecht zur Erzeugung von Dokumentationen. Ihre binären Dateiformate (auch die XML-Formate der Suiten werden gezippt) lassen sich schlecht versionieren, die gleichzeitige Arbeit im Team ist nur über Umwege zu bewerkstelligen. Die Erzeugung verschiedener Ausgabeformate abseits von PDF ist nur in sehr rudimentärer Form möglich, und die Einhaltung eines einheitlichen Aussehens der Dokumente benötigt viel Selbstdisziplin. Ausserdem ist Word für seine chronische Schwäche bei der Erstellung grösserer Dokumente und bibliographischer Elemente wie beispielsweise Inhaltsverzeichnisse berüchtigt.


Her mit dem Text

Rein textbasierte Systeme wie LaTeX oder Restructured Text (Bestandteil der Docutils) machen insbesondere bezüglich Versionierung und Stabilität bei grösseren Dokumenten eine bessere Figur, bieten allerdings in Hinsicht auf die Vielfalt bei den Ausgabeformaten oder den Auszeichnungsmöglichkeiten von speziellen Elementen wie Code nur ein eingeschränktes Feature-Set. Dies kann aber auch bei kurzen Dokumenten zusammen mit einer Markup-Sprache wie Restructured Text, die auf eine hohe Lesbarkeit in ihrer Ursprungsform ausgerichtet ist, ein Vorteil sein. Wer dagegen grössere Dokumentationen verwalten muss, dem könnte DocBook gefallen.


Neuen Kommentar erfassen

Anti-Spam-Frage Wieviele Fliegen erledigte das tapfere Schneiderlein auf einen Streich?
Antwort
Name
E-Mail
GOLD SPONSOREN
SPONSOREN & PARTNER