Nächste Seite: Wartung und Pflege
Aufwärts: Test, Dokumentation, Wartung
Vorherige Seite: Test
  Inhalt
Dokumentation
Das Gesamtergebnis der Abwicklung
einer Programmieraufgabe ist die
Dokumentation. Diese wird mit mindestens zwei
verschiedenen Zielen entwickelt.
Einerseits dient sie den Anwendern, die das
Programm lediglich benutzen wollen.
Sie brauchen vor allem das Benutzerhandbuch,
das durch Anwendungsbeispiele
ergänzt sein sollte. Andererseits dient die Dokumentation bei der
Installierung und Pflege oder Weiterentwicklung des Programms den
Systementwicklern und Programmierern. Auch dort, wo Systementwickler,
Programmierer und Anwender ein und dieselbe Person sind,
ist der Wert einer
Dokumentation nicht zu unterschätzen. Es ist unglaublich,
wieviel Zeit und Mühe es kosten kann, das selbstgeschriebene
Programm nach Ablauf eines Jahres zu verstehen.
Für die Zusammenstellung der Dokumentation, die für
eine Übungsaufgabe erforderlich ist, hier eine Checkliste:
- Titelblatt mit Namen des Programms, Datum,
Ort, Namen von Verantwortlichen.
- Aufgabenstellung und funktionale
Spezifikation. Hierbei kann es nützlich
sein, Überlegungen und Entscheidungen aus
der Problemanalyse mit anzugeben,
beispielsweise den Grund, warum ein
bestimmtes Berechnungsverfahren nicht verwendet wurde.
- Struktogramme und Vereinbarungen.
Es ist nicht nur der erste Entwurf beizufügen, sondern
auch die notwendigen Verfeinerungen.
- Testvermerk, bei umfangreichen
Programmsystemen die Teststrategie
und eine Zusammenfassung des Testberichts. Wichtig ist
die Angabe, auf welchem
Rechner und unter welchem Betriebssystem das Programm
entwickelt und getestet wurde.
- Programmlisting und Ausgabedaten
eines Beispiellaufes.
- Für umfangreiche Programmsysteme ist ein
eigenes Benutzerhandbuch zu erstellen.
Nächste Seite: Wartung und Pflege
Aufwärts: Test, Dokumentation, Wartung
Vorherige Seite: Test
  Inhalt
Lars Tornow
2003-04-02