Wir begleiten Unternehmen und Marken beim Schreiben ihrer Anleitungen

Eine gute Anleitung vermittelt dem Nutzer eines Produkts Informationen. Unter Produkt verstehen wir Geräte, Maschinen, Anlagen und Software. In einer Anleitung werden sämtliche Nutzer Aspekte wie Installation, Montage, Inbetriebnahme, Bedienung, Transport und Störungen erläutert. Wir schreiben ihre Anleitungen und versiehen diese mit ansprechenden Illustrationen.

FORDERN SIE DIREKT EIN ANGEBOT AN


Eine Anleitung schreiben in 5 Schritten 

Einige Aspekte sind bei der Erstellung einer Anleitung 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, dem Nutzer Informationen über das Produkt präzise und effektiv zu vermitteln. Jeder Nutzertyp besitzt eigene Eigenschaften. Entscheidend ist, dies beim Schreiben einer Anleitung zu berücksichtigen. Ältere Nutzer eines Notrufsystems stellen völlig andere Anforderungen an eine Anleitung als der Monteur eines modularen Pontonsystems.

Vor dem tatsächlichen Schreiben der Anleitung wird mit diversen beteiligten Fachleuten gesprochen. Dies können Elektrotechniker, Werkzeugmacher oder Industriedesigner sein, aber auch Kommunikationsfachleute oder Wartungstechniker. Die Fachleute stellen die Produktinformationen bereit und jeder Experte wird dabei seine eigene Fachsprache verwenden. Für den Verfasser einer Anleitung ist es die Kunst, diese Informationen dem Nutzer verständlich näher zubringen, ohne Zugeständnisse bei den Gegebenheiten machen zu müssen. 

anleitung schreiben

2.  Inhaltsverzeichnis zusammenstellen

Vergleichen Sie zehn gute Anleitungen und Sie werden die Gemeinsamkeiten beim Inhaltsverzeichnis erkennen. Eine gute Anleitung stellt sicher, dass der Nutzer ein Produkt korrekt und sicher gemäß vorgesehenen Verwendungszweck verwenden kann. Ohne eine vollständige Anleitung ist dies schier unmöglich. In Deutschland gibt es eine Norm für Gebrauchsanleitungen, die DIN 82079. Diese Norm beschreibt unter anderem den Inhalt einer Anleitung. 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 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, Risikoanalysen usw.  Der Verfasser der Anleitung 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 mangelhaften Produkten. Auch eine mangelhafte Anleitung wird als Produktmangel betrachtet. Für professionelle Produkte werden häufig mittels CE-Richtlinien Anforderungen an die Anleitung gestellt.

4.  Texte verfassen

Sobald die Informationen vollständig und übersichtlich sind, können diese in verständliche Texte umgesetzt werden. Meist werden die Produktinformationen für die Anleitung redigiert. Marketingtexte sind häufig nicht informativ genug und technische Informationen sind für die Zielgruppe häufig nicht ausreichend verständlich. Die Zielgruppe spielt weithin eine entscheidende Rolle, da die Informationen dem Nutzer präzise und effektiv vermittelt werden müssen. Es gibt zwei Prinzipien, die eine wichtige Rolle bei der effektiven Übermittlung von Informationen spielen: Minimalismus und Simplified Technical English (STE). STE verringert die Textmenge, da häufig überflüssige Informationen in Sätzen weggelassen werden. Dies führt durchschnittlich zu einer Verringerung von 30%. STE ist in der Norm ASD-STE100 beschrieben. Die Prinzipien des Minimalismus sorgen dafür, dass die erforderliche Aufnahmezeit um 30% sinkt und dass die Speicherung von Informationen um 25% steigt.

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. Für die Veröffentlichung dieser unterschiedlichen Ausgabeformate gibt es diverse Softwarepakete. 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. Häufig verwendete Softwarepakete in der technischen Dokumentation und bei eine Anleitung schreiben sind FrameMaker und Author-it. Hier finden Sie Beispielen von Anleitungen. 


Fordern Sie direkt ein Angebot an!

Fordern Sie ein Angebot an