Adäquate Dokumentation ist sehr wichtig für
die Software-Wartung. Deshalb ist direkt beim Entwurf schon darauf
zu achten, daß eine ausreichende und leicht verständliche
Dokumentation erzeugt wird. Denn sonst fehlt später bei Wartungsarbeiten
das Verständnis für den Entwurf und dies führt
dann zu Fehlern.
Hypertext eignet sich besonders gut für die Dokumentation.
Denn in einer Hypertextdokumentation können die komplexen
Beziehungen zwischen den einzelnen Objekten des Entwurfs besser
abgebildet werden. In einer linear oder baumartig aufgebauten
Dokumentation auf Papier sind diese Beziehungen zwischen den Objekten
nur schwer darstellbar. Bei einer Hypertextdokumentation ist allerdings
darauf zu achten, daß diese eine gute Benutzerführung
erhält, denn sonst sind die angebotenen Informationen zu
komplex. Mit HTML ist eine Beschreibungssprache vorhanden, die
auf vielen Computersystemen verfügbar ist. Somit ist eine
Hypertextdokumentation, die mit HTML erstellt wurde, immer verfügbar
und leicht in heterogenen Netzen verwendbar.
Da eine Hypertextdokumentation eine komplexere Struktur haben
kann als eine Dokumentation auf Papier, ist es möglich, in
die Dokumentation mehr Informationen aufzunehmen. So können
die einzelnen Versionen einer Software in einer Dokumentation
verwaltet werden. Dies kann das Verständnis für den
Entwurf erhöhen. Außerdem ist so eine Wartung mehrerer
Versionen einfacher. Der Entwickler kann bei Fehlern in einer
Version überprüfen, ob diese Fehler auch in anderen
Versionen auftreten und entsprechende Veränderungen vornehmen
oder veranlassen.
Eine weitere Möglichkeit die Verständlichkeit der Dokumentation
weiter zu erhöhen, ist die Nutzung von Entwurfsmustern in
der Dokumentation. Dies kann einerseits in den Diagrammen geschehen,
wo die Klassen eines Musters zusammen markiert sind und die Entwurfsmuster
die Funktionen der Klassen verdeutlichen. Aber auch der Entscheidungsprozeß
bei der Auswahl des Entwurfsmusters kann das Verständnis
für den Entwurf fördern, so daß diese Informationen
auch in der Dokumentation sein sollten.
Die Komplexität, die eine Hypertextdokumentation annehmen
kann, erfordert Werkzeuge für die Erstellung der Dokumentation.
Ohne die Unterstützung ist die Erstellung der Dokumentation
zu aufwendig und die Dokumentation wird dann nur unzureichend
erstellt. Werkzeuge helfen auch bei der Strukturierung der Dokumentation,
da diese Werkzeuge schon eine bestimmte Struktur vorgeben.
3Wenn man die Abbildung 1, als Beispiel für ein Reverse Engineering
eines undokumentierten Programmes, und die Auszüge der Dokumentation
von OSEFA in Anhang B vergleicht, so sieht man schnell, daß
die mit der Werkzeugumgebung erstellte Dokumentation wesentlich
verständlicher ist.
Damit diese Werkzeugumgebung aber leicht und schnell einsetzbar
ist, sind noch einige Erweiterungen an ihr vorzunehmen. Insbesondere
der Import von Daten aus der Entwicklungsumgebung oder dem Quellcode
muß noch automatisiert werden, damit die Arbeit bei der
Erstellung einer Dokumentation mit der Entwicklungsumgebung noch
weiter reduziert wird.