Kostenlose Schritt für Schritt Anweisungen 
Ist der Quellcode besonders lang, kann er in Form einer Hilfedatei dokumentiert werden, die indiziert und mit Stichworten durchsucht werden kann. Dies ist insbesondere für Anwendungen von Vorteil, bei denen die Programmlogik über viele Seiten fragmentiert ist und eine Reihe zusätzlicher Dateien enthält, wie z. B. bei bestimmten Webanwendungen. Einige Programmiersprachen wie Java und .NET Framework (Visual Basic.NET, C#), haben eigene Standards für die Dokumentation des Codes. Befolgen Sie in diesen Fällen die Standards, wie viel von der Dokumentation in den Quellcode aufgenommen werden sollte. 
Textverarbeitungsprogramme für Microsoft Word reichen aus, um separate Textdateien für die Dokumentation zu erstellen, solange die Dokumentation relativ kurz und einfach ist. Für lange, komplexe Textdateien bevorzugen viele technische Redakteure ein Dokumentationstool wie Adobe FrameMaker. Hilfedateien zum Dokumentieren des Quellcodes können mit jedem Hilfeerstellungstool wie RoboHelp, Help and Manual, Doc-To-Help, MadCap Flare oder HelpLogix erstellt werden. 
Sehen Sie sich die Funktionen Ihrer potenziellen Benutzer an. Ein Systemadministrator ist wahrscheinlich ein Experte für eine Reihe von Softwareanwendungen, während ein Dateneingabesachbearbeiter wahrscheinlich nur die Anwendung kennt, mit der er oder sie Daten eingibt. Schauen Sie sich die Benutzer selbst an. Während Berufsbezeichnungen normalerweise angeben, was Menschen tun, kann es erhebliche Unterschiede bei der Besetzung bestimmter Positionen innerhalb einer Organisation geben. Durch die Befragung potenzieller Nutzer können Sie sich ein Bild davon machen, ob Ihr Eindruck von deren Position richtig ist oder nicht. Vorhandene Dokumentation anzeigen. Dokumentationen für frühere Versionen der Software (sowie Funktionsspezifikationen) geben einen Hinweis darauf, was der Benutzer wissen muss, um das Programm zu verwenden. Denken Sie jedoch daran, dass Endbenutzer nicht wirklich daran interessiert sind, wie das Programm funktioniert, sondern was es für sie tun kann. Bestimmen Sie die Aufgaben, die erledigt werden müssen, um eine Aufgabe abzuschließen, und welche Aufgaben erledigt werden müssen, bevor diese Aufgaben ausgeführt werden können. 
Ein Referenzhandbuch widmet sich der Erläuterung der einzelnen Funktionen einer Softwareanwendung (Schaltflächen, Registerkarten, Felder und Dialogfelder) und ihrer Funktionsweise. Viele Hilfedateien sind in diesem Format geschrieben, insbesondere kontextsensitive Hilfe, die ein relevantes Thema anzeigt, wenn ein Benutzer auf einem bestimmten Bildschirm auf die Schaltfläche Hilfe klickt. Ein Benutzerhandbuch erklärt, wie Sie die Software verwenden, um eine bestimmte Aufgabe auszuführen. Benutzerhandbücher werden oft als gedruckte Anleitungen oder PDFs formatiert, obwohl einige Hilfedateien Themen zur Durchführung bestimmter Aufgaben enthalten. (Diese Hilfethemen sind normalerweise nicht kontextabhängig, obwohl sie mit Themen verknüpft sein können, die.) Benutzerhandbücher werden oft in Form von Tutorials angeboten, mit einer Übersicht über die auszuführenden Aufgaben in der Einführung und Anweisungen in nummerierten Schritten. 
Hilfedateien und Online-Hilfe sollten indiziert und mit Schlüsselwörtern durchsuchbar sein, damit Benutzer die benötigten Informationen schnell finden können. Während Hilfedatei-Generatoren automatisch Indizes generieren können, ist es oft besser, den Index manuell zu erstellen, wobei Begriffe verwendet werden, nach denen Benutzer normalerweise suchen. 
Schreiben von dokumentationen für software
Eine gute Softwaredokumentation, sei es ein Spezifikationsdokument für Programmierer und Tester, ein technisches Dokument für Kollegen oder Softwarehandbücher und Hilfedateien für Endbenutzer, hilft dem Menschen, der mit der Software arbeiten muss, alle ihre Eigenschaften und Funktionen zu verstehen. Eine gute Softwaredokumentation ist spezifisch, prägnant und relevant und liefert dem Benutzer der Software alle wichtigen Informationen. Nachfolgend finden Sie Anweisungen zum Erstellen von Softwaredokumentationen für technische Benutzer und Endbenutzer.
Schritte
Methode 1 von 2: Softwaredokumentation für technische Benutzer schreiben
1. Entscheiden Sie, welche Informationen enthalten sein sollen. Softwarespezifikationen dienen als Leitfaden für Benutzeroberflächendesigner, Programmierer, die den Code schreiben, und Tester, die überprüfen, ob die Software wie beabsichtigt funktioniert. Die genauen Informationen hängen vom jeweiligen Programm ab, können jedoch Folgendes umfassen:
- Die wichtigsten Dateien innerhalb der Anwendung. Dies können Dateien sein, die vom Entwicklungsteam erstellt wurden, Datenbanken, auf die während des Programmbetriebs zugegriffen wird, und Dienstprogramme von Drittanbietern.
- Funktionen und Unterprogramme. Dies ist eine Erklärung dafür, was jede Funktion oder Subroutine tut, einschließlich aller Eingabe- und Ausgabewerte.
- Programmvariablen und Konstanten und wie sie in der Anwendung verwendet werden.
- Die allgemeine Programmstruktur. Bei einer plattenbasierten Anwendung könnte dies eine Beschreibung der einzelnen Module und Bibliotheken des Programms sein, während es bei einer Webanwendung beschreiben könnte, welche Seiten welche Dateien verwenden.
2. Entscheiden Sie, wie viel Dokumentation in den Programmcode aufgenommen und wie viel getrennt gehalten werden soll. Je mehr technische Dokumentation bereits im Quellcode des Programms entwickelt wurde, desto einfacher ist es, diese zusammen mit dem Code zu aktualisieren und zu pflegen sowie verschiedene Versionen der Originalanwendung zu dokumentieren. Die Dokumentation im Quellcode sollte zumindest den Zweck von Funktionen, Unterprogrammen, Variablen und Konstanten erläutern.
3. Wählen Sie das richtige Dokumentationstool. Dies wird zum Teil durch die Sprache bestimmt, in der der Code geschrieben ist (wie C++, C#, Visual Basic, Java oder PHP), da für diese und andere Sprachen spezifische Tools existieren. In anderen Fällen bestimmt die Art der erforderlichen Dokumentation, welches Werkzeug zu verwenden ist.
Methode 2 von 2: Softwaredokumentation für Endbenutzer schreiben
1. Bestimmen Sie die geschäftlichen Gründe für Ihre Dokumentation. Während der funktionale Grund für die Dokumentation von Software darin besteht, Benutzern zu helfen, die Anwendung zu verstehen, gibt es andere Gründe, wie die Unterstützung bei der Vermarktung der Software, die Verbesserung des Unternehmensimages und vor allem die Reduzierung der Kosten für den technischen Support. In einigen Fällen ist die Dokumentation erforderlich, um bestimmte Vorschriften oder andere gesetzliche Anforderungen zu erfüllen.
- Software-Dokumentation sollte jedoch keinesfalls ein Ersatz für schlechtes Interface-Design sein. Wenn eine Anwendung Dokumentationsseiten als Anleitung erfordert, ist es besser, das Bildschirmdesign auf etwas intuitiveres zu ändern.
2. Verstehen Sie das Publikum, für das Sie die Dokumentation schreiben. In den meisten Fällen haben Softwarebenutzer nur wenige Computerkenntnisse, die über die Aufgaben hinausgehen, die sie mit den von ihnen verwendeten Anwendungen ausführen können. Es gibt mehrere Möglichkeiten, um festzustellen, was sie benötigen und wie Ihre Dokumentation sie erfüllen kann.
3. Bestimmen Sie das richtige Format für die Dokumentation. Die Softwaredokumentation kann in 1 von 2 Formaten strukturiert werden: das Handbuch und das Benutzerhandbuch. Manchmal ist eine Kombination beider Formate der beste Ansatz.
4. Entscheiden Sie, welche Form die Dokumentation haben soll. Softwaredokumentation kann viele Formen annehmen: Handbücher, PDF-Dokumente, Hilfedateien oder Online-Hilfe. Jedes Formular wurde entwickelt, um dem Benutzer die Verwendung der einzelnen Funktionen des Programms zu zeigen, sei es in Form einer exemplarischen Vorgehensweise oder eines Tutorials; bei Hilfedateien und Online-Hilfen können dies sowohl Text als auch Demonstrationsvideos sowie Bilder sein.
5. Wählen Sie ein geeignetes Dokumentationstool. Gedruckte oder PDF-Handbücher können je nach Länge und Komplexität mit einem Textverarbeitungsprogramm wie Word oder einem fortschrittlichen Texteditor wie FrameMaker erstellt werden. Hilfedateien können mit einem speziellen Authoring-Tool wie RoboHelp, Help and Manual, Doc-To-Help, Flare, HelpLogix oder HelpServer geschrieben werden.
Tipps
- Der Text sollte so aufgebaut sein, dass er leicht lesbar ist, mit Bildern so nah wie möglich am Text, auf den er sich bezieht. Unterteilen Sie die Dokumentation logisch in Absätze, Abschnitte und Themen. Jeder Absatz oder jedes Thema muss einen einzelnen Sachverhalt erläutern, sei es eine einzelne Programmfunktion oder eine Aufgabe. Verwandte Themen können gegebenenfalls mithilfe von "Siehe auch"-Listen oder Hyperlinks wie oben angegeben erklärt werden.
- Jedes der oben aufgeführten Dokumentationstools kann mit einem Screenshot-Programm wie Snagit ergänzt werden, wenn die Dokumentation Screenshots erfordert. Wie bei anderen Dokumentationen sollten Screenshots enthalten sein, um die Funktionsweise der Software zu erklären und den Benutzer nicht zu verwirren.
- Ton ist sehr wichtig, insbesondere beim Schreiben von Softwaredokumentationen für Endbenutzer. Adressieren Sie Benutzer in der zweiten Person („Sie“) statt in der dritten Person („Benutzer“).
Notwendigkeiten
- Software-Dokumentation/Hilfedatei-Dienstprogramm
- Screenshot-Dienstprogramm
"Schreiben von dokumentationen für software"
Оцените, пожалуйста статью
