Einige Aspekte sind bei der Erstellung von Anleitungen nahezu immer entscheidend. Umfassendes Wissen oder entsprechende Ansätze tragen zu Qualität der Anleitung bei.
Nachstehende Aufzählung benennt kurz diese Aspekte.
1. Anleitung schreiben? Zielgruppe kennen!
Es ist wichtig, den Nutzern Informationen über das Produkt präzise und effektiv zu vermitteln. Jeder Nutzertyp (Zielgruppe) besitzt eigene Eigenschaften. Entscheidend ist, dies beim Schreiben einer Anleitung zu berücksichtigen. Hierfür bedient man sich dem Werkzeug der Zielgruppenanalyse, wie es z.B. auch die Neuausgabe der IEC/IEEE 82079-1:2019 fordert. Ältere Nutzer eines Notrufsystems stellen völlig andere Anforderungen an eine Anleitung als die Monteure eines modularen Lagersystems oder die Bediener einer Industrieanlage.
Vor dem tatsächlichen Schreiben der Anleitung wird mit beteiligten Fachleuten gesprochen. Dies können Elektrotechniker, Werkzeugmacher oder Industriedesigner sein, aber auch Kommunikationsfachleute oder Instandhaltungstechniker. Die Fachleute stellen die Produktinformationen bereit und jeder Experte wird dabei seine eigene Fachsprache verwenden. Für den Technischen Redakteur ist es die Kunst, diese Informationen dem Nutzer verständlich näher zubringen. Der Verfasser der Anleitung muss sich zudem Gedanken machen, welche Kommunikationskanäle er/sie verwendet, um die relevanten Informationen zur passenden Zeit in der passenden Form mitteilt. Dafür braucht es ein Konzept und Struktur.
2. Inhaltsverzeichnis zusammenstellen
Vergleichen Sie zehn gute Anleitungen und Sie werden die Gemeinsamkeiten meist anhand des Inhaltsverzeichnises erkennen. Eine gute Anleitung stellt sicher, dass der Nutzer ein Produkt bestimmungsgemäß und sicher gemäß vorhergesehenem Verwendungszweck verwenden kann. Ohne eine vollständige Anleitung ist dies schier unmöglich. Hierfür gibt es eine etablierte Norm für das Erstellen von Benutzerinformationen, die 82079-1, die in ihrer Edition 2 im Frühjahr 2019 als IEC/IEEE 82079-1:2019 erscheint. Diese Norm gibt unter anderem vor, welche Anforderungen an die Erstellung von Benutzerinformationen und den Inhalt einer Anleitung gestellt werden. Die beschriebene Gliederung sollte der Norm zufolge in jeder guten Anleitung vorhanden sein. Die Norm beschreibt eine Gliederung mit Elementen wie Kapiteln zu Warnungen, technischen Spezifikationen, Installation, Inbetriebnahme und Wartung. Es werden jedoch auch Empfehlungen abgegeben, beispielsweise bezüglich der Schriftgröße oder Angaben auf der Titelseite. Folgender Aspekt widmet sich genauer dem Inhalt.
3. Produktinformationen sammeln
Nachdem die Gliederung der Anleitung festgelegt wurde, kann diese mit den Informationen der zuvor erwähnten Fachleute gefüllt werden. Zudem müssen beim Schreiben jeder Anleitung so viele weitere Informationen wie möglich über das Produkt gesammelt werden, etwa eventuelle CAD-Dateien, Marketingdokumentation, Risikobeurteilung usw. Der Technische Redakteur hört zu, analysiert, selektiert, versteht und stellt Fragen bei der Informationsgewinnung.
Beim Schreiben einer Anleitung ist es immer entscheidend, über sämtliche Verpflichtungen hinsichtlich der Produktsicherheit und Produkthaftung informiert zu sein. Diese Verpflichtungen stellen nämlich häufig auch Anforderungen an die Produktdokumentation und beeinflussen daher die Inhalte der Anleitung. Für Verbraucherprodukte gilt die Richtlinie über die allgemeine Produktsicherheit 2001/95/EG. Diese Richtlinie schützt Verbraucher vor unsicheren Produkten. Auch eine mangelhafte Anleitung wird als Produktfehler betrachtet, wenn hier entsprechende Instruktionsfehler vorliegen (Im U.S. Recht: Failure of adequate warn). Für viele Produkte werden häufig in Europäischen Richtlinien Anforderungen an die Anleitung gestellt. Gibt es keine gesetzliche Vorgabe, sollte die Anwendung der Norm in Betracht gezogen werden, um die Vermutung auszulösen, dass die Anleitung dem Stand der Technik entspricht.
4. Texte verfassen
Illustrationen können Texte unterstützen und gelegentlich können Texte vollständig durch Illustrationen ersetzt werden. Illustrationen ersetzen Wörter und verringern dadurch die Übersetzungskosten. Außerdem sagt ein Bild mehr als 1000 Worte. Ein gutes Gleichgewicht zwischen Text, Illustrationen und Leerraum sorgt dafür, dass Lesbarkeit und Verständlichkeit gesteigert werden. Berücksichtigen Sie, wenn Sie eine Anleitung schreiben, dieses Gleichgewicht.
5. Anleitung zusammenstellen
Die Anleitung in Papierform ist am bekanntesten. Anleitungen online und on device werden jedoch immer beliebter. Leider fehlt jedoch hierfür eine gute rechtliche Basis, um auch wirklich sicher zu sein, die Informationen adäquat und dauerhaft verfügbar den Verwendern bereitgestellt zu haben. Für die Veröffentlichung dieser unterschiedlichen Ausgabeformate gibt es diverse Softwarelösungen. Diese Software für Authoring, Editing, Publishing nutzt Datenbanken, in denen Texte organisiert werden. Die gute modulare Verwaltung dieser Texte (mit entsprechenden Übersetzungen) fördert deren Wiederverwendung, wodurch die Übersetzungskosten beträchtlich verringert werden.
