Softwaredokumentation: Unterschied zwischen den Versionen

Aktuelle Version vom 21. März 2010, 13:45 Uhr

Als Softwaredokumentation wird die Dokumentation einer Software (z. B. eines Anwendungsprogramms). Es gibt zwei Hauparten der Softwaredokumentation:

die Beschreibung des Quellcodes, damit es später leichter ist, Fehler zu entdecken oder Änderungen vorzunehmen.
die Benutzerdokumentation beschreibt die Benutzerschnittstelle, erklärt also dem Benutzer die Anwendung des Programms. Zu ihr gehören Handbücher, die Hilfefunktion im Programm selbst (z. B. Manpages) und Online-Dokumentationen. Sie sollte in einer für den Benutzer verständlichen Sprache abgefasst sein und Fachbegriffe in einem Glossar erklären.

Herausgeber	Sprache	Webseitentitel	Anmerkungen
Wikipedia	ger	Softwaredokumentation^wbm	Enzyklopädischer Artikel

@@ Zeile 1: / Zeile 1: @@
 Als <b>Softwaredokumentation</b> wird die [[Dokumentation]] einer [[Software]] (z. B. eines [[Anwendungsprogramm]]s). Es gibt zwei Hauparten der Softwaredokumentation:
 * die Beschreibung des [[Quellcode]]s, damit es später leichter ist, Fehler zu entdecken oder Änderungen vorzunehmen.
-* die <b>Benutzerdokumentation</b> beschreibt die Benutzerschnittstelle, erklärt also dem Benutzer die Anwendung des Programms. Zu ihr gehören [[Handbuch|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.
+* die <b>Benutzerdokumentation</b> beschreibt die Benutzerschnittstelle, erklärt also dem Benutzer die Anwendung des Programms. Zu ihr gehören Handbücher, die Hilfefunktion im Programm selbst (z. B. [[Manpages]]) und Online-Dokumentationen. Sie sollte in einer für den Benutzer verständlichen Sprache abgefasst sein und Fachbegriffe in einem Glossar erklären.
 == Weblinks ==