Im aktuellen Java-Magazin (7/2012) stellen unsere Kollegen Nico Alpert und Bjarne Jansen den effizienten Einsatz von DocBook in Kombination mit Maven vor.
Die Erstellung einer sinnvollen Dokumentation ist in jedem Projekt immer wieder ein Thema über das lang und breit diskutiert wird, das aber doch häufig unter den Tisch fällt. Die Entwickler wünschen sich oftmals eine Dokumentation, die nah am Source-Code liegt und die am besten auch wie Source-Code behandelt werden kann. Leider bieten die gängigen Office-Produkte diese Möglichkeiten nicht.
Die Verwendung von DocBook löst dieses Problem. DocBook ist ein XML-Format, das leicht über WYSIWYG-Editoren bearbeitet werden kann. Die Verwendung der Editoren ist einfach, sodass schnelle Ergebnisse erzielt werden können. Durch die Verwendung des XML-Formats kann die Dokumentation einfach gemerged werden, wenn mehrere Entwickler parallel an demselben XML-Dokument arbeiten. Die Verwaltung der XML-Dateien in Versionskontrollsystemen wie git oder svn ist ebenfalls leicht möglich.
Durch die Kombination mit Maven, kann die Erstellung der Dokumentation leicht in den normalen Build-Prozess aufgenommen werden. Dynamische Dokumentationsinhalte wie z.B. Release-Notes können beim Bauen automatisch aus dem Bug-Tracking-System ermittelt werden. Durch die Erstellung eigener Maven-Plugins sind der Fantasie keine Grenzen gesetzt.
Der in dem Artikel aufgeführte Prozess beschreibt in Auszügen die Erstellung der Dokumentation für das checkerberry test center. Dieses Vorgehen vereinfacht die Erstellung von neuen Releases maßgeblich und sorgt dafür, dass die Dokumentation und das Produkt stets zusammen passen.
Wenn Sie weitere Informationen wünschen, kontaktieren Sie uns gern per Mail (Spamschutz)
oder per Telefon unter 040 605 33 83 0.