Wie wird die Anwendung dokumentiert?

1. Die technische Dokumentation beschreibt die Funktionen der Anwendung auf verschiedenen Detailebenen. Die Code-Dokumentation erläutert die Funktionalität des konkreten Quellcodes. Auf einer höheren Ebene erklären Technology Stacks sowie Informations- und Systemarchitekturen, wie die verschiedenen Code-Bausteine und Module die gesamte Anwendung aufbauen und welche Relationen und Abhängigkeiten innerhalb der Anwendung bestehen. Weitere Dokumentation zur Installation und Inbetriebnahme ist für zukünftige Administrator:innen wichtig. Diese Art von Dokumentationen helfen anderen Entwickler:innen später dabei, Fehler zu beheben oder die Anwendung zu erweitern.

2. Ein Benutzerhandbuch dokumentiert die Benutzung und den Umgang mit der Anwendung aus Sicht der Anwender:innen.