Die größten Fehler, die erstmalige Autoren von Handbüchern machen

Biggest Mistakes First Time Help Manual Authors Make

Was ist der schlimmste Fehler, den Sie als erstmaliger Autor eines Handbuchs machen können?

Eine gutes Handbuch ist benutzerfreundlich und enthält klare Anweisungen, die die Benutzer problemlos finden und nutzen können. Das Erstellen eines guten Handbuchs kann jedoch eine schwierige Aufgabe sein, wenn Sie zum ersten Mal ein Handbuch verfassen und besonders wenn es sich um Ihr erstes technisches Schreibprojekt handelt.
Interessanterweise hat jeder gute Autor von Handbüchern einmal klein angefangen und etliche Fehler bei seinem ersten Versuch gemacht. Wir haben diese Fehler für Sie zusammengestellt, damit Sie Ihnen nicht auch passieren. Glücklicherweise können Sie aus diesen Fehlern lernen und so ein erstklassiges Handbuch bei Ihrem ersten Versuch erstellen.

Hier sind die fünf größten Fehler, die erstmalige Autoren von Handbüchern machen:

1. Schlechte Struktur

Technisches Schreiben erfordert eine einfache und klare Struktur, die sich von jeder anderen Form des Schreibens unterscheidet. Die Struktur bestimmt, wie die Informationen in einem Handbuch angeordnet sind. Viele erstmalige Autoren von Handbüchern machen den Fehler, dass sie beim Schreiben keine einfache und klare Struktur haben. Wenn die Struktur schlecht ist, erschwert dies den Benutzern das Navigieren und Auffinden von Informationen in dem Handbuch, sodass sie das Interesse verlieren.
Ihr Handbuch muss jedoch nicht langweilig sein: Alles, was Sie tun müssen, ist eine einfache Struktur zu erstellen. So gelingt es Ihnen:

  • Verwenden Sie kurze und leicht verständliche Sätze. Jeder Satz sollte eine Information enthalten.
  • Stellen Sie sicher, dass die wichtigsten Informationen zuerst erwähnt werden. Erwähnen Sie die Informationen, die alle Benutzer brauchen, vor denen, die nur wenige Benutzer brauchen.
  • Erwähnen Sie die am häufigsten benötigten Informationen vor solchen Informationen, die ab und zu benötigt werden.
  • Gruppieren Sie Elemente oder Informationen, die zusammengehören, an einer Stelle.
  • Machen Sie es den Benutzern leicht, auf jede einzelne Information selektiv zuzugreifen.

2. Verwenden des Passivs

Sie können entweder im Aktiv oder im Passiv schreiben. Da Handbücher immer der Belehrung dienen, macht das Verwenden des Aktivs den Benutzern die in ihnen enthaltenen Informationen einfacher verständlich. Viele Handbücher fordern die Benutzer dazu auf, einen oder mehrere Schritte durchzuführen, und wenn Sie diese im Aktiv beschreiben, erleichtert dies den Benutzern, die richtigen Maßnahmen zu ergreifen.

Das Verwenden des Passiv kann dazu führen, dass Ihr Handbuch langweilig, nicht eindeutig oder sogar irreführend ist. Dies ist ein guter Grund dafür, warum Sie diese bewährten Methoden zum Schreiben von Hilfedokumenten und Handbüchern befolgen sollten.

3. Verfassen eines ungenauen Inhalts

Einer der wichtigsten Gründe dafür, dass die Benutzer Handbücher lesen, ist das Auffinden von Antworten. Wenn die Informationen in Ihrem Handbuch technisch inhalts- und sinnlos sind, dann haben Sie mit Erfolg ein ungenaues Handbuch erstellt. Um dies zu vermeiden, sollten Sie Folgendes tun:

  • Führen Sie die Informationen in einem schrittweisen Verfahren auf.
  • Teilen Sie den Benutzern des Produkts mit, welche Funktionen verfügbar sind und wofür jede Funktion verwendet wird - anstatt ihnen nur zu sagen, wie sie verwendet werden.
  • Verwenden Sie Abbildungen, Diagramme und Terminologien, die Ihren Produktbenutzern vertraut sind.
  • Schreiben Sie nicht, um die Benutzer zu beeindrucken, sondern schreiben Sie, um Lösungen und Antworten deutlich zu machen.
  • Machen Sie sich klar, mit welchem Ziel Sie schreiben und für wen Sie schreiben.

4. Schlechtes Layout

Wenn das Layout Ihres Handbuchs unprofessionell und dysfunktional ist, können die Benutzer einen schlechten Eindruck von Ihrer Marke haben und werden Sie mehr für den Kunden-Support aufbringen müssen. Aber was genau ist das Layout eines Benutzerhandbuchs? Das Layout ist die Art und Weise, in der die Texte und Bilder auf jeder Seite Ihres Handbuchs aufgeführt sind.
Wenn Ihr Layout zu bunt und geballt ist, kann es die Benutzer von den tatsächlichen Informationen ablenken. Um dies zu vermeiden, sollten Sie Kontrastfarben, Schattierungen oder Fettdruck zum Hervorheben von wichtigem Inhalt verwenden. Stellen Sie sicher, dass alle Abbildungen eindeutig und leicht verständlich sind.

Stellen Sie sicher, dass Sie Schriftarten verwenden, die am besten für das Lesen am Bildschirm geeignet sind, wenn Sie ein Online-Handbuch erstellen. Serifenlose Schriftarten eignen sich besser für das Lesen am Bildschirm. Stellen Sie sicher, dass die Benutzer einfach erkennen können, was anklickbar ist und was nicht. Mit so vielen intelligenten Geräten im Angebot gibt es etliche Layouts und Vorlagen, die Sie berücksichtigen sollten. Beschränken Sie Ihr Handbuch nicht auf einen einzigen Dateityp oder eine einzige Version. Hier finden Sie heraus, warum Sie ePub- und Kindle-Versionen Ihrer Handbücher erstellen sollten.

5. Schlechter Schreibprozess

Viele erstmalige Autoren von Handbüchern haben ihr erstes Handbuch ohne ein Hilfe-Entwicklungstool (HET) erstellt. Sie verwenden üblicherweise Microsoft Word, da sie dies bereits zum Erstellen anderer Dokumente verwenden. Ich liebe Microsoft Word, es ist eine tolle Software! Aber es ist nicht das richtige Werkzeug für das Erstellen von Handbüchern.

Der einfachste Weg zum Schreiben eines guten Handbuchs ist die Verwendung eines Hilfe-Entwicklungstools. Mit einem HET können Sie das Handbuch ohne oder mit geringem Aufwand aktualisieren und reproduzieren. Das Tool ermöglicht Single-Source-Publishing: eine Generierung verschiedener Formate (PDF, CHM, HTML, Word, iPhone, eBooks, ePubs...) Ihres Handbuchs aus einer Quelle. Außerdem können Sie die Darstellung und das Layout Ihrer Handbücher auf einfache Weise anpassen.

Sie können mit der Nutzung der HelpNDoc Hilfe-Entwicklungssoftware beginnen. Sie können HelpNDoc für den persönlichen Gebrauch und zu Bewertungszwecken herunterladen - und es ist absolut kostenlos!

Die Lösung zum Erstellen eines benutzerfreundlichen Handbuchs liegt darin, anzunehmen, dass die Produktbenutzer absolut keine Ahnung von der Benutzung des Produkts haben - und meistens ist das die schlichte Wahrheit. Somit müssen Sie Ihre Inhalte vereinfachen, ohne sie für die Benutzer langweilig oder zu technisch zu machen.