Dokumentationsrichtlinien

Ziel unserer Dokumentationsrichtlinien ist es, den einzelnen Personengruppen, die mit unseren Anwendungen arbeiten, einen möglichst präzisen und adäquaten Einblick darin zu geben. Die jeweilige Personengruppe soll dadurch ihre Aufgabe, die sie an oder mit unseren Anwendungen zu erfüllen haben, möglichst effizient bearbeiten können.

Als Personengruppen werden dabei die Nutzer, die Administratoren sowie unsere Entwickler gesehen.

Für die Nutzer gibt es ein Benutzerhandbuch, mit dessen Hilfe sie verschiedene Fragen, die eventuell zu unseren Anwendungen auftauchen, klären. Insbesondere gibt das Benutzerhandbuch auch eine kurze Einführung in die Nutzung unserer Anwendungen.

Für die Administratoren ist wichtig, wie sie unsere Anwendungen verwalten. Dies ist in der Dokumentation für die Administration der Software zu finden.

Hauptsächliches Augenmerk unserer Dokumentationsrichtlinien liegt auf der passenden Dokumentation unserer Anwendungen. Dies beginnt damit, dass unsere Quellcodes weitestgehend selbsterklärend und durch passende Kommentierungen an den entsprechenden Stellen den Entwicklern erweiterte Einblicke in die verschiedenen Programmstellen bieten. Dies erleichtert später die Nachvollziehbarkeit verschiedener Programmierentscheidungen. Zudem wird der Aufbau unserer Anwendungen anhand graphischer Notationen dargestellt, was den Zusammenhang der verschiedenen Programmkomponenten aufzeigt.

In der Dokumentation für unsere Entwickler fließen also alle Dokumente des Entwicklungsprozesses mit ein, wodurch sich für sie eine umfangreiche Übersicht über unsere Anwendungen ergibt.