SE: Dokumentation

Leider Gott sei Dank gehört das Dokumentieren zum Programmieren, wie das Fieberthermometer in den Allerwertesten. Aber wie stellt man das am Besten an? Bei mir ging es heute um eine Datenbank, die über ein Formular von den Nutzern befüllt werden muss. Eigentlich eine ganz einfache Geschichte, aber es waren tatsächlich vier verschiedene Dokumente nötig - zumindest meiner Einschätzung nach.

Es ist einerseits wichtig, eine Nutzer-Dokumentation anzufertigen, in der leicht verständlich erklärt wird, wie das Programm zu bedienen ist. Zusätzlich brauchen die Nutzer eine gute Übersicht, über welche man direkt nachschlagen kann, welche Information in welches Feld eingetragen werden muss. Ich nenne das hier einfach mal die Bedien- und die Inhaltsebene.

Auf der anderen Seite - und nicht minder wichtig - ist eine separate Dokumenation für die Verwalter der Anwendung. Und letztlich will ja auch der Entwickler in zwei Wochen noch in endlicher Zeit verstehen, mit welchen Tricks :-) er die definitiv aufgetretenen Probleme gelöst hat.

Wie seht ihr das?

Weblinks:

• Woran Sie gute Technische Dokumentation erkennen: Die logische Fortsetzung meines Beitrags. Es geht auf dieser Seite weniger darum, welche Dokumente Sie brauchen, sondern wie Sie die Dokumentation aufbauen und gestalten sollten.