Softwaredokumentation

Eine Dokumentation ist eine geordnete Zusammenstellung und Nutzbarmachung von Informationen zur weiteren Verwendung.¹ Für die Softwaredokumentation gibt es verschiedene Richtlinien und sie kann sogar die Grundlage zur Kauf- und Einsatzentscheidung bilden.

Eine Softwaredokumentation kann als eine Art Gebrauchsanleitung für Softwareprodukte verstanden werden. Für die Erstellung von Anleitungen gibt es die Norm DIN EN 62079 (VDE 0039). Diese Norm beschreibt neben Grundlagen detaillierte Anforderungen für den Entwurf und die Erstellung von technischen Anleitungen und Dokumentationen.

Die Softwaredokumentation wird beispielsweise als Online-Hilfe zusammen mit der Software an die Benutzer ausgeliefert. Sie sollte prozessorientiert strukturiert und leichten und schnellen Zugang zur gesuchten Information sicherstellen.²

Nach Wikipedia besteht eine vollständige Softwaredokumentation aus folgenden Teilen: ³

• Programmiererdokumentation (Beschreibung des Quellcodes)
• Methodendokumentation

  Beschreibung der mathematischen Algorithmen, technisch-wissenschaftliche oder kaufmännische Verfahren.

• Installationsdokumentation
  • Beschreibung der erforderlichen Hardware, Software, mögliche Betriebssysteme, Standardbibliotheken oder Laufzeitsysteme
  • Erläuterung der Installation, Updates und De-Installation
• Benutzerdokumentation (Handbuch, Online-Hilfe etc.)
• Datendokumentation (Formate, Datentypen, Beschränkungen, Import- und Exportschnittstellen)
• Testdokumentation
• Entwicklungsdokumentation

Diese Dokumentationsbestandteile sind bei einer Individualsoftware sehr zweckmäßig. Bei einer Standardsoftware ist es in den meisten Fällen eher unüblich und unwahrscheinlich, den dokumentierten Quellcode mit ausgeliefert zu bekommen.⁴ Üblicherweise erhält man zusammen mit einer Standardsoftware Handbücher, Online-Dokumentationen,⁵ Test- und Demoversionen, Schnittstellendokumentationen, usw. Diese Bestandteile werden in den folgenden Abschnitten näher beschrieben.

Ein Kriterium der Softwaredokumenation stellt auch die Community bzw. deren Größe (z.B. Foren) dar.⁶ Hier finden Sie in der Regel Tipps und Tricks, FAQs, aber auch Hilfe bei Updates, Installationsproblemen und ähnlichem. Je größer die Community, desto wahrscheinlicher ist eine schnelle, kompetente und kostengünstige Lösung für ein Problem zu finden.