Dokumentation

Benutzerhandbücher weisen die meist technisch wenig versierten Endbenutzer ein wie sie Ihre Software korrekt nutzen. Dabei werden sie durch jeden Bereich der für sie relevant ist geführt, oft bebildert, und jede Funktion wird so detailreich wie nötig beschrieben.

Im Zuge meiner Ausbildung wurde ich diszipliniert Benutzerhandbücher anzufertigen, sofern gewünscht, um die Arbeit für den Endkunden so einfach wie möglich zu gestallten.

Bereits vor der eigentlichen Projektausführung beginnt die Projektdokumenatation. Sie ist ausschlaggebend für den Erfolg eines Projektes, da mit ihr sowohl der Projektverlauf dokumentiert wird als auch die Wünsche des Kunden festgehalten werden. Sie ist Zeugnis über das gesammte Projekt und dessen verlauf.

Um die Wichtigkeit dieses Dokumentes zu signalisieren bestand meine Abschlussprüfung zum Fachinformatiker zu 50% in der Erstellung dieser, somit war diese auch ausschlaggebend über die Bewertung meines Abschlusses, dessen theoretischen Part mit 99% abschloss.

Die Codedokumentation, damit sind Kommentare im Programmcode gemeint, ist eine strikt technische Dokumentation die Entwicklern hilft den Ablauf des Programmcodes zu verstehen, sodass es Programmierern, welche sich in das Projekt einarbeiten eine starke erleichterung im Einstieg haben und die Applikation schnell kennenlernen und verstehen – diese somit zeitnah weiterentwickeln können.

Im laufe der Jahre habe ich mir angewöhnt meinen Sourcecode bestmöglich, aber im Rahmen, zu dokumentieren. Sodass Zeitaufwand und Wert der Dokumentation im angemessenen Verhältnis stehen.