Wenn Hilfe und Handbücher schiefgehen

help and manuals go wrong

Im Zusammenhang mit Hilfedokumenten kennt fast jeder mindestens eine Horrorgeschichte. Entweder geht es um den Versuch, ein Produkt zu verstehen, wenn das Handbuch in solch einem schlechten Deutsch geschrieben wurde, dass es unverständlich ist, oder um ein Produkt, das mit einem Handbuch für ein völlig falsches Modell geliefert wurde. Oder vielleicht handelt die Geschichte von einem dieser Handbücher, die so voller Details gepackt sind, dass sie zu viele Informationen enthalten und es fast unmöglich wird, die Antwort, die man schnell braucht, zu finden. Es gibt viele Möglichkeiten für das Misslingen von Handbüchern, aber im Allgemeinen können diese meistens in zwei hauptsächliche Bereiche unterteilt werden:

  • Das Handbuch ist veraltet oder enthält die falschen Informationen.
  • Das Handbuch ist schlecht geschrieben oder schwer zu navigieren.

Viele dieser mit Handbüchern verbundenen Probleme treten auf, weil die Autoren der Handbücher überfordert sind und versuchen, zu viel zu schnell zu tun. Oft sind die Autoren der Hilfedokumente dieselben Leute, die das Produkt entwickeln und vermarkten, und häufig ist das Handbuch das Letzte, woran sie denken. Sicherzustellen, dass das Produkt vollständig fertig und getestet ist, hat immer Priorität. Dann beeilt man sich, das Produkt auf den Markt zu bringen, und für das Schreiben des Handbuchs bleibt nicht viel Zeit.
Ein gutes Handbuch von Grund auf zu schreiben kann viel Zeit in Anspruch nehmen, insbesondere wenn das Produkt ziemlich komplex ist.

Was ist die Lösung?

Es ist nicht wahrscheinlich, dass den technischen Redakteuren viel Zeit für das Schreiben des Handbuchs gegeben wird, müssen wir uns also für immer mit zweitklassigen Handbüchern abfinden, wenn ein gutes Handbuch in der verfügbaren Zeit nicht geschrieben werden kann?
Zum Glück gibt es für Autoren von Hilfedokumenten eine einfache Lösung. Wenn Sie ein Hilfe-Entwicklungstool (HET) zum Schreiben Ihrer Hilfedokumente benutzen, können Sie ein qualitativ hochwertiges Handbuch schnell herstellen, ohne sich Gedanken über Formatierungsprobleme oder ein schwierig zu navigierendes Handbuch zu machen.
HelpNDoc und andere Hilfe-Entwicklungssoftwares bieten Autoren eine voll ausgestattete Textverarbeitungsumgebung und etliche Tools, die das Leben der Autoren einfacher machen. Mit nur wenigen Klicks können Sie Bilder und Videos in Ihre Hilfedateien einfügen. Mit dem Themen-Editor können Sie überprüfen, dass alle wichtigen, zu behandelnden Themen in der Dokumentation enthalten sind. Sobald das Dokument genau so aussieht, wie Sie es haben wollen, können Sie die Datei in so vielen Formaten, wie Sie benötigen, ausgeben. Diese umfassen PDF, HTML und sogar ePub und Kindle eBook, sodass Ihre Benutzer das Handbuch auf Ihren E-Readern lesen können.
Dies sind alles nützliche Funktionen, für die meisten Autoren jedoch zeigen sich die echten Vorteile der Benutzung eines HET, wenn die Handbücher aktualisiert werden müssen. Mit diesen Tools wird die gesamte Formatierung für Sie erledigt, sodass Sie den Inhalt nicht nach jeder änderung neu formatieren müssen, sondern einfach den zu ändernden Abschnitt aktualisieren und die Datei erneut ausgeben. Wenn Sie ein Bild oder ein anderes Medienelement ändern müssen, können Sie dies mit nur ein paar Klicks tun. HETs machen die Erstellung von Handbüchern schneller und einfacher als je zuvor.