Startseite

Einleitung

Dokumentation für den Endanwender

System-Dokumentation

Projektdokumentation mit SoDoM

Zusammenfassung

Literaturverzeichnis

Online-Folien

Zusammenfassung

Die vorhergehenden Kapitel haben gezeigt, daß die Probleme, die sich durch eine fehlende hochwertige Dokumentation von Softwaresystemen ergeben, mit Hilfe der zur Verfügung stehenden Werkzeuge angehen lassen.

Wie wichtig die Dokumentation von Softwaresystemen ist, dürfte sich insbesondere heute darstellen. Das Millenium-Problem ist ein gutes Beispiel dafür, wie sinnvoll es ist, Software zu dokumentieren, denn jetzt müssen viele Softwaresysteme auf das Jahr 2000 umkonfiguriert werden. Diese Aufgabe stellt sich aber als so gut wie unlösbar heraus, wenn vorher nicht ausreichend dokumentiert wurde.

Traurige Realität in der Industrie ist leider immer noch, daß Softwaresysteme erst nach ihrer Fertigstellung dokumentiert werden. Damit ergeben sich jedoch vielfältige Probleme. Eines ist jedoch sicher: Eine Nachdokumentation wird mit sehr hoher Wahrscheinlichkeit unvollständig sein. Meist ist sie auch noch unkorrekt und inkonsistent.

Wie man Softwaresysteme durchgängig dokumentieren kann, hat diese Arbeit dargestellt. Sie hat nicht den Anspruch vollständig zu sein, aber sie versucht einen Einblick in die Wichtigkeit und die Möglichkeiten von Softwaredokumentation zu geben.
Angesichts der Tatsache, daß in vielen Unternehmen die Dokumentation noch immer sehr stiefmütterlich behandelt wird, sieht sich niemand gezwungen das Thema Softwaredokumentation in die Ausbildung von jungen Softwareingenieuren zu integrieren. Es gibt zwar erste Ansätze hierfür, aber sie sind bislang nur sehr halbherzig.

Entweder läßt man Studenten Software nachdokumentieren, was sehr aufwendig ist, und nur den einen Lerneffekt hat, es besser sofort zu tun, oder man läßt sie Applikationen entwickeln und dokumentieren. Dieser Dokumentationsprozeß endet dann allerdings mit der Fertigstellung des Programmes. Der wichtige Aspekt der Wartung von Softwaresystemen wird dabei noch sehr vernachlässigt. Es gibt keinerlei Motivation Dokumentation für ein Programm zu schreiben, welches nur ein Probeprogramm darstellt, welches nach seiner Entwicklung in der Schublade verschwindet.

Die Industrie wird bald schon gezwungen sein, wenn sie die Wiederverwendbarkeit ihrer Software-Komponenten erhöhen will, diese gut zu dokumentieren. Dies hätte 2 große Vorteile:

• Einmal gekaufte Komponenten könnten besser und öfter wiederverwendet werden.
  (siehe dazu Kapitel2)
• Studenten könnten von gut dokumentierten Softwaresystemen lernen, wie sich oft auftretende Entwurfsprobleme lösen lassen. Sie bekommen ein Erfahrungswissen vermittelt. Insbesondere können hier die Design Patterns eine wertvolle Hilfe darstellen.

Johannes Sametinger von der Johannes Kepler Universität in Linz, Österreich, hat sich in seiner Abhandlung "The Role of Documentation in Programmer Training" mit dieser Thematik auseinandergesetzt.

Zwischen der Industrie und den Universitäten besteht eine Art Wechselbeziehung: Werden in der Industrie bestimmte Fähigkeiten erwartet, so fließen diese in die Prüfungsordnungen ein und werden gelehrt. Andererseits könnte ein Gebiet wie die Softwaredokumentation auch von den Universitäten in die Industrie getragen werden, wenn es gelingt, die Führungsetagen von den Vorteilen, wie Erhöhung der Produktivität und bessere Wartbarkeit, zu überzeugen.

Die dazu notwendigen Investitionen werden sich als Investitionen in die Zukunft erweisen und dem Unternehmen aufgrund der oben erwähnten Vorteile, bei dem so wichtig gewordenen "Time-to-Market-Faktor" einen Vorteil gegenüber der Konkurrenz geben.
Dies ist vergleichbar mit der Anschaffung einer neuen Maschine, die auch erst einmal eine Investition in die Zukunft darstellt. Man benötigt erst einmal eine gewisse Einarbeitungszeit um den vollen Nutzen aus ihr ziehen zu können. Doch ist dies erst einmal erreicht, kann die Maschine benutzt und ausgelastet werden, und damit die Produktivität erhöhen.