Dokumentation kritisches Telekommunikationssystem

Die Herausforderung

Durch ständig wachsende Anforderungen an die Kommunikationsinfrastruktur ergeben sich große Projekte und schnell ändernde Herausforderungen an die Telekommunikationsunternehmen. 

Für die Vorbereitung und Umsetzung neuer Angebote für den Endkunden greift die Telekom bei Hard- und Software auf die Dienste externer Entwicklungsfirmen zurück. 

Das interne Cost-Engineering hat dabei die Aufgabe, die laufenden Projekte ab der Planungsphase mit Methodenwissen im Bereich Planung und Steuerung der Projektkosten zu begleiten. Dafür ist speziell Know-How im Bereich Softwareentwicklung und Projekt- bzw. Scope-Management von IT-Projekten notwendig, um der laufend wachsenden Komplexität bei Entwicklungsprojekten Herr zu werden. 

Aufgrund langjähriger Beziehungen mit externen Entwicklungspartnern gilt es auch, die Kostenentwicklung im Verhältnis zur gelieferten Performance und Qualität einzuschätzen und effektive Methoden im Kostencontrolling zu entwickeln.

Die Lösung

Aufgrund des Wunsches den Source-Code quantitativ und die über Jahre im System implementierten Anforderungen im System nachvollziehen zu können wurde entschieden eine Reverse Engineering Projekt mit einer automatisierten funktionalen Dokumentation der programmierten Inhalte und eine Inventur über das Gesamtsystem durchzuführen.
Zusätzlich wurde eine manuelle Gap-Analyse angefordert, die einen Überblick den Status-Quo der Software und einen Ausblick über aktuelle und zukünftige Herausforderungen bieten sollte.

Die Projektumsetzung

Im Rahmen eines Dokumentationsprojektes erhielt die Firma Sysparency den Auftrag eine Inventarisierung und Einschätzung des Gesamtsystems über die Funktionalität und Beschaffenheit des Source-Codes zu geben. Es sollte auch eine automatisierte inhaltliche Neustrukturierung und Dokumentation des Source-Codes der Software geben.
Dabei wurde Größe und Komplexität des Systems mittels Schätzmethoden und unterschiedlichen Software-Metriken erhoben und mittels Benchmarking validiert.
Die Inventarisierung wurde durch Sysparency und teilweise manuell vorgenommen und lieferte unter anderem eine Übersicht der verwenden Protokolle und Schnittstellen, der unterschiedlichen Aufteilungen für Programmierung und Tests, sowie andere relevante qualitative Parameter.
Die Gap-Analyse analysierte die Differenzen zwischen der Telekom Software im Gegensatz zu Standard- und Open-Source Produkten. Es entstand eine detaillierte Übersicht der verwendeten RFC-Standard und deren implementierten Attribuierungen. Zusätzlich wurden eigens definierte Module des Lieferanten identifiziert. Diese Ergebnisse ließen einen wesentlichen Rückschluss über den Status-Quo der Software zurück und konnten erfolgreich für eine erste Marktanalyse als Vergleich mit anderen Lieferanten genutzt werden.
In einer ersten Phase wurden begonnen automatisiert Schnittstellen- und Datenbankdarstellungen zu dokumentieren. Im Laufe des Projektes wurde nach einer regelmäßigen Abstimmung mit dem Management entschieden, dass eine Zusammenführung der fachlich inhaltlichen Themen der Gap-Analyse und der generierten automatisierten Dokumentation in dieser Phase am sinnvollsten wäre und es wurde eine automatische Dokumentation aller vorkommenden Standard- und Telekomspezifischen Attribute im Source-Code vorgenommen. Zusätzlich zur Darstellung dieser wurde ein Link in den Code bereitgestellt, um eine schnelle Navigation von fachlicher Beschreibung zur technischen Lösung zu gewährleisten.

Ergebnis

Das Projekt hat erfolgreich das Gesamtsystem mit einer Übersicht über die Schnittstellen und verwendeten Dateien und Formate abgebildet. Mittels einer detaillierten Vermessung konnte ein Indiz über bisherige Aufwände und eine Abschätzung über zukünftige Aufwände gegeben werden. Des Weiteren ließen die Ergebnisse einen Vergleich mit bestehender Software auf dem aktuellen Markt zu. Im Rahmen des Projektes wurden über 600 unterschiedliche Attribute automatisch aus dem Source-Code und mit einer manuellen Beschreibung aus dem Handbuch strukturiert und neu dokumentiert.