Best Practice beim Schreiben von Hilfedokumenten und Handbüchern

Writing Help Documents

Das Schreiben von Hilfedokumentationen kann ein komplizierter Prozess sein. Sie müssen lernen, wie ein Produktanwender zu denken, nicht wie ein Entwickler. Als die für das Schreiben der Hilfedokumentation verantwortliche Person haben Sie sich wahrscheinlich eine Weile lang mit Ihrem Produkt auseinandergesetzt und sind mittlerweile sehr vertraut mit seiner Funktionsweise. Dies ist nützlich für das Schreiben von Hilfedokumentationen, kann jedoch zugleich von Nachteil sein, da Sie anders an das Produkt herangehen als jemand, der es zum ersten Mal betrachtet. Was für Sie offensichtlich sein mag ist eventuell ein komplettes Rätsel für jemanden ohne Ihre Erfahrung mit dem Produkt oder Ihre Kenntnis des Konstruktionsprozesses.

Was ist die Best Practice beim Schreiben von Hilfedokumenten?

Nur sehr wenige Leute schlagen ein Hilfedokument am Anfang auf und lesen es bis zum Ende durch. Die meisten Leute nehmen eine Hilfedokumentation zur Hand, wenn sie eine spezielle Sache wissen wollen. Oftmals gibt es eine Funktion oder ein Tool, das sie benutzen wollen, aber nicht ohne eine spezifische Information verstehen können. Sie wollen das Handbuch aufschlagen und die gewünschte Information schnell ausfindig machen können und dann so bald wie möglich wieder mit ihrer Arbeit fortfahren.

Es gibt einige spezifische Punkte, die man hinsichtlich der Gliederung von Hilfedokumentationen beachten sollte:

  • Hilfedokumentationen müssen logisch gegliedert sein.
  • Hilfedokumentationen müssen so konzipiert sein, dass sie sich einfach überfliegen lassen.
  • Hilfedokumentationen müssen einen Themenindex enthalten.

Gliedern Sie das Hilfedokument auf logische Weise

Die Best Practice beim Schreiben von Hilfedokumenten beinhaltet, dass der gesamte Inhalt nach Themen gegliedert wird. Gewöhnlich verstehen die Anwender die meisten Dinge, die sie für das Funktionieren Ihres Produkts wissen müssen, aber es wird ein paar Bereiche geben, wo sie ein wenig Hilfe brauchen. Als ein technischer Redakteur ist es Ihre Aufgabe, die Dokumentation so zu schreiben, dass die Anwender Themen, für deren Verständnis sie Hilfe benötigen, einfach finden können.

Konzipieren Sie die Hilfedokumentation so, dass sie schnell gelesen werden kann

Die beste Hilfedokumentation ist immer leicht zu überfliegen. Die Produktanwender müssen in der Lage sein, den Abschnitt auf einer Seite herauszusuchen, der die benötigten Informationen enthält. Sie wollen kein ganzes Kapitel eines klein gedruckten Texts lesen, der ihnen Informationen mitteilt, die sie bereits wissen. Unterteilen Sie den Text in kurze, leicht lesbare Absätze und machen Sie deutlich erkennbar, wovon jeder Abschnitt handelt.

Denken Sie daran, einen guten Index einzufügen

Der Index ist wahrscheinlich der wichtigste Teil jeder Hilfedokumentation. Anders als bei einem konventionellen Buch werden viele Leser den Index zurate ziehen, bevor sie einen anderen Teil des Buchs lesen. Der Index sollte so vollständig wie möglich sein und jedes Thema aufführen, nach dem Ihre Leser eventuell suchen. Zudem ist es eine ausgezeichnete Idee, Synonyme der Themen aufzunehmen.

Wie können Sie diese Best Practices beim Schreiben von Hilfedokumenten umsetzen?

Hilfedokumente auf diese Weise zu schreiben hört sich vielleicht wie harte Arbeit an, aber es gibt Entwicklungstools, die helfen, den Prozess einfacher zu machen. HelpNDoc ist ein Beispiel für eine kostenlose Software, die die ganze harte Arbeit für Sie erledigt. Diese Software beinhaltet Stichwort-Editoren und Themen-Editoren, um die Gliederung Ihrer Arbeit zu vereinfachen, und wenn Sie mit dem Schreiben fertig sind, wird Ihr Dokument automatisch in mehrere Formate konvertiert, ohne zusätzliche Arbeit.