Dokumentationen von Systemen werden benötigt, um Informationen gezielt für verschiedene Zielgruppen auffindbar zu machen und können gerade in Automic Umgebungen zusätzliche Arbeitsanweisungen enthalten. So bspw. Workarounds, oder spezielle Anweisungen im Falle von Jobabbrüchen. Dokumentationen schaffen somit Transparenz und können ein wichtiges Werkzeug im Rahmen von Audits sein.
Die Erstellung von Dokumentationen ist jedoch zeitaufwändig und bedarf der täglichen Pflege, um eine stets aktuelle Dokumentation aufweisen zu können. Damit die Informationen aus der Dokumentation auch für verschiedene Zielgruppen zur Verfügung gestellt werden können, erfolgt die Dokumentation häufig mit externen Werkzeugen. Aufgrund des hohen manuellen Anteils, sind standardisierte und stets aktuelle Dokumentationen von Umgebungen selten anzutreffen.
Um die Dokumentation zu optimieren, setzt diese Solution darauf, eine automatisierte Dokumentation zu erzeugen. Es wird mit dieser Solution ein Standard zur Verfügung gestellt, um Dokumentationen zu vereinheitlichen und den manuellen Aufwand zu reduzieren.
Die Solution kann auf Basis von b4A Packages Dokumentationen erzeugen. Dabei werden auch Abhängigkeiten von b4A Packages dokumentiert und es können Verweise zwischen den Dokumentationen erstellt werden, wodurch eine übergreifende Sicht über die b4A Packages möglich ist.
Die best4Automic Solution liest dabei automatisiert die Eigenschaften von Objekten in einem b4A Package aus. Dies können Informationen, wie Einstellungen/Attribute wie „Zur Laufzeit generieren“, Inhalte von Scripten (inkl. Pre- und Postscript/Conditions), Package-Konfigurationen, Abhängigkeiten, Versionen, etc. sein. Diese Informationen werden dann auf Basis von Vorlagen aufbereitet. Die aus diesen Vorlagen generierten Dateien können dann in beliebige Zielsysteme, wie Confluence, MediaWiki oder beliebigen anderen, auf Textdateien basierenden, Systemen importiert werden. Beispielsweise ist es genauso gut möglich, SVG-Grafiken oder BPMN-Diagramme von Workflows zu erzeugen.
