Konsistente Daten – konsistente Dokumentation

Die Software-Suite simus classmate sorgt bei zahlreichen Anwendern in der Industrie dafür, dass technische Massendaten aktuell, vollständig und fehlerfrei vorliegen. Genau in dieser Form erhalten die Kunden von simus systems auch ihre Software-Dokumentation. Dazu wird ein Großteil der Dokumentation in mehreren Schritten automatisiert erzeugt.

Bildunterschrift: Der Dokumentationsprozess der simus systems GmbH. Bildrechte: Christian Gödert, Karlsruhe

Je weiter die Digitalisierung fortschreitet, desto wichtiger wird die Qualität der zugrunde liegenden Daten. Mit der Software-Suite simus classmate erhalten Anwender in allen Bereichen der Industrie mächtige Werkzeuge zur Strukturierung, Optimierung und Pflege von Stammdaten, für dublettenfreie Bestände von CAD-Modellen und zur Einführung automatischer Prozesse, welche die Datenqualität dauerhaft erhalten.

Die Aufgaben, der Umfang und die Funktionsweise dieser mächtigen Werkzeuge wird für jeden Einsatz individuell angepasst und später von den Systemverantwortlichen gepflegt und ausgebaut. „Dazu brauchen sie eine aktuelle, vollständige und fehlerfreie Dokumentation aller Funktionen und Abläufe unserer Software“, erklärt Dr. Harald Kunze, der als Geschäftsführer die Entwicklung der simus-Software verantwortet. „Deshalb nutzen wir für die Erstellung der Dokumentation den Quellcode der Software und die dort enthaltenen Informationen.“

Das Prinzip dahinter hatte Christian Gödert, Leiter der Technische Dokumentation bei simus systems, bereits in einer Master-Thesis entwickelt und bei einem früheren Arbeitgeber in die Praxis eingeführt. „Wahrscheinlich gibt es nur zwei Software-Anbieter auf der Welt, die auf diese Art die Erstellung der Technischen Dokumentation automatisieren“, sagt Gödert, der zudem einen Lehrauftrag für Informationsarchitekturen an der Hochschule Karlsruhe Technik und Wirtschaft hat. „Die internen Vorteile des teilautomatisierten Prozesses, wie Aktualität, Konsistenz und Verständlichkeit, kommen vollständig bei unseren Anwendern an.“

Diese erhalten die Dokumentation mit jedem neuen Release von simus classmate sowohl als PDF-Datei als auch als kontextsensitive Onlinehilfe, umschaltbar auf Deutsch oder Englisch. Per Tastendruck erhalten die Anwender zu markierten Objekten in der Software Informationen. Zudem kann die Dokumentation – wie mit einer Suchmaschine – durchsucht werden. Dabei erstreckt sich die Dokumentation immer über die gesamte Bandbreite der Funktionen, auch wenn nur ein Modul genutzt wird. Dadurch werden Anwender auf hilfreiche Funktionen aufmerksam, die sie nachrüsten können.