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.

For efficiency, the model-driven development is becoming increasingly important in the software industry. With a model you can describe requirements in a simple and fast way. ModuleStudio, developed bei Guckelsberger Informationstechnik (Guite), uses such models to generate source code for Zikula modules automatically.

In this work a generator has been developed which creates reports out of such models automatically. The basic task of a generator is converting the elements of a model into textual data.

Initially, three reports are provided. A report provides a brief overview of the tables and relations in a model, another creates a detailed documentation of the database tables and the various controllers. The third report performs a function point analysis.

The generation of each report is realized with the Eclipse Business Intelligence and Reporting Tools (BIRT). The invocation of the required functions is done directly in the Java source code of ModuleStudio. For this task some special classes have been programmed and the existing workflow was revised and improved. The user of ModuleStudio can initiate the generation of these reports directly from a menu item.