Dokumentation mit DocBook
Dass ein Handbuch verständlich geschrieben sein sollte, versteht sich von selbst (auch, wenn massenhaft unbrauchbare Produktheftchen das Gegenteil vermuten lassen). Alleine ein verständlicher Schreibstil genügt jedoch nicht, eine nachhaltige Dokumentation zu erstellen.
Nachhaltigkeit in der technischen Dokumentation bedeutet:
- Inhaltliche Pflege ohne hohen Aufwand
- Anwendung allgemein akzeptierter Quasi-Standards
- Einfache Veröffentlichung über verschiedene Medien ohne aufwändige Anpassungen
- Niedrige Portierungskosten bei Wechsel des Dienstleisters oder Umstellung des Dokumentationssystems
- Unkomplizierte Koordination von Übersetzungen
Eine elegante Möglichkeit, all das unter einen Hut zu bringen, bietet DocBook.
Was ist DocBook?
DocBook ist ein spezielles XML-Format, das eigens für die Erstellung technischer Dokumentationen entwickelt wurde. Die mehr als 300 Auszeichnungselemente und etwa 70 Attribute der DocBook-XML lassen kaum Wünsche offen, was Formatierung und Struktur eines Handbuches angehen.
XML-typisch trennt DocBook den Inhalt von der Form: Sie können festlegen, dass ein Textelement optisch hervorgehoben werden soll. Erst später bei der Textausgabe entscheiden Sie sich, welche Formatierung medienabhängig verwendet wird (z. B. unterstrichen im gedruckten Handbuch, kursiv in der Online-Hilfe).
Gesteuert wird die Ausgabe über sogenannte Transformationsregeln und -prozessoren, mit denen Sie aus dem Quelltext unter anderem PDF- und HTML-Dokumente generieren können.
Was ist DocBook nicht?
Wer aufwändige Layouts gestalten muss oder eine ausgefeilte Typografie in seinen Dokumenten verwendet, der ist mit einer DTP-Software besser bedient. Beschränken Sie sich auf nur ein Medium, z.B. ein Online-Handbuch, so dürfte DocBook auch dafür etwas zu komplex sein. Gleichwohl wäre eine Umstellung auf DocBook die Möglichkeit, Ihre Dokumentation zukünftig medienübergreifend zu erstellen.