Softwaredokumentation
aus Wikipedia, der freien Enzyklopädie
 |
Dieser Artikel oder Abschnitt bedarf einer Überarbeitung. Näheres ist auf der Diskussionsseite angegeben. Hilf bitte mit, ihn zu verbessern, und entferne anschließend diese Markierung. |
Mit Softwaredokumentation bezeichnet man die Dokumentation von Anwendungsprogrammen. Diese Dokumentation kann entweder so gemeint sein, dass ein Quellcode beschrieben wird, damit es später leichter ist, Fehler zu entdecken oder Änderungen vorzunehmen – oder es ist die Beschreibung des eigentlichen Softwareproduktes gemeint, also die Beschreibung der Benutzerschnittstelle und wie welche ihrer Teile anzuwenden sind.
[Bearbeiten] Benutzerdokumentation
Die Benutzerdokumentation dient dazu, dem Anwender die Benutzung des Programms zu erklären. Zu ihr gehören Handbücher, die Hilfefunktion im Programm selbst und Online-Dokumentationen. Sie sollte in einer für den Benutzer verständlichen Sprache abgefasst sein und Fachbegriffe in einem Glossar erklären.
[Bearbeiten] Code-Dokumentation
Beim Erstellen von Software reicht es – vor allem, wenn mehrere Personen beteiligt sind – oft nicht aus, nur den Quellcode zu schreiben: Es ist eine Beschreibung der einzelnen Funktionen usw. nötig. Die Beschreibung ist normalerweise sehr technisch orientiert und beschreibt APIs, Datenstrukturen oder Algorithmen. Wichtig ist hier, dass die Dokumentation des Codes alles wichtige erfasst, jedoch trotzdem so kurz wie möglich ist.
Oft werden mittlerweile Tools wie z. B. Doxygen oder Javadoc verwendet, um die Dokumentation aus dem Quelltext heraus automatisch zu erstellen. Dies geschieht mittels Kommentaren im Code, die von den Tools herausgesucht und zu einer Referenz zusammengestellt werden.
Dieser Ansatz ist bei vielen Programmierern sehr beliebt, da er es ermöglicht, die Dokumentation zu verfassen, während man am Quelltext arbeitet. Man kann hier daher auch gleich in der gewohnten Umgebung weiterarbeiten und muss sich wegen der Dokumentation nicht extra in ein neues komplexes Programm einarbeiten. Auf der anderen Seite ist es jedoch nur Programmierern möglich, die Dokumentation zu editieren. Manche sehen dies aber auch als Vorteil.
Bei der Dokumentation der Benutzerschnittstelle wird besonders auf die Dokumentation des Funktionsumfanges des Programms oder des Programmmodules Wert gelegt. Beim Erstellen einer solchen Dokumentation ist auf Sauberkeit und Vollständigkeit zu achten.
Zusätzlich zur eigentlichen Dokumentation können Links angelegt werden, die nähere Informationen der Prozedur oder der Klasse oder sonstigen Programmiersprachelementen geben.
