Was ist Softwaredokumentation?

Software bezieht sich auf Routinen und Programme, die für ein Computersystem entwickelt wurden, mit dem die Verwendung Aufgaben ausgeführt oder auf andere Weise mit dem Computer interagiert.Die Software kann vom Hersteller als Systemkomponente bereitgestellt oder vom Hersteller oder Dritten als separate Anwendungen erstellt werden. Dokumentation ist eine Beschreibung eines Produkts und wie man es verwendet.Software -Dokumentation beschreibt Softwareanwendungen und die Verwendung.Einige typische Komponenten.Die erste Komponente, die die meisten Benutzer benötigen, ist ein Installationshandbuch, und für die verschiedenen Betriebssysteme, an denen die Software nach Bedarf arbeitet, werden separate Anleitungen angegeben.Der Installationshandbuch listet die Spezifikationen auf, die für die Ausführung der Software erforderlich sind, einschließlich Computerbetriebssystemen, RAM, Festplattenspeicher, Internetverbindung und anderen Anforderungen oder Add-Ons wie Peripheriegeräten.Dies folgt schrittweise Anweisungen zur Installation, die beispielsweise von einer CD-ROM, einer DVD oder einem Download stammen kann.Ungewöhnliche Merkmale des Installationsprogramms und Erläuterung der benutzerdefinierten Installationsoptionen, z. B. alternativen Stellen oder optimierten Installationen, werden im Allgemeinen erläutert.

Ein Anleitung „Schnellstart“ ist häufig der nächste Teil der verwendeten gedruckten Softwaredokumentation.Der Schnellstarthandbuch, an dem der Installationshandbuch zurücklässt, hilft dem Benutzer, mit der Software und seinen grundlegenden Vorgängen zu beginnen.Dieser Abschnitt kann auf verschiedene Arten angeordnet werden, wie es zur jeweiligen Software passt.Eine beliebte Methode für aufgabenorientierte Anwendungen ist eine projektbasierte Einführung, bei der der Benutzer die grundlegende Funktionalität der Software lernt, während er einige Mini-Lessons absolviert.

Weitere Elemente, die man in gedruckten Software-Dokumentation erwarten würde, umfassen eine vollständige Ausführung der Funktionen, wobei der Schwerpunkt auf Funktionen der neuesten Version ist.eine Liste von Updates seit den vorherigen Versionen, möglicherweise einschließlich Fehler, die behoben sind.Informationen über den technischen Support;Erklärungen von Fehlermeldungen;und Informationen für fortgeschrittene oder „Power“ -Nutzer.Spiele und andere Softwareanwendungen können Cheat -Blätter oder Hinweise in ihre Dokumentation enthalten.

Gedruckte Softwaredokumentation ist nicht die einzige Art.Zunächst kann die gedruckte Dokumentation auch online oder als PDF verfügbar sein.Eine zusätzliche Dokumentation kann auch in Form von Tool -Tipps verfügbar sein und Bildschirme innerhalb der Anwendung selbst, FAQs Mdash helfen.Listen der häufig gestellten Fragen sowie Antworten, durchsuchbare Artikel, Webtraining, Videos und andere Formate.

Softwaredokumentation ist in der Qualität sehr unterschiedlich, und 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 hinterlassen können.Es gibt auch Benutzer, die sich nicht die Mühe machen, die Dokumentation zu durchsuchen, bevor sie Fragen in den Foren des Softwareherstellers stellen.