Obwohl die Hilfedateien von vielen Computerbenutzern häufig ignoriert werden, enthalten sie wichtige Informationen zur Verwendung der Softwareanwendung, mit der sie verknüpft sind. Durch Klicken auf "Hilfe" kann ein Benutzer einen Überblick über die Funktionen des Programms, eine Beschreibung des angezeigten Bildschirms, Anweisungen zur Verwendung des Programms zur Ausführung einer bestimmten Aufgabe oder eine Liste mit häufig gestellten Fragen zu den Programm und ihre Antworten. Das Schreiben einer Hilfedatei erfordert sowohl die Fähigkeit, mit Softwareanwendungen zu arbeiten, als auch die Fähigkeit, Dinge verständlich zu erklären.
Schritte
Schritt 1. Besorgen Sie sich eine Kopie der Software, die Sie dokumentieren möchten
Wenn möglich, sollten Sie sich auch eine Kopie der schriftlichen Spezifikationen des Programms besorgen, obwohl nicht alle Softwareentwickler damit arbeiten. In einigen Fällen weicht der Programmierer von den Spezifikationen ab, da er eine kurze Entwicklungszeit hat oder ein bestimmtes Feature nicht codieren kann.
Schritt 2. Besorgen Sie sich ein Hilfe-Authoring-Tool
Während es möglich ist, eine Hilfedatei manuell mithilfe einer Rich-Text-Format-Datei (.rtf) zu erstellen, verwenden die meisten Autoren von Hilfedateien eine Softwareanwendung, um ihre Hilfedateien zu schreiben, wie RoboHelp, Help and Manual, Doc-To -Hilfe, MadCap Flare oder HelpLogix. Die meisten Hilfeerstellungstools enthalten einen Texteditor oder arbeiten mit einem Textverarbeitungsprogramm wie Microsoft Word und bieten eine Benutzeroberfläche, die es dem Hilfeautor ermöglicht, beim Schreiben von Computercode im Hintergrund zu sehen, wie die Hilfedatei während des Schreibens aussehen wird damit die Hilfedatei funktioniert. Einige Hilfeerstellungstools enthalten auch Grafikeditoren zum Erstellen von Screenshots, die in die Hilfedatei aufgenommen werden sollen.
Es gibt eine Reihe von Hilfedateiformaten: Das gebräuchlichste ist die HTML-Hilfe, die von Anwendungen verwendet wird, die unter Windows ausgeführt werden. (Ein älteres Format, WinHelp, wird nicht mehr unterstützt.) Apple und Unix haben ebenfalls ihre eigenen Formate, ebenso wie Sun Microsystems mit seiner JavaHelp. Softwareanwendungen, die unter mehreren Betriebssystemen ausgeführt werden sollen, können ein plattformübergreifendes Hilfesystem verwenden, das im Webbrowser des Benutzers ausgeführt wird. Das von Ihnen verwendete Hilfe-Authoring-Tool sollte die Hilfeformate unterstützen, in denen Sie Hilfedateien erstellen möchten
Schritt 3. Erstellen Sie die Hilfeprojektdatei
Ihr Hilfeerstellungstool erstellt basierend auf dem von Ihnen angegebenen Dateinamen und anderen Informationen eine Hilfeprojektdatei für Sie. Die Hauptprojektdatei enthält Informationen über die anderen Dateien, darunter eine Inhaltsdatei, eine Indexdatei, eine oder mehrere Bilddateien und andere Dateien.
- Die Inhaltsdatei enthält den Text in der Hilfedatei, der erklärt, wie die von Ihnen dokumentierte Softwareanwendung funktioniert. Der Text ist normalerweise in Themen unterteilt, die einen bestimmten Bildschirm, eine bestimmte Funktion oder ein bestimmtes Verfahren abdecken.
- Die Indexdatei ist eine Liste der Themen der Hilfedatei. Es wird verwendet, um ein Inhaltsverzeichnis zu erstellen, mit dem Benutzer ein Thema zum Anzeigen auswählen können, sowie einen durchsuchbaren Index in der Hilfedatei.
- Bilddateien sind Grafikdateien von Programmbildschirmen oder Teilen dieser Bildschirme, die in der Hilfedatei angezeigt werden, um die Fähigkeit des Benutzers zu verbessern, zu verstehen, worauf sich der Text der Hilfedatei bezieht.
Schritt 4. Passen Sie die Größe des Hilfefensters an
Sofern Sie die Hilfedatei nicht so schreiben, dass sie im Webbrowser des Benutzers angezeigt wird, wird die Hilfedatei in einem eigenen Fenster angezeigt. Mit Ihrem Hilfe-Authoring-Tool können Sie die horizontalen und vertikalen Abmessungen des Fensters so anpassen, dass der Endbenutzer die Hilfedatei lesen kann, ohne die Anwendung selbst zu behindern. Das Haupthilfefenster hat oft ein dreigeteiltes Format mit dem Inhaltsverzeichnis auf der linken Seite und dem ausgewählten Thema auf der rechten Seite.
Hilfedateien können zusätzlich zum Hauptfenster auch sekundäre Fenster enthalten, die eine bestimmte Funktion detailliert beschreiben, und Popup-Fenster mit automatischer Größenanpassung, die kurze Beschreibungen der Funktionen enthalten. Hilfedateien können auch eingebetteten Text enthalten, der nur angezeigt wird, wenn markierter Text oder eine Schaltfläche angeklickt wird
Schritt 5. Schreiben Sie die Hilfethemen
Dazu müssen Sie die Spezifikationen oder das Programm selbst überprüfen, um die Themen zu erstellen, um die Bildschirme und Funktionen des Programms zu dokumentieren. Wenn Sie jedes Thema erstellen, fügt Ihr Hilfeerstellungstool es dem Inhaltsverzeichnis und dem Index der Hilfedatei hinzu.
- Während Sie das Inhaltsverzeichnis nach und nach erstellen können, ist es hilfreich, einen Plan für die Organisation zu haben. Sie können das Inhaltsverzeichnis um die Bildschirme des Programms, seine Funktionen, Verwendungsmöglichkeiten oder eine Kombination daraus herum organisieren.
- Berücksichtigen Sie beim Schreiben der Themen andere Informationen in der Hilfedatei, auf die die Benutzer schnell zugreifen möchten. Sie können im Text der Hilfedatei Sprünge oder Hyperlinks erstellen, die eine Verbindung zu den Themen mit diesen Informationen herstellen.
Schritt 6. Fügen Sie bei Bedarf Screenshots hinzu
Viele Programmfunktionen lassen sich am besten mit einer Kombination aus Text und Grafik erklären. Sie können Screenshots entweder mit der Anwendung erstellen, die mit Ihrem Hilfe-Authoring-Tool geliefert wird, oder mit einer separaten Anwendung wie Microsoft Paint, Paint Shop Pro oder SnagIt.
- Text und Screenshots sollten zusammen in einem Thema angeordnet werden, damit Benutzer den Screenshot und den dazugehörigen Text ohne unnötiges Scrollen sehen können. In vielen Fällen möchten Sie einen Teil eines Programmbildschirms anstelle des gesamten Bildschirms anzeigen oder den Screenshot in einer kleineren Größe als das Original anzeigen. Ihre Screenshot-Anwendung sollte in der Lage sein, die Größe des Screenshots ohne Unschärfe oder Detailverlust zu ändern.
- Wenn Sie Änderungen an der Benutzeroberfläche zwischen der Test- und der endgültigen Version des Programms erwarten, sollten Sie mit dem Erstellen von Screenshots warten, bis Sie die endgültige Version des Programms haben, mit der Sie arbeiten können.
Schritt 7. Erstellen Sie bei Bedarf eine Kartendatei
Einige Programme enthalten "Hilfe"-Schaltflächen, auf die ein Benutzer klicken und das Thema in der Hilfedatei anzeigen kann, das speziell die Funktionsweise dieses Bildschirms beschreibt. Die Anzeige eines Themas auf diese Weise wird als kontextsensitive Hilfe bezeichnet und erfordert das Erstellen einer Map-Datei für den Programmierer, um die Schaltfläche "Hilfe" mit dem spezifischen Thema in Ihrer Hilfedatei zu verknüpfen. Ihr Hilfe-Authoring-Tool kann eine für Sie erstellen, oder der Programmierer kann sie codieren und Ihnen zur Aufnahme in die Hilfedatei zur Verfügung stellen.
Schritt 8. Kompilieren Sie die Hilfedatei
Beim Kompilieren wird die eigentliche Hilfedatei erstellt, die dem Programm beigefügt wird. Bei den meisten Hilfeformaten umfasst dies alle Komponentendateien, die beim Erstellen der Hilfedatei erstellt wurden, obwohl einige unkompilierte Hilfeformate auch erfordern, dass die einzelnen Hilfethemendateien im Programm enthalten sind.
Schritt 9. Testen Sie die Hilfedatei
Nachdem Sie die Hilfedatei kompiliert haben, müssen Sie sie testen, um sicherzustellen, dass alle Hyperlinks mit den gewünschten Themen verbunden sind und alle Grafiken korrekt angezeigt werden. Die Hilfedatei muss auch getestet werden, um sicherzustellen, dass der Inhalt korrekt und für die Benutzer geeignet ist und in einem konsistenten Format vorliegt. Sie sollten die Hilfedatei selbst überprüfen und die Personen, die die Anwendung testen, sie ebenfalls überprüfen lassen.
Bei größeren Hilfedateiprojekten sind Kompilieren und Testen fortlaufende Prozesse. Sie sollten die Hilfedatei kompilieren und Ihre Arbeit mehrmals überprüfen, bevor Sie die endgültige Version erstellen
Schritt 10. Geben Sie dem Entwickler die Hilfedatei, die er in das Programm einschließen soll
Abhängig von der Art des Projekts und dem Format der Hilfedatei müssen Sie dem Entwickler möglicherweise mehrere Dateien zur Verfügung stellen, einschließlich einer Map-Datei, wenn kontextsensitive Themen vorhanden sind.
