Technische Dokumentation

Die TD umfasst die Erstellung der für den Systemadministrator notwendigen Unterlagen für Installation, Wartung, Backup etc. Desweiteren enthält sie eine Modulbeschreibung der wichtigsten Programmmodule, sowie umfassende Kommentare im Source-Code, die eine unkomplizierte Wartung der erstellten Software ermöglichen.

Hinzu kommen die in der Design-Phase und Analyse-Phase erstellten Dokumente, wie z. B. die Beschreibung der Datenbank mittels eines ERD (Entity Relationship Diagram).

Benutzerhandbücher

Die Erstellung der Benutzerhandbücher erfolgt im allgemeinen parallel zum Projektfortschritt, so dass zu jedem Zeitpunkt innerhalb des Projektes auch eine schriftliche Beschreibung der Module verfügbar ist. Das Erstellen der Dokumentation wird nicht durch die an der Programmierung beteiligten Personen durchgeführt. Der Autor der Dokumentation kann so leichter den Blickwinkel des Endbenutzers einnehmen. Die Erfahrung hat gezeigt, dass die Endbenutzer einen schnelleren und besseren Einstieg in das System erhalten.

Kurzanweisungen

Die Kurzanweisungen sind vor allem für den Personenkreis gedacht, der nur selten und vor allem nur bestimmte Funktionen des Systems bedient. In den Kurzanweisungen ist der Weg auf maximal einer DIN A4 Seite beschrieben, diese Funktionen möglichst schnell und effizient auszuführen.