Die Kunst, Handbücher zu schreiben

Handbücher und Leitfäden sind nur so wirksam wie die Art und Weise, wie sie präsentiert werden. Für Handbücher und Leitfäden gelten die gleichen Regeln wie für jede andere Form des Schreibens. Sie müssen klar, prägnant, einheitlich und genau geschrieben sein. Ist dies nicht der Fall, wird die Zielgruppe, für die sie bestimmt sind, sie ignorieren, was für manche Unternehmen zu Problemen führen kann.

Die Verfasser von Dokumenten müssen drei Dinge definieren, bevor sie ein Handbuch oder einen Leitfaden verfassen: Zielgruppe, Zweck und Umfang. Sobald sie diese definiert haben, können sie mit dem Schreibprozess beginnen.

ZIELGRUPPE.
Die Zielgruppe ist wichtig, denn verschiedene Personengruppen haben ein unterschiedliches Verständnis für bestimmte Themen. Es kann auch sein, dass die Zielgruppe die Sprache, in der das Handbuch verfasst wird, nicht fließend beherrscht. Dies gilt insbesondere in der heutigen globalen Marktumgebung.

Viele Produkte werden nicht in den Ländern hergestellt, in denen sie verkauft werden. Diese Praxis ist zwar vielleicht kosteneffizient, kann aber zu einer schlechten Dokumentation führen, wenn die Produktdokumentation von Personen verfasst wird, die die Sprache des Exportlandes nicht fließend beherrschen. Ein Unternehmen mit Sitz in Taiwan kann seinen Produkten beispielsweise Anleitungen beifügen, die in schwer verständlichem Englisch verfasst sind. In solchen Fällen können die Dokumente für die Verbraucher nutzlos sein. Dies kann zu Umsatzeinbußen und/oder unzufriedenen Kunden führen.

Selbst wenn der Autor und die Zielgruppe dieselbe Sprache sprechen, ist es wichtig, die Zielgruppe zu definieren. Je nach dem erwarteten Leser müssen die Verfasser von Handbüchern die passende Terminologie wählen und Annahmen darüber treffen, was erklärt werden muss und was als selbstverständlich angesehen wird. Wenn es notwendig ist, Fachbegriffe zu verwenden, müssen diese unter Umständen definiert werden. Auch die Verwendung von Illustrationen sollte sich nach dem Profil der Zielgruppe richten, wobei Diagramme oder Screenshots gewählt werden sollten, um besonders wichtige oder schwer verständliche Punkte zu verdeutlichen.

ZIEL.
Die Definition der Zielgruppe ist nur der erste Schritt bei der Erstellung eines Handbuchs. Der Verfasser muss sich auch über den Zweck des Handbuchs im Klaren sein. Soll es lehrreich sein? Informativ? Soll es die Lösung für ein Problem bieten? Der Zweck des Handbuchs bestimmt in hohem Maße, wie der Inhalt präsentiert werden soll. Wenn es sich beispielsweise um eine Anleitung handelt, muss der Verfasser in der Lage sein, die im Handbuch enthaltenen Verfahren auszuführen, denn wenn ein Autor, der eine Anleitung verfasst, mit dem zu dokumentierenden Verfahren nicht vertraut ist, wird das Handbuch zwangsläufig Fehler enthalten, die seinen Zweck verfehlen.

UMFANG.
Handbücher sollten auch innerhalb eines festgelegten Geltungsbereichs so umfassend wie möglich sein; mit anderen Worten, das Handbuch sollte definierte Grenzen des Geltungsbereichs haben und diese Grenzen einhalten. Das bedeutet, dass weder zu viel noch zu wenig enthalten sein darf. Der Umfang wird meist durch den Zweck bestimmt, z. B. um einem Benutzer die wichtigsten Funktionen einer Softwareanwendung zu vermitteln. Aber auch die Zielgruppe kann den Umfang beeinflussen, z. B. braucht eine Zielgruppe mit mittlerem Niveau keine rudimentären Informationen. Ein Autor sollte sich bemühen, alle Informationen aufzunehmen, die für die Zielgruppe erforderlich sind, um das Thema zu verstehen oder den Anweisungen zu folgen. Wenn zum Beispiel ein Hersteller einem Produkt eine Anleitung beifügt, in der erklärt wird, wie es zusammengebaut, ausgepackt, installiert oder gewartet wird – also der Umfang der Anleitung -, sollte jeder dieser Aspekte vollständig behandelt werden.

Möchten Sie Ihre gesamten Arbeitsanweisungen erstellen mit Manual Rebel? Besuchen Sie https://manualrebel.com/ direkt.