Home FXL Dokumentations-Tooling
FXL-Dokumentations-Tooling PDF  | Drucken |

Die Bereitstellung von Entwickler- und Endnutzerdokumentationen ist eine sehr wichtige Aufgabe in jedem Projekt. Kommt ein modellgetriebener Ansatz unter Verwendung von XML-Schema oder Ecore zur Meta-Modellierung zum Einsatz, ist es notwendig, die dabei entstehenden XML-Schemata bzw. Meta-Modelle menschenlesbar zu dokumentieren. Zu diesem Zweck wurde das FXL-Dokumentations-Tooling entwickelt. Es stellt unter anderem die folgenden Funktionen zur Verfügung

  • Import von XML-Schema und Ecore-Dateien
  • automatische Generierung von pseudo-XML-Schemata als Bestandteil der Dokumentationen
  • Erstellen von UML-Klassendiagrammen, Tabellen von Eigenschaften der einzelnen Klassen
  • Gliederung/Strukturierung der Dokumente nach Kapitel, Aufzählungen etc.
  • Einbinden von Bildern, XML-Beispiel-Dateien etc.
  • Strukturierte Eingabe und Verwaltung von Dokument-Meta-Daten inkl. der Liste von Referenzen
  • Verwaltung von noch zu erledigenden Aufgaben (TODOs) innerhalb von Dokumenten
  • Export der Dokumentationen, derzeit nach HTML; anpassbar und um beliebige Formate erweiterbar

Um die Dokumentation eines modularen Systems effizient zu verwalten, müssen die Dokumentationen der einzelnen Module so nah wie möglich an den Modulen abgelegt werden. Die Aufgabe des Hilfesystems ist dann das Zusammensuchen der Einzelteile der Dokumentation und die Darstellung in einer einheitlichen Sicht. Im Rahmen des Projektes aloXerv wurde das Tooling zur Erstellung von Dokumentationen mit dem dort erstellten Editor der Domänen-Entwickler integriert, um die Erstellung der Dokumentation so einfach wie möglich zu gestalten. Eine solche Integration wird ich einer kommenden Version des CDF-Editors ebenfalls existieren.

dokuTool

Das Dokumentations-Tooling inkl. Vorschau-Sicht

pseudoSchema

Pseudo XML-Schema als Teil einer Dokumentation (inkl. Links zu anderen Teilen des Schemas)

uml

UML-Klassendiagramm als Teil einer Dokumentation

Weiterführende Informationen

Die Dokumentation der Dokumentations-Sprache kann hier nachgelesen werden (in englischer Sprache; die Doku liegt im SVN eingecheckt. Der Firefox-Browser kann diese nicht direkt laden. Bitte mit dem Internet-Explorer betrachten. Um die UML-Diagramme darstellen zu können muss das Adobe SVG-Plugin installiert werden).

Der CDF-Editor enthält ein Hilfe-Modul, um die mit dem FXL-Doku-Tooling erstellten Dokumentationen als Eclipse-Hilfe einzubinden.


LAST_UPDATED2