Softwaredokumentation

Aus Mikiwiki
Version vom 21. März 2010, 11:45 Uhr von Michi (Diskussion | Beiträge)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Zur Navigation springen Zur Suche springen

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.

Weblinks

Herausgeber Sprache Webseitentitel Anmerkungen
Wikipedia ger Softwaredokumentationwbm Enzyklopädischer Artikel