Verschiedene Arten der Softwaredokumentation

Die Bezeichnung Dokumentation ist im Bereich der Software als eine Art Sammelbegriff für viele unterschiedliche Dokumente anzusehen. Sie alle eint, dass sie für unterschiedliche Zielgruppen einen Anhaltspunkt zum Aufbau, der Funktion, dem Nutzen oder der Entstehung der betrachteten Software bieten. Jedoch werden nicht immer einheitliche Begriffe für die unterschiedlichen Dokumentationstypen verwendet. softwaredokumentation

Prozessdokumentation vs. Produktdokumentation

Die wesentliche Unterscheidung verschiedener Dokumentationsarten liegt darin, ob es sich um eine Prozessdokumentation oder eine Produktdokumentation handelt. Eine Prozessdokumentation beschreibt den Verlauf des Softwareprojekts, von der Entstehung bis zum Ende der Softwarewartung. Sie dient als maßgeblicher Leitfaden bei der Entwicklung des Systems und stellt sicher, das internes Wissen festgehalten wird. Das Ziel der Prozessdokumentation ist das Strukturieren und Organisieren der Softwareentwicklung. Gleichzeitig hilft sie dabei das Projekt transparenter zu machen und reduziert den Verwaltungsaufwand. Typische Dokumente, die zur Prozessdokumentation gezählt werden, sind Vorhersagen, Zeitpläne sowie Organisations- und Prozessstandards. Viele Prozessdokumente sind schnell veraltet, da sie nur für eine spezifische Phase des Entwicklungsprozesses benötigt werden. Nichtsdestotrotz können sie bei der Implementierung ähnlicher Aufgaben oder der zukünftigen Wartung nützlich sein. Die Produktdokumentation beschreibt das zu entwickelnde Softwareprodukt. Dabei wird ebenfalls in zwei Unterarten der Produktdokumentation unterschieden; die Nutzerdokumentation und die Systemdokumentation.

Die Nutzerdokumentation

Eine Nutzerdokumentation beschreibt für unterschiedliche Anwendergruppen wie die Software zu installieren, zu bedienen und zu warten ist. Die bekannteste Art der Nutzerdokumentation ist die Endnutzerdokumentation, oftmals auch Benutzerhandbuch genannt. Die Zielgruppe der zu erstellenden Software entscheidet dabei maßgeblich den Inhalt und Umfang der Dokumentation. Bei großen Softwareprojekten kann es sich als sehr hilfreich erweisen die Dokumentation an spezialisierte Unternehmen oder eine interne Fachabteilung auszulagern. Dadurch können juristische Probleme vermieden werden. Generell gilt jedoch, dass der Fokus auf anschaulichen Beispielen anstatt auf technischen Feinheiten liegen sollte. Eine weitere Form der Nutzerdokumentation, die häufig nicht so viel Aufmerksamkeit erfährt wie die Endnutzerdokumentation, ist die Administratorendokumentation. Typischerweise umfasst diese Dokumentation alle Informationen, die zur Installation und Wartung der Software notwendig sind. Die Dokumentation erklärt unterschiedliche Verhaltensweisen des Systems in unterschiedlichen Umgebungen und bei der Interaktion mit unterschiedlichen anderen Systemen. Außerdem gibt sie Aufschluss über notwendige Voraussetzungen sowie eventuelle Fehlermeldungen.

Die Systemdokumentation

Die Systemdokumentation umfasst alle Dokumente, die das Softwaresystem beschreiben. Die folgenden Elemente sind häufiger Bestandteil einer solchen Dokumentation:
  • Anforderungsdokumentation,
  • Architekturdokumentation,
  • Quellcodedokumentation,
  • Qualitätssicherungsdokumentation,
  • Schnittstellendokumentation
Unter dem Bereich der Anforderungsdokumentation werden Informationen zur Funktionalität der Software zusammengefasst. Darunter zählen unter anderem User Stories und Use Cases. Damit das Dokument übersichtlich bleibt, sollten nur die wesentlichen Informationen zum Zweck der Software, ihren Eigenschaften, ihren Funktionalitäten und ihrem Verhalten enthalten sein. In der Dokumentation der Architektur werden die wichtigsten Entscheidungen zum Aufbau und Design der Software festgehalten und geplante Komponenten sowie deren Bedeutung aufgelistet. Ein weiterer technischer Abschnitt ist die Dokumentation des Quellcodes. Im Dokument ist für Entwickler erklärt, wie der Code funktioniert. Das Dokument zur Qualitätssicherungsdokumentation enthält nicht nur Testfälle, die die geforderte Funktion der Software sicherstellen, sondern auch Verfahren, die dabei zum Einsatz kommen. In der Schnittstellendokumentation sind alle im System vorhandenen und vom System genutzten Schnittstellen zusammengefasst. Die Dokumentation liefert einen Überblick über die Möglichkeiten der Software.

Fazit

Bei der Entwicklung von Software gilt es jeden Bereich des Entwicklungsprozesses angemessen zu dokumentieren. Sowohl keine Dokumentation als auch übermäßige Dokumentation schaden dem Projektverlauf. Je nach System liegt der Fokus auf unterschiedlichen Bereichen der Dokumentation. Zu jedem Zeitpunkt sollte die Dokumentation aktuell gehalten werden und den momentanen Entwicklungsstand widerspiegeln. Sysparency bietet die Möglichkeit Dokumentationen automatisiert und gesetzeskonform zu erstellen und so ihr Team bei der Softwareentwicklung zu entlasten. Sowohl technische, funktionale als auch strukturelle Dokumentationen sind möglich. Dabei ist es egal, ob es sich um eine aktuelle Entwicklung oder die Nachdokumentation von bereits existierender Software handelt.

Kostenlose News erhalten

Melden Sie sich zu unserem Newsletter an und erhalten zu Infos zu TOP-Themen.