Was ist Software-Dokumentation? (Mit Bildern)
Software bezieht sich auf Routinen und Programme, die für ein Computersystem entwickelt wurden und die es ermöglichen, Aufgaben auszuführen oder auf andere Weise mit dem Computer zu interagieren. Die Software kann vom Hersteller als Systemkomponente bereitgestellt oder vom Hersteller oder von Dritten als separate Anwendung erstellt werden. Dokumentation ist eine Beschreibung eines Produkts und dessen Verwendung. Die Softwaredokumentation beschreibt Softwareanwendungen und deren Verwendung.
Gedruckte Softwaredokumentationen, die manchmal als Softwarehandbücher bezeichnet werden, sind oft wie ein Buch aufgebaut und enthalten eine Titelseite, ein Inhaltsverzeichnis, einen Text und einen Index. Sie enthalten häufig einige typische Komponenten. Die erste Komponente, die die meisten Benutzer benötigen, ist eine Installationsanleitung. Bei Bedarf werden separate Anleitungen für die verschiedenen Betriebssysteme angegeben, auf denen die Software ausgeführt wird. In der Installationsanleitung sind die zum Ausführen der Software erforderlichen Spezifikationen aufgeführt, einschließlich Betriebssystem (e), RAM, Festplattenspeicher, Internetverbindung und anderer Anforderungen oder Add-Ons, z. B. Peripheriegeräte. Darauf folgen schrittweise Anweisungen für die Installation, die beispielsweise von einer CD-ROM, einer DVD oder einem Download stammen können. Alle ungewöhnlichen Funktionen des Installationsprogramms und Erläuterungen zu benutzerdefinierten Installationsoptionen, z. B. alternative Speicherorte oder optimierte Installationen, werden im Allgemeinen erläutert.
Eine Kurzanleitung ist häufig der nächste Teil der verwendeten gedruckten Softwaredokumentation. Die Kurzanleitung enthält Informationen zu den Punkten, an denen die Installationsanleitung aufhört, und unterstützt den Benutzer beim Einstieg in die Software und in die grundlegenden Vorgänge. Dieser Abschnitt kann je nach Software auf verschiedene Arten angeordnet werden. Eine beliebte Methode für aufgabenorientierte Anwendungen ist eine projektbasierte Einführung, in der der Benutzer die Grundfunktionen der Software lernt, während er einige Mini-Lektionen absolviert.
Zu den weiteren Elementen, die in der gedruckten Softwaredokumentation zu finden sind, gehört ein vollständiger Überblick über die Funktionen, wobei der Schwerpunkt auf den neuen Funktionen der neuesten Version liegt. eine Liste der Updates seit den Vorgängerversionen, möglicherweise einschließlich der behobenen Fehler; Informationen darüber, wie Sie technischen Support erhalten können; Erklärungen zu Fehlermeldungen; und Informationen für fortgeschrittene oder "Power" -Nutzer. Spiele und andere Softwareanwendungen enthalten möglicherweise Spickzettel oder Hinweise in ihrer Dokumentation.
Gedruckte Software-Dokumentation ist nicht die einzige. Erstens kann die gedruckte Dokumentation auch online oder als PDF verfügbar sein. Zusätzliche Dokumentation kann auch in Form von QuickInfos und Hilfebildschirmen in der Anwendung selbst, FAQs - Listen mit häufig gestellten Fragen zusammen mit Antworten, durchsuchbaren Artikeln, Web-Schulungen, Videos und anderen Formaten verfügbar sein.
Die Qualität der Softwaredokumentation ist sehr unterschiedlich. Dies gilt insbesondere für Softwarehandbücher. Die guten können ausgezeichnet sein, während diejenigen, die nicht gut ausgeführt sind, Benutzer mit vielen Fragen lassen können. Es gibt auch Benutzer, die sich nicht die Mühe machen, die Dokumentation zu durchsuchen, bevor sie in den Foren des Softwareherstellers Fragen stellen.