Softwaredokumentation

Nach der Entwicklung der Software folgt die Dokumentation

Wer schreibt schon gern Dokumentationen? Wir. Weil wir gelernt haben, dass eine gut dokumentierte Software sich viel leichter weiterentwickeln lässt als eine undokumentierte Software. Wie detailliert die Dokumentationen erstellt werden sollen entscheiden dabei Sie.

Gerade bei komplexen Softwareprojekten empfiehlt es sich, dass gewisse Bestandteile der Software sauber dokumentiert werden. Das bezieht sich vor allem auf die Datenstrukturen innerhalb der Software

Kommentierung des Quellcodes

Den Quellcode der Software bauen wir selbstverständlich so auf, dass es neuen Entwicklern leicht fällt sich in das bestehende Projekt einzuarbeiten. Ebenso achten wir auf saubere Kommentare für einzelne Funktionen, insofern diese hilfreich sind.

Dokumentation der Architektur

Die Architektur muss ebenfalls gewissenhaft dokumentiert werden. Gerade bei Client-/Server Systemen lohnt sich dieser Aufwand, bei dem die einzelnen Bestandteile der Architektur genauestens aufgeschlüsselt sind. Fällt einmal eine Datenbank oder ein Server aus, ist das Problem mit einer guten Dokumentation meist schnell behoben.

Programm Hilfe

Die berühmte F1-Taste startet in den meisten Programmen die Programm-Hilfe und wird von vielen Nutzern intensiv genutzt. Der Vorteil liegt ganz klar darin, dass der Anwender nicht lange suchen muss, sondern an den richtigen Stellen eine Hilfestellung zu den Funktionen bekommt.

Benutzerhandbücher

Das Benutzerhandbuch stellt die Oberklasse der Dokumentationen dar. Die meisten Anwender sind beeindruckt, wenn Sie zu einer tadellos funktionierenden Software ein schickes Benutzerhandbuch gereicht bekommen. Ganz egal ob als PDF oder in gedruckter Form - Gerade Neuanwender werden Ihnen diesen Aufwand danken.