Die Bedeutung der Softwaredokumentation
Definition der Softwaredokumentation
Die technischen Handbücher, Benutzerhandbücher und sonstigen Anweisungen, die die Verwendung und den Betrieb eines Softwareprodukts oder einer Software-Dienstleistung erleichtern, stellen die Softwaredokumentation dar, die (falls erforderlich) den Quellcode, Fehlercodes und deren Bedeutung enthalten kann. Es kann in elektronischer Form, als PDF- oder CD-Datei oder als Buch vorliegen.
Standards für die Softwaredokumentation
Das Institut für Elektrotechnik und Elektronik (IEEE) hat Standards für die Dokumentation der Softwareindustrie erarbeitet. Es heißt IEEE 1063-2001, "Standard für Software-Benutzerdokumentation" und beschreibt den Inhalt, die Architektur und die Wichtigkeit eines Handbuchs für Software-Dokumentation. Die Internationale Organisation für Normung und die Internationale Elektrotechnische Kommission (ISO und IEC, idem) haben ebenfalls Standards für die Softwaredokumentation festgelegt. Ihre Standards heißen ISO / IEC 18019-2004 und ISO / IEC TR 9294. Sie befassen sich mit Dokumentation bzw. Softwaremanagement. Jeder dieser Standards betont, dass die Dokumentation ein wesentlicher Bestandteil des Software-Lebenszyklus ist.
Funktionen der Softwaredokumentation
Alle Software-Lebenszyklusprozesse bei der Entwicklung einer Software werden als Dokumentation aufgezeichnet. Die Dokumentation dient als schriftliche Information zur Definition von Anforderungen, allgemeinen Systemspezifikationen, Spezifikation jeder Komponente und umfassenden Prüf- und Wartungsplänen. Konfigurationsmanagement-Tools sind auch in der Softwaredokumentation sehr nützlich.
Software-Dokumentation für Entwickler
Die Bedeutung der Dokumentation für Entwickler liegt in der Tatsache, dass die erste Informationen über den Betrieb des Softwaresystems enthält. Diese Informationen ermöglichen die Reproduktion der Software oder deren Anpassung zur Wartung. Die Art der dokumentierten Informationen ist dem Softwareunternehmen normalerweise viel wert. Solche Informationen könnten verloren gehen, wenn sie nicht dokumentiert werden, da Entwickler kommen und gehen.
Softwaredokumentation für Endbenutzer
Die Endbenutzerhandbücher erleichtern die Interaktion des Benutzers mit dem Computer. Ein Trainingshandbuch ist ein Beispiel für ein benutzerorientiertes Handbuch. Dies verkürzt die Einarbeitungszeit für den produktiven Einsatz der Software und spart dem Endbenutzer viel Geld. Die Dokumente des Endbenutzers können auch ein Referenzhandbuch sein, in dem die Bedienung des Systems beschrieben wird, oder ein Leitfaden für Systemadministratoren, in dem die Bedienung und Wartung des Systems beschrieben wird.
