Continuous Documentation mit Maven bei der JUG-Darmstadt

Am 18.7. war Karsten Klein von der Firma InterComponentWare AG (ICW) zu Gast bei der JUG-Darmstadt und hat einen Vortrag mit dem Titel „Continuous Documentation mit Maven“ gehalten.

Zu Beginn des Vortrags hat Karsten Klein motiviert warum man auch Dokumentation automatisiert erstellen sollte und was die Bestandteile einer Dokumentation sind.
Anschließend hat Karsten eine Art Workflow und ein Toolset vorgestellt, mit dem sich Dokumentation genauso, wie Software, kontinuierlich bauen lässt. Bei der vorgestellten Lösung wurde das DITA-Format zum Verfassen der Dokumentation verwendet (ähnlich dem DocBook-Format). Die Dokumentation wurde aus mehreren Bausteinen oder Modulen zusammen gesetzt. Beispielsweise können im Quellcode mittels Annotationen APIs markiert werden, so dass sie von einem Maven-Plugin in die Dokumentation übernommen werden. Außerdem ist es möglich SVG-Grafiken einzubinden. Großen Wert hat ICW auf die lizenzrechtliche Prüfung von den verwendeten Bibliotheken gelegt. Beispielsweise wurden Abhängigkeiten der Bibliotheken aufgelöst und die Lizenzen der referenzierten Bibliotheken ausgewertet, um beispielsweise zu verhindern, dass Frameworks mit GPL-Lizenz verwendet werden.

Wenn man sich mit dem Thema „Continuous Documentation“ noch nicht befasst hat, dann war es ein guter Einstieg, um eine Idee zu bekommen an welche Dinge man denken muss, wenn man eine Dokumentation automatisiert erstellen will. Und auch, wenn man sich schon mit der Generierung von Dokumentation befasst hat, gab es neue Anregungen, wie z.B. mit Lizenzproblemen umgegangen werden kann.

Der einzige Wermutstropfen war, dass die vorgestellten Tools nicht frei verfügbar sind. Das ist wirklich schade, weil ich den Eindruck hatte, dass eine Reihe von Zuhörern sich erhofft hatten, direkt mit der „continuous Documentation“ loslegen zu können.

Obwohl es bei dem Vortrag um Dokumentation ging, waren erstaunlich viele Zuhörer anwesend. Wir waren wieder über 30. Das zeigt, dass das Thema viele Leute interessiert. (Und das trotz des guten Wetters…)

Vielen Dank an Karsten für den Vortrag!

Kommentare sind abgeschaltet.