Categories: SoftwareUnternehmen

Automatische Dokumentation von Notes-Datenbanken

Die durch das Werkzeug ‘DocuGator’ erstellte Dokumentation enthält eine Beschreibung aller verwendeten Designelemente. Die aktuelle Version 2.0 wurde in zwei wesentlichen Punkten weiterentwickelt: Sie kann zum einen auch für konventionelle Notes-Client-Anwendungen komplette Dokumentationen erstellen, zum anderen die Definition eigener Dokumentationsvorlagen vereinfachen.

Der DocuGator funktioniert nach demselben Muster wie JavaDoc. Die Kommentare werden an definierte Stellen in der Datenbank eingeführt. Die Erstellung einer technischen Entwicklerdokumentation beinhaltet sechs Schritte: Datenbank auswählen; zu exportierende Designelementgruppen festlegen; definierte Designelementgruppen nach DXL exportieren; DXL-Dateien nach Pentos-XML transformieren; die LotusScript-, JavaScript- und Java-Kommentare in den Pentos-XML-Dateien mittels Java und regulären Ausdrücken auswerten und aufbereiten; und schließlich die Pentos-XML-Dateien mittels XSLT-Dokumentationsvorlagen in die gewünschte Dokumentationsform und das verlangte Dokumentationsformat transformieren.

Der Vorteil dieser Methode ist, dass die Dokumentation kein fest definiertes Layout und keinen fest definierten Inhalt hat. So können Dokumentationen für verschiedene Zielgruppen wie zum Beispiel ein Plan mit allen Agenten und deren Ausführungsintervall für Administratoren oder eine Dokumentation aller Masken mit einer Beschreibung für den IT Support erstellt werden.

Silicon-Redaktion

Recent Posts

Pure Storage: Cloud, KI und Energieeffizienz

Trends 2025: Rasante Entwicklungen bei Automatisierung, KI und in vielen anderen Bereichen lassen Unternehmen nicht…

14 Stunden ago

GenKI verbessert Datenmanagement und Angebotsgenauigkeit

DHL Supply Chain nutzt generative KI-Anwendungen für Datenbereinigung und präzisere Beantwortung von Angebotsanforderungen (RFQ).

2 Tagen ago

Rolls-Royce Power Systems nutzt industrielle KI aus der IFS Cloud​

Marke mtu will globale Serviceabläufe optimieren und strategische Ziele hinsichtlich Effizienz, Nachhaltigkeit und Wachstum unterstützen.

2 Tagen ago

Thomas-Krenn.AG: viele Pflichten, knappe Ressourcen, mehr freie IT-Welt

IT-Infrastruktur-Trends 2025: Open-Source-Projekte sowie aufwändige regulatorische und Pflichtaufgaben werden das Jahr prägen.

2 Tagen ago

Stadt Kempen nutzt Onsite Colocation-Lösung

IT-Systeme werden vor Ort in einem hochsicheren IT-Safe betrieben, ohne auf bauliche Maßnahmen wie die…

3 Tagen ago

SoftwareOne: Cloud-Technologie wird sich von Grund auf verändern

Cloud-Trends 2025: Zahlreiche neue Technologien erweitern die Grenzen von Cloud Computing.

3 Tagen ago