Automatische Prozessdokumentation in IBM Planning Analytics (TM1)

Ein neuer Entwickler übernimmt ein gewachsenes TM1-System. Er öffnet eine Rule-Datei mit 800 Zeilen ohne Kommentare. Der Vorgänger ist nicht mehr im Unternehmen.

Das TM1 Dokutool analysiert Prozesse und Rules automatisch und erzeugt ein visuelles Abhängigkeitsdiagramm, statt Systemwissen nur im Code einer einzelnen Person zu belassen.

Warum bleibt TM1-Code oft undokumentiert?

TM1-Prozesse und Rules entstehen häufig unter Zeitdruck, die Dokumentation kommt „danach“ und in der Praxis oft gar nicht. Vorhandene Dokumentationswerkzeuge erfordern aufwändige Code-Tags, die selten gepflegt werden.

Das trifft besonders Systeme, die über Jahre von wechselnden externen Dienstleistern weiterentwickelt wurden, bei denen sich Dokumentationsstandards von Projekt zu Projekt unterschieden haben.

Was kostet fehlende Prozessdokumentation?

Wechselt die zuständige Person das Unternehmen, verschwindet mit ihr ein erheblicher Teil des Systemverständnisses. Jeder neue Entwickler muss sich das Wissen mühsam selbst erarbeiten.

Ohne das Dokutool sind Abhängigkeiten nur im Code selbst erkennbar, die Einarbeitung dauert deutlich länger, und Wissenstransfer funktioniert meist nur über eine persönliche Übergabe. Mit dem Dokutool werden Abhängigkeiten als visuelles Diagramm sichtbar, neue Entwickler arbeiten sich spürbar schneller ein, und Wissenstransfer gelingt auch ohne persönliche Übergabe.

In der Praxis verkürzt sich die Einarbeitung neuer Entwickler um rund 2 Tage, und die Fehlersuche in Abhängigkeiten benötigt etwa 50 Prozent weniger Zeit.

Wie erzeugt das Dokutool eine Dokumentation automatisch?

Das TM1 Dokumentationstool analysiert Prozesse und Rules automatisch, ganz ohne spezielle Code-Tags, und erzeugt daraus ein visuelles Abhängigkeitsdiagramm. Das zeigt, welche Prozesse und Cubes voneinander abhängen.

Weil die Dokumentation direkt aus dem bestehenden Code erzeugt wird, bleibt sie zwangsläufig aktuell, ohne dass jemand sie manuell pflegen muss.

Wie lässt sich das Dokutool einführen?

In der Praxis hat sich dabei folgende Reihenfolge bewährt:

1. Relevante Prozesse und Rule-Dateien für die Analyse auswählen.
2. Dokutool über das bestehende System laufen lassen.
3. Erzeugtes Abhängigkeitsdiagramm mit erfahrenen Entwicklern gegenprüfen.
4. Diagramm für neue Teammitglieder als Einarbeitungshilfe bereitstellen.
5. Analyse nach größeren Systemänderungen erneut durchführen.

Der Nutzen zeigt sich am deutlichsten, wenn ein neues Teammitglied die Einarbeitung beginnt. Genau dann macht sich der frühere Aufwand für die Analyse bezahlt.

FAQ

Wie lange dauert der Einsatz des Dokutools?

In der Regel 1 bis 3 Personentage, abhängig von der Größe und Komplexität des Systems.

Müssen Entwickler Code-Tags einfügen?

Nein. Das Dokutool analysiert bestehenden Code automatisch, ohne spezielle Tags zu benötigen.

Bleibt die Dokumentation nach Systemänderungen aktuell?

Nur, wenn die Analyse nach größeren Änderungen erneut durchgeführt wird. Sie generiert sich nicht laufend von selbst.

Wofür lohnt sich das Dokutool eher nicht?

Für sehr kleine, übersichtliche Systeme mit wenigen Abhängigkeiten ist der Aufwand meist nicht nötig.

Ersetzt das Dokutool eine persönliche Einarbeitung?

Nein. Es beschleunigt die Einarbeitung erheblich, ersetzt aber nicht den fachlichen Austausch mit erfahrenen Kollegen.

Wie hoch ist der Aufwand im Vergleich zum Nutzen?

Der ROI liegt im ersten Jahr bei rund 380 Prozent, bei 1 bis 3 Personentagen Einrichtungsaufwand.

Warum BI2run

BI2run baut Module wie das Dokutool aus echten TM1-Systemen heraus, nicht am Reißbrett. Wenn eine Prüfung ergibt, dass euer System bereits gut dokumentiert ist, sagen wir das auch so. Nimm gerne Kontakt mit uns auf, um deine Situation zu besprechen.