Gewusst wie: So schreiben Sie ein hervorragendes Handbuch

Durch das Schreiben eines hervorragenden Handbuchs erreichen Sie zwei Dinge: Sie helfen Ihren Kunden, geeignete Lösungen einfach zu finden und anzuwenden, und Sie reduzieren die Kundendienstkosten Ihres Unternehmens deutlich.
Außerdem werden Ihre Kunden Ihr Produkt gerne empfehlen, und die Spitzenreiter in Ihrer Nische werden Ihre Marke sicher anderen Experten und deren Kunden empfehlen. Aus diesem Grund kann das Schreiben eines hervorragenden Handbuchs eine der besten Investitionen Ihres Unternehmens sein.
Wie können Sie ein hervorragendes Handbuch schreiben?

Gewusst wie: So schreiben Sie ein hervorragendes Handbuch in 8 einfachen Schritten

1. Definieren Sie, für wen Sie schreiben.

Wie gut kennen Sie Ihre Produktbenutzer? Bevor Sie mit dem Scheiben beginnen, sollten Sie Ihre Zielgruppe definieren und deren Wortwahl und technischen Kenntnisstand recherchieren. Wenn Sie sich an technische Experten wenden, sollten Ihre Wortwahl und Fachbegriffe anders ausfallen, als wenn Sie für unerfahrene Produktbenutzer mit wenigen oder gar keinen technischen Kenntnissen schreiben.

2. Berücksichtigen Sie alle relevanten Abschnitte.

Hervorragende Handbücher beinhalten mehrere unterschiedliche Hauptabschnitte. Diese Hauptabschnitte umfassen die Titelseiten, das Inhaltsverzeichnis, die Liste der Abbildungen und Tabellen, die Einleitung, die Kapitel, den Anhang, das Glossar, den Index und die Rückseite… Eventuell sind nicht alle dieser Abschnitte für Ihr Handbuch relevant, sodass Sie die Abschnitte sorgfältig auswählen müssen, die Ihre Handbücher möglichst benutzerfreundlich machen.
Diese Hauptabschnitte sollten die Tätigkeiten in Ihrem Handbuch vereinfachen, nicht verkomplizieren. Um dies zu erreichen, sollten Sie für jeden Abschnitt ein einheitliches Format anwenden und jeden Abschnitt mit einer kurzen Zusammenfassung der auszuführenden Tätigkeit einleiten.

3. Achten Sie darauf, dass der Inhalt leicht lesbar ist.

Zunächst müssen Sie die Anleitungen oder Vorgehensweisen von den Referenzmaterialien trennen. Dies erleichtert den Benutzern das schnelle Navigieren des Handbuchs. Jede Anweisung muss so geschrieben werden, dass sie den Benutzern hilft, bestimmte Tätigkeiten durchzuführen.
Identifizieren Sie zuerst die Haupttätigkeiten, und unterteilen Sie dann jede Haupttätigkeit in Teiltätigkeiten. Beschreiben Sie eine Reihe von Schritten, die die Benutzer darüber informieren, wie jede Teiltätigkeit einfach durchzuführen ist. Verwenden Sie dabei kurze Sätze und Wörter, die Ihre Benutzer verstehen werden.
Erläutern Sie den Benutzern die Produktfunktionen und wie diese angewendet werden. Kennzeichnen Sie die Bedeutung oder Wichtigkeit durch Kontraste, Farben oder Schattierungen. Gehen Sie nicht davon aus, dass die Benutzer alle durch Sie erwähnten vereinfachten Fachbegriffe verstehen werden: Sie sollten ein Glossar der Fachbegriffe erstellen, das die Bedeutung jedes Begriffs entsprechend seiner Verwendungsweise in dem Handbuch erklärt.

4. Sprechen Sie die Benutzer direkt an.

Ihr Handbuch muss nicht langweilig sein; schreiben Sie stets im Aktiv und verwenden Sie das Personalpronomen der zweiten Person (“Sie”, “Ihr”, “Ihnen” etc.). Verwenden Sie die Befehlsform des relevantesten Verbs, wenn Sie die Benutzer zum Durchführen einer Tätigkeit auffordern. Zum Beispiel: “Wählen Sie die zweite Option aus dem Drop-down-Menü und drücken Sie Enter”.

5. Stückeln Sie Ihre Texte.

Je nach dem Fachwissen Ihrer Zielgruppe müssen Sie umfangreiche Informationsabschnitte eventuell in kleinere Einheiten unterteilen - dieser Vorgang wird als “Chunking” bezeichnet. Das Chunking unterscheidet sich von dem Erstellen von Teiltätigkeiten. Wenn eine Teiltätigkeit einen längeren Informationsabschnitt umfasst, der möglicherweise eine Herausforderung für die Benutzer darstellt, können Sie die Informationen in eine Liste von “Chunks” aufteilen. Dies gehört zu den Best Practices beim Schreiben von Hilfedokumenten und Handbüchern.

6. Verwenden Sie Abbildungen und Illustrationen auf sachgerechte Weise.

Manchmal genügen ein oder zwei Illustrationen, um den Benutzern die Durchführung einer Tätigkeit einfach verständlich zu machen. Einer der Gründe, warum einige Produktbenutzer niemals Handbücher lesen, sind die in ihnen enthaltenen langweiligen und langen Textblöcke. Durch die sachgerechte Verwendung von Abbildungen und Illustrationen zum Erklären komplizierter Tätigkeiten können Sie Ihr Handbuch leicht lesbar und verständlich machen.

7. Lesen Sie Ihr Handbuch Korrektur.

Es reicht ein Rechtschreibfehler oder grammatikalischer Fehler, um eine ganze Anweisung in einem Handbuch zu ruinieren. Lesen Sie das Handbuch gründlich durch, wenn Sie mit dem Schreiben fertig sind, und lassen Sie zudem mindestens zwei Personen mit fundierten Kenntnissen des Produkts das Handbuch Korrektur lesen.

8. Wählen Sie das richtige Veröffentlichungsformat sorgfältig aus.

Wie genau wollen Sie das Handbuch veröffentlichen? Als PDF-, Word-, ePub-E-Book-, HTML-Help-Datei oder als Hardcopy? Die Lösung ist einfach. Sie müssen solche Dokumentenformate auswählen, die den Benutzern das Handbuch leicht zugänglich machen - wenn sie es brauchen und genau so, wie sie es brauchen.
Aber was ist, wenn Ihre Benutzer Zugriff auf mehrere unterschiedliche Dokumentenformate haben? Müssen Sie sich wirklich die Mühe machen und mehrere unterschiedliche Handbücher für verschiedene Formate erstellen? Die Lösung ist ziemlich einfach: Sie können HelpNDoc, ein Hilfe-Entwicklungstool, nutzen, das verschiedene Dokumentenformate aus einer Quelle erzeugt. Sie müssen nur eine Datei Ihres Handbuchs erstellen, und HelpNDoc wird diese Datei dann in das Format Ihrer Wahl konvertieren.

Das Schreiben eines hervorragenden Handbuchs erfordert Präzision und die Fähigkeit, auf jedes Detail zu achten. Obgleich dieser Vorgang auf den ersten Blick ziemlich langsam erscheinen mag, können Sie Hilfe-Entwicklungstools nutzen, um bessere Handbücher in der Hälfte der Zeit zu schreiben.

Das könnte Sie auch interessieren...

Publikumsanalyse für technisches Schreiben: So machen Sie alles richtig [Featured]

Schlagwörter: Dokumentationsformate Tipps & Tricks

Gewusst wie: So schreiben Sie ein hervorragendes Handbuch