Die idiotensichere Anleitung zum Schreiben von Hilfedokumenten und Handbüchern

Write help documents and manuals

Wenn Sie noch nie eine Hilfedokumentation geschrieben haben, dann kann diese Aufgabe ein bisschen unheimlich erscheinen. Die Endanwender Ihres Produkts verlassen sich darauf, dass Sie ihnen helfen, jede Funktion des Produkts zu verstehen, und ihre kontinuierliche Benutzung des Produkts hängt davon ab, wie erfolgreich Ihre Antworten zu ihren Fragen sind. Hier ist unsere „idiotensichere Anleitung” zum Schreiben von Handbüchern und Hilfedokumenten. Diese Tipps werden Ihnen helfen, Hilfedokumente zu schreiben, die alle zu berücksichtigenden Details abdecken und für Ihre Endanwender leicht verständlich sind.

Verstehen Sie Ihre Produktanwender

Dies ist der grundlegendste Punkt für das Schreiben von Hilfedokumentationen. Wenn das, was Sie schreiben, nützlich sein soll für diejenigen, die versuchen, das Produkt zu verstehen, dann muss die Hilfedokumentation die Problembereiche dieser Personen behandeln. Es macht keinen Sinn, ein wunderschön entworfenes Handbuch zu schreiben, wenn es niemandem hilft, das Produkt zu benutzen oder wenn es Fragen zu dem Produkt beantwortet, die in Wirklichkeit niemand stellt.
Sprechen Sie zunächst mit Menschen, die das Produkt verwenden. Finden Sie heraus, wie und für welchen Zweck sie es benutzen. Welche Funktionen werden am häufigsten verwendet? Sprechen Sie mit dem Helpdesk oder dem Kundendienst und finden Sie heraus, welche Fragen die Anwender am häufigsten stellen.
Sobald Sie sicher wissen, wie Ihre Kunden das Produkt benutzen, haben Sie eine viel klarere Vorstellung davon, welche Produktfunktionen Sie eingehender erklären müssen und welche Bereiche kurz abgehandelt werden können.

Planen Sie das Inhaltsverzeichnis sorgfältig

Es ist wichtig, dass jede Funktion Ihres Produkts enthalten ist, aber sogar noch wichtiger ist es sicherzugehen, dass die Anleitung auf logische Weise strukturiert ist. Die Anwender müssen in der Lage sein, das zu finden, wonach sie suchen. Ein Handbuch ist nicht etwas, das die meisten Leute von vorne bis hinten durchlesen wollen. Die meisten Leute schlagen ein Handbuch nur auf, wenn sie eine spezifische Frage haben, und sie wollen dann direkt zu der Stelle in der Hilfedokumentation springen, die das fragliche Thema behandelt.
Versuchen Sie, jede mögliche Nutzungsweise Ihres Produkts zu durchdenken und führen Sie die Schritte in der zum Erreichen einer Aufgabe notwendigen Reihenfolge auf; dies erleichtert den Lesern das Auffinden der benötigten Informationen.

Schreiben Sie für das richtige Publikum

Schreiben Sie das Handbuch oder die Hilfedokumentation auf einem Niveau, das passend für Ihre Produktanwender ist. Denken Sie darüber nach, wer Ihr Produkt anwenden wird und welchen Grad an technischer Fachkenntnis diese Personen wahrscheinlich haben. Gute Hilfedokumentationen setzen kein Wissen voraus, das die Anwender nicht haben, und zudem vermeiden sie einen herablassenden Ton sowie ein zu detailliertes Erklären aller Punkte, damit sich die Anwender nicht wie eine Kindergartenklasse behandelt fühlen.

Vereinfachen Sie die Erstellung Ihrer Hilfedokumente

Verwenden Sie eine Hilfe-Entwicklungssoftware, die Sie während der Erstellung Ihres Handbuchs anleitet. Die einfachste Methode zum Schreiben guter Hilfedokumentationen ist die Nutzung einer speziell für das Schreiben solcher Werke entwickelten Software. Ein Hilfe-Entwicklungspaket kann die mit der Planung Ihrer Dokumentation verbundenen Aufgaben viel einfacher machen. Durch den inbegriffenen Themen-Editor, die Möglichkeit zum Erstellen von Vorlagen und eine vielseitige Medienbibliothek wird das Entwerfen von Hilfedokumentationen einfach, und das fertige Handbuch kann dann in eine Reihe von Formaten exportiert werden, sodass Sie es nicht jedes Mal umformatieren müssen.