Wenn man Dokumentation schreiben muss, dann überlegt man sich zweimal, welches Format man nimmt. Na klar, am Ende ist es wohl fast immer ein PDF, aber ein PDF schreibt man nicht direkt.
MS Word? Hoher Frustrationsfaktor und man kann schlecht gemeinsam daran arbeiten, vor allem im Sinne einer Versionsverwaltung. Vom Ausschluss der Linux-Fans mal ganz schweigen.
OpenOffice? Schon besser, aber das mit der gemeinsamen Arbeit und der Versionverwaltung ist da noch nicht so perfekt, zudem quälen sich viele Leute mit Layoutfragen und weniger mit dem Inhalt. Das ist aber kein OO-Problem, sondern ein Verständnisproblem der Arbeit mit strukturierten Dokumenten. Ein visuelles Tool verführt einfach dazu, nicht über Struktur nachzudenken, sondern sich im Design zu verlieren.
LaTeX? TeX ist cool und produziert super Dokumente, wenn man es denn mal im Griff hat und eine gute Vorlage mit Paragrafen und Absätzen, die ausgezeichnet sind, sein eigen nennt. Pure LaTEX hilft nicht viel, weil alle wieder zum manuellen Formatieren neigen… auch wenn das Ergebnis super aussieht. Dafür lassen sich aber Dokumente sehr einfach gemeinsam schreiben und in einer Versionsverwaltung gut hinterlegen und pflegen.
Wenn man den Markt eine Weile studiert, dann findet man DocBook, quasi die konsequente Weiterführung der TeX-Idee mit den Mitteln von XML und XSL. Viele Linux-Projekte schreiben bereits ihre Dokumentation in DocBook.
Leider gibt es kaum vernünftige Editoren am Markt, die das Schreiben unterstützen und gleichzeitig etwas Luxus bieten, um zum Beispiel die Rechtschreibung zu prüfen. Ich als Programmierer mag auf jeden Fall schon mal das Format, die Klarheit und die Möglichkeiten, die sich durch XML/XSL ergeben. Gleichzeitig läuft die Sache auf allen Plattformen, da die Tools zur Produktion des finalen PDF in Java geschrieben sind.
Bin gespannt, ob DocBook eine große Liebe wird oder eine herbe Enttäuschung.
P.S. Nicht zu vergessen, dass O’Reilly DocBook als offizielles Anlieferungsformat für Bücher auserkoren hat. Ich wollte schon immer mal ein Buch schreiben.
Bei der Suche nach der großen Liebe ist es immer von Vorteil, mehr als eine Option zu prüfen. Neben DocBook hat sich in den letzten Jahren DITA als Dokumentationsstandard etabliert: Topik-orientiert, und daher besonders gut geeignet für modular aufgebaute Dokumentationsangebote. Besonders interessant hier auch das DITA Open Toolkit, mit dessen Hilfe man sehr schnell produktiv werden kann. Nichts gegen DocBook – aber trotzdem auch einben Blick auf DITA riskieren.
Danke. Ich schaue es mir gerade an und bin schon am überlegen… welche Tools benutzt Du?