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

Aras erweitert seine PLM-Plattform

Die Neuerungen sollen den Digital Thread, die Low-Code-Entwicklung, die Visualisierung komplexer Baugruppen und das Lieferantenmanagement…

2 Minuten ago

Manufacturing-X: Zurückhaltung überwiegt

Eine Bitkom-Umfrage attestiert der Datenraum-Initiative des Bundes hohe Bekanntheit in der Industrie. Doch noch ist…

48 Minuten ago

Ransomware „Marke Eigenbau“

Ransomware-as-a-Service ist ein lukratives Geschäft und in den Händen professionell organisierter Gruppen. Jetzt können Kriminelle…

22 Stunden ago

Bad Bots: Risikofaktor mit hohen Folgekosten

Bad Bots richten nicht nur wirtschaftlichen Schaden an. Laut dem Bad Bot Report von Imperva…

2 Tagen ago

IT-Verantwortliche setzen auf KI-Hosting in Europa

Studie von OVHcloud verdeutlicht Stellenwert von Datenresidenz und Datensouveränität bei KI-Anwendungen.

3 Tagen ago

Studie: KI-Technologie unverzichtbar für zukunftsfähige Paketlogistik

Mit KI können Unternehmen der Paketbranche Prozesse optimieren, Kosten einsparen und sich zukunftssicher aufstellen.

3 Tagen ago