7. Workshop Software-Reengineering Dokumentation für die Software-Wartung Stefan Opferkuch Universität Stuttgart Institut für Softwaretechnologie, Abteilung Software Engineering 4. Mai 2005
Übersicht Wie kann Software-Wartung verbesrt werden? Mögliche Wartungsdokumentation Aktueller Stand der Dokumentation in der Wartung Unterschiedliche Interesnslagen Aktuelle Arbeiten Folie 2/10
Software-Wartung ist nicht so gut, wie sie in sollte/ könnte. Software-Wartung... dauert zu lange ist zu teuer ist fehlerintensiv ist zu unflexibel ist nicht planbar Folie 3/10
Wie kann Software-Wartung verbesrt werden? Einsatz eines Configuration- und Changemanagements von Beginn der Entwicklung an Codierrichtlinien definieren und anwenden Einen definierten Wartungsprozess eintzen Werkzeuge für die Wartung verwenden Dokumentation für die Wartung erstellen und verwenden Folie 4/10
Workshop Dokumentation in der Software-Wartung Expertentag IT-Projektmanagement, Stuttgart, 15. April 05 Benennen Sie das wichtigste Dokument der Wartung Code-Kommentar Architektur Architekturbeschreibung Feinspezifikation Schnittstellen & Hierarchie Deployment-Diagramm Kundenvereinbarung Anforderungsdokument Dokumentation der Änderung Durchgeführte Änderungen Bugtracker Folie 5/10
Workshop Dokumentation in der Software-Wartung Expertentag IT-Projektmanagement, Stuttgart, 15. April 05 Benennen Sie das wichtigste Dokument der Wartung Code-Kommentar Architektur Architekturbeschreibung Feinspezifikation Schnittstellen & Hierarchie Deployment-Diagramm Kundenvereinbarung Anforderungsdokument Dokumentation der Änderung Durchgeführte Änderungen Architektur und Code Anforderungen Änderungen Bugtracker Folie 5/10
Mögliche Wartungsdokumentation Systembeschreibung Die Systembeschreibung erfolgt während der Entwicklung in einer Spezifikation und einem Architekturentwurf. Codebezogene Dokumentation Die codebezogene Dokumentation besteht aus einem Modulentwurf und der internen Dokumentation des Codes. Zusätzlich muss für die Wartung eine Dokumentation der Abhängigkeiten sowohl zwischen den Anforderungen und deren Umtzung als auch innerhalb des Quellcodes erstellt werden. Folie 6/10
Aktueller Stand der Dokumentation Kajko-Mattsson untersuchte 2001 den Stand der Dokumentation in 19 Wartungsorganisationen. Ergebnis (unter anderem): 10 Organisationen beginnen Wartung mit vollständigen, konsistenten Dokumenten; 3 aktualisieren die während der Wartung 8 haben Codierrichtlinien; 4 haben Dokumentierrichtlinien 5 haben Checklisten für die Erstellung und Änderung der Dokumente; 4 legen fest, wann im Prozess welche Dokumente überarbeitet oder überprüft werden müsn 5 führen formale Abnahmen der Dokumente nach jeder Wartungsaktivität durch Dokumentation für die Wartung ist ein noch immer stark vernachlässigter Aspekt. Folie 7/10
Unterschiedliche Interesnlagen Entwickler Für die Entwicklung notwendige Dokumentation Wartungsingenieure Vollständige Wartungsdokumentation des Systems Wartungsmanagement/ Controlling überhaupt keine Dokumentation Unter Berücksichtigung dier unterschiedlicher Interesn muss ein Kosten-Nutzen-Optimum für die Wartungsdokumentation gefunden werden! Folie 8/10
Aktuelle Arbeiten Welche Dokumentation welcher Softwareteile ist unter Kosten-Nutzen-Aspekten notwendig und sinnvoll? Entwicklung eines Bewertungsschemas für Wartungsdokumentation Erfasn der Bedeutung der Dokumentation für die Software- Wartung Bewertung durch Wartungsingenieure, wie hilfreich verschiedene Dokumente bei einzelnen Wartungstätigkeiten waren Analy der Wartung mit fehlenden Dokumenten Bestimmen des Kosten-Nutzen-Faktors der Dokumentation Erfasn der Aufwände für die Erstellung und Pflege einzelner Dokumente Bewertung des Nutzens der Dokumente für die Wartung Folie 9/10
Vielen Dank für die Aufmerksamkeit! Für die Bewertung Ihrer Wartungsdokumentation wenden Sie sich bitte an: Stefan Opferkuch Institut für Softwaretechnologie Abteilung Software Engineering Universitätsstraße 38, 70569 Stuttgart E-Mail: opferkuch@informatik.uni-stuttgart.de Tel.: 0711 / 7816-352 Folie 10/10