1.Softwaredokumentation

Softwaredokumentation ist wichtig und notwendig für das Entwickeln und vor allem für das Warten von Programmen. B.Pagel und H.Six schreiben in ihrem Buch "Software Engineering" [Pagel&Six ,1994] folgendes zum Thema Dokumentation:

 

"Software besitzt mehrere Kommunikationsschnittstellen zur realen Welt: die Benutzungsschnittstelle zur Kommunikation mit dem Anwender, Systemschnittstellen zu anderen Softwareprodukten, den (kommentierten) Quelltext und schließlich die Dokumentation. Man unterscheidet zwei Arten von Softwaredokumenten:

 

 

Eine gute Dokumentation ist vollständig, konsistent zu der aktuell eingesetzten Version und verständlich für die intendierte Lesergruppe. Die Verständlichkeit der Dokumentation profitiert von einem strukturierten und logischen Aufbau, einem einheitlichen Format aller Einzeldokumente und einem sachlichen, präzisem Schreibstil.

Da alle Dokumente stets auf dem aktuellen Stand sein müssen und das Erstellen und Ändern der Dokumente sehr zeit- und kostenintensiv ist , werden immer stärker Werkzeuge zur automatischen Generierung der Dokumentation eingesetzt. Die Qualität der zur Zeit durch Tools erzeugbaren Dokumente entspricht jedoch noch nicht den erforderlichen Ansprüchen. Probleme bereiten z.B. die einheitliche und konsistente Gestaltung der Einzeldokumente (man denke an Querverweise) und die Kontrolle der üblicherweise viel zu großen Informationsflut derartiger Tools. Auf jeden Fall betrifft die Wartung der Software in hohem Maße auch die Wartung der Dokumentation, so daß zumindestens die Verwendung von komfortablen Textverarbeitungssystemen (z.B. Desktop Publshing-Systeme) angezeigt ist, um den Änderungsaufwand zu verringern." [Pagel&Six ,1994]

Das Dokumentieren ist meist an Normen und Vorgehensmodellen gebunden die unterschiedliche Muster beinhalten.

 

 

INDEX