Hilfedokumente müssen nicht langweilig sein

Help documentation doesn't have to be boring

Seien wir ehrlich: Hilfedokumente haben heutzutage ein fürchterliches Image. Nahezu jeder, mit dem man spricht, hat einen schlechten Eindruck von Handbüchern. Dafür gibt es viele verschiedene Gründe, einige der häufigsten sind:

  • Es beantwortet einem nicht die Frage, die man hat.
  • Man kann die Antwort nicht finden, obwohl man weiß, dass sie irgendwo drin steht.
  • Das Handbuch lässt sich schwer navigieren.
  • Die Dokumentation ist nicht mehr aktuell.
  • Die Dokumentation existiert noch nicht.

Angesichts solcher Probleme ist es keine überraschung, dass viele Leute sich nicht die Mühe machen, Hilfedokumente zu lesen; sie versuchen lieber, die Antwort alleine herauszufinden, oder suchen einfach nach einem Produkt, das leichter zu verstehen ist. Niemand will seine Zeit damit verbringen, sich durch ein langes, langweiliges Handbuch zu arbeiten, dass einem die Fragen, die man hat, wahrscheinlich ohnehin nicht beantworten wird.
Das muss nicht so sein! Es ist tatsächlich möglich, ein Hilfedokument zu erstellen, das einfach zu navigieren ist und die Fragen der Endbenutzer schnell und korrekt beantwortet.

Das Verständnis Ihrer Kundenbedürfnisse

Für die meisten Verfasser von Hilfedokumenten beginnen die Probleme mit einer falschen Herangehensweise an das Dokument. Häufig sind diejenigen, die für die Herstellung der Dokumentation verantwortlich sind, dieselben Personen, die monatelang mit der Entwicklung des Produkts zugebracht haben. Man ist versucht anzunehmen, dass jeder Benutzer des Produkts den selben Wissensstand wie man selbst hat und das Produkt so zu verwenden beabsichtigt, wie man es selbst erwartet.
Wir müssen akzeptieren, dass dies nicht der Fall ist. Jeder Benutzer Ihres Produkts nähert sich dem Produkt mit einem anderen Wissensstand und wahrscheinlich leicht unterschiedlichen Erwartungen darüber, was Ihr Produkt leisten kann und wie es benutzt werden soll. Ihr Hilfedokument muss jeden einzelnen Benutzer mit auf eine Reise nehmen, von seinem Ausgangspunkt aus durch jede Funktion Ihres Produkts. Wenn die Benutzer am Ende des Dokuments angekommen sind, sollten sie in der Lage sein, jede Funktion des Produkts, die sie anwenden wollen, vollkommen zu verstehen, ohne sich durch Seiten von Informationen über Funktionen kämpfen zu müssen, die sie nie anwenden werden.

Auf die Organisation kommt es an

Eine der größten Schwierigkeiten für jeden, der über das Schreiben eines Handbuchs nachdenkt, ist zu wissen, wie das Material zu organisieren ist. Man mag alles Mögliche über ein Produkt wissen, solange man jedoch nicht weiß, wie man das Material auf hilfreiche Weise gliedert, wird niemand von diesem Wissen profitieren. Eine Art Software, die äußerst hilfreich sein kann, ist ein Hilfe-Entwicklungstool. HETs können Ihnen bei der Organisation und Formatierung des Materials für Ihre Hilfedokumente und Handbücher helfen. Die Anwendung von Funktionen wie des Themen-Editors und der Medienbibliothek kann dazu beitragen, dass jedes Thema, über das Sie schreiben müssen, gründlich behandelt wird und dass alle Bilder und anderen Medienelemente, die Sie verwenden müssen, an der richtigen Stelle sind, sodass das Handbuch einfach zu verstehen ist.

Die Anwendung eines Hilfe-Entwicklungstools ist besonders nützlich, wenn Sie Ihr Hilfedokument aktualisieren müssen. Anstatt Abschnitte des Handbuchs umzuschreiben und dann mühsam das gesamte Dokument neu zu formatieren, um den änderungen gerecht zu werden, müssen Sie nur auf ein paar Buttons klicken, und das Handbuch wird aktualisiert und kann in einer Vielzahl von Formaten, einschließlich PDF, ePub oder Qt Help, ausgegeben werden. Es ist sogar möglich, eine vollständige HTML-Version Ihres Hilfedokuments zu erzeugen, die als Online-Hilfedatei benutzt werden kann.
Das Erstellen eines Hilfedokuments, das gut organisiert ist, toll aussieht und die Fragen Ihrer Kunden tatsächlich beantwortet, ist ein hervorragender Weg, um zu gewährleisten, dass zukünftig niemand Ihre Handbücher als langweilig bezeichnen wird.