Wer braucht DocBook?

Für welche Arten von Dokumenten ist DocBook sinnvoll?

Primär unterstützt DocBook die Erstellung technischer Dokumentationen. Letztendlich aber kann man jedes Dokument, das hierarchische Strukturen (Kapitel, Absätze, Inhaltsverzeichnis, Glossar etc.) besitzt, mit DocBook beschreiben:

  • Bedienungsanleitungen
  • Referenzhandbücher
  • Wissenschaftliche Arbeiten
  • Gesetze, Normen und Richtlinen
  • Managementhandbücher (Projekt-, Qualitäts-, Umweltmanagement etc.)
  • Romane und Sachbücher
  • Lexika und Wörterbücher
  • Kompendien und Leitfäden
  • Drehbücher und Manuskripte
  • Beipackzettel für Medikamente
  • Spielanleitungen
  • usw.

Arbeiten mehrere Autoren an unterschiedlichen Abschnitten, und möchte man diese später zusammengeführen, ist eine XML-basierte Dokumentation ungleich hilfreicher als unterschiedlich formatierte WYSIWYG-Texte. Vorab sollte man allerdings klären, welche XML-Tags für welche Inhalte sinnvoll sind. Doch auch bei unterschiedlichem Tagging ist es für den Editor weniger aufwändig, die Tags neu zu setzen, als beispielsweise in Word-Dokumenten korrigierend herumzuformatieren.

Für welchen Dokumentenumfang eignet sich DocBook?

Für Handbücher im Beilegerformat ist DocBook tatsächlich weniger geeignet. Zwar kann man den Inhalt schnell erstellen, doch die Layouterstellung gestaltet sich unabhängig vom Umfang recht aufwändig. Das Layout für die erste Inhaltsseite passt meist auch für die 500 folgenden Seiten. Ausschlaggebend ist hauptsächlich, wieviele unterschiedliche Layouts letztendlich eine Dokumentation enthält:

  • Deckblatt (1 Seitenlayout)
  • Schmutztitel (1 – 2 Seitenlayouts)
  • Haupttitel (1 Seitenlayout)
  • Impressum (1 Seitenlayout)
  • Inhaltsverzeichnis (1 – 2 Seitenlayouts, umfangabhängig rechte und linke Seite)
  • Text (2 Seitenlayouts, rechte und linke Seite)
  • Anhang (1 – 2 Seitenlayouts, umfangabhängig rechte und linke Seite)

Viele dieser Layouts sind oft mehrfach verwendbar, doch eine ordentliche Dokumentation wird ohne zwei bis drei unterschiedliche Layouts kaum auskommen.

Bei einer großen Produktvielfalt ist es also durchaus sinnvoll, seine Dokumentation mit DocBook zu erstellen und deren Layout einheitlich an zentraler Stelle festzulegen. So stellt man sicher, dass bei einem Wechsel des Layouts alle Dokumentationen gemeinsam das neue Layout erhalten, ohne jedes Dokument neu setzen zu müssen.