Die Bezeichnung Dokumentation ist im Bereich der Software ein Sammelbegriff für viele unterschiedliche Dokumente. Sie alle eint, dass sie für unterschiedliche Zielgruppen einen Anhaltspunkt zum Aufbau, zur Funktion, zum Nutzen oder zur Entstehung der betrachteten Software bieten. Einheitliche Begriffe für die einzelnen Dokumentationsarten gibt es allerdings nicht, deshalb lohnt sich eine Ordnung.
Prozessdokumentation vs. Produktdokumentation
Die wesentliche Unterscheidung liegt darin, ob eine Dokumentation den Prozess oder das Produkt beschreibt.
Eine Prozessdokumentation beschreibt den Verlauf des Softwareprojekts, von der Entstehung bis zum Ende der Wartung. Sie dient als Leitfaden bei der Entwicklung des Systems und stellt sicher, dass internes Wissen festgehalten wird. Ihr Ziel ist, die Softwareentwicklung zu strukturieren und zu organisieren, das Projekt transparenter zu machen und den Verwaltungsaufwand zu senken. Typische Prozessdokumente sind Vorhersagen, Zeitpläne sowie Organisations- und Prozessstandards. Viele davon veralten schnell, weil sie nur für eine bestimmte Phase gebraucht werden. Nützlich bleiben sie, wenn eine ähnliche Aufgabe ansteht oder in der späteren Wartung.
Die Produktdokumentation beschreibt das Softwareprodukt selbst. Sie teilt sich in zwei Unterarten: die Nutzerdokumentation und die Systemdokumentation.
Die Nutzerdokumentation
Eine Nutzerdokumentation beschreibt für die verschiedenen Anwendergruppen, wie die Software installiert, bedient und gewartet wird. Die bekannteste Form ist die Endnutzerdokumentation, meist Benutzerhandbuch genannt. Die Zielgruppe entscheidet über Inhalt und Umfang. Bei großen Projekten kann es helfen, das Schreiben an ein spezialisiertes Unternehmen oder eine interne Fachabteilung zu geben; in jedem Fall sollte der Fokus auf anschaulichen Beispielen liegen, nicht auf technischen Feinheiten.
Eine zweite Form, die deutlich weniger Aufmerksamkeit bekommt, ist die Administratorendokumentation. Sie enthält alles, was zur Installation und Wartung nötig ist: wie sich das System in verschiedenen Umgebungen und im Zusammenspiel mit anderen Systemen verhält, welche Voraussetzungen gelten und was die Fehlermeldungen bedeuten.
Die Systemdokumentation
Die Systemdokumentation umfasst alle Dokumente, die das Softwaresystem selbst beschreiben. Dazu gehören üblicherweise:
- Anforderungsdokumentation,
- Architekturdokumentation,
- Quellcodedokumentation,
- Qualitätssicherungsdokumentation,
- Schnittstellendokumentation.
Die Anforderungsdokumentation fasst zusammen, was die Software tut: User Stories, Use Cases und die wesentlichen Informationen zu Zweck, Eigenschaften, Funktionen und Verhalten. Die Architekturdokumentation hält die wichtigsten Entscheidungen zu Aufbau und Design fest und listet die geplanten Komponenten samt ihrer Bedeutung. Die Quellcodedokumentation erklärt Entwicklern, wie der Code funktioniert. Die Qualitätssicherungsdokumentation enthält die Testfälle, die die geforderte Funktion sicherstellen, und die Verfahren, mit denen sie ausgeführt werden. Die Schnittstellendokumentation fasst alle Schnittstellen zusammen, die das System anbietet und nutzt, und gibt einen Überblick über die Möglichkeiten der Software.
Fazit
Jeder Bereich des Entwicklungsprozesses braucht eine angemessene Dokumentation. Zu wenig schadet dem Projekt genauso wie zu viel. Je nach System liegt der Fokus anders, und was geschrieben wird, muss aktuell gehalten werden und den tatsächlichen Stand der Software widerspiegeln.
Genau daran scheitert die meiste Dokumentation, denn von Hand geschriebene Dokumente altern vom Tag ihrer Fertigstellung an. Sysparency geht einen anderen Weg: Systemdokumentation, fachliche Erklärungen und Schnittstelleninventar werden aus dem Quellcode erzeugt und bei jedem Upload neu generiert, sie bleiben also nie hinter dem System zurück. Das gilt für Software, die gerade entwickelt wird, ebenso wie für Systeme, die seit Jahrzehnten ohne Dokumentation laufen. Bei SAP-Custom-Code bekommt jedes Programm, jede Tabelle, jede Schnittstelle und jeder Screen eine eigene Seite, eingeordnet in Modul und Geschäftsprozess, belegt bis zur Zeile.
Erstveröffentlichung im Januar 2021, überarbeitet im September 2026.