Dokumentationsgenerator „MOSTdoc“

Aus Effizienzgründen gewinnt die modellgetriebene Entwicklung in der Softwareindustrie zunehmend an Bedeutung. Mit einem Modell lassen sich Anforderungen auf einfache und schnelle Weise formulieren. ModuleStudio, das von Guckelsberger Informationstechnik (Guite) entwickelt wird, benutzt solche Modelle, um daraus Quelltexte für Zikula Module automatisch zu erzeugen.

Im Rahmen dieser Arbeit wurde ein Generator erstellt, mit dem automatisch Berichte für Modelle erstellt werden können. Ein Generator wandelt die Elemente eines Modells in textuelle Daten um.

Vorerst sind drei Berichte vorgesehen. Ein Bericht bietet eine Kurzübersicht über die Tabellen und Relationen in einem Modell, ein weiterer erstellt eine detaillierte Dokumentation der Datenbanktabellen und der verschiedenen Controller. Der dritte Bericht führt eine Funktionspunktanalyse durch.

Die Generierung der einzelnen Berichte wird über die Eclipse Business Intelligence and Reporting Tools (kurz BIRT) realisiert. Der Aufruf der benötigten Funktionen erfolgt direkt über den Java-Quellcode von ModuleStudio. Dazu wurden eigene Klassen programmiert und der bestehende Workflow überarbeitet und verbessert. Der Benutzer von ModuleStudio kann so die Generierung der Berichte direkt über einen Menüpunkt starten.