Wir begleiten Unternehmen und Marken bei der Erstellung ihrer Dokumentation

Zweck einer Anleitung ist es, dem Nutzer eines Produkts Informationen darüber zu vermitteln. Produkte können Maschinen, Software, Geräte und und Verbraucherprodukte sein. Eventuelle Risiken, die nicht vom Produkt selbst - oder durch Ergänzungen des Produkts - verhindert werden, werden in der Anleitung beschrieben. Zudem werden in der Anleitung sämtliche Aspekte wie Bedienung, Anschluss, Montage, Transport und Wartung erläutert.

FORDERN SIE DIREKT EIN ANGEBOT AN


Eine Anleitung in 10 Schritten 

Einige Aspekte sind bei der Erstellung einer Anleitung nahezu immer entscheidend. Umfassendes Wissen oder entsprechende Ansätze tragen zur Qualität der Anleitung bei. Nachstehende Aufzählung benennt kurz diese Aspekte.

1.  Anleitung erstellen? Zielgruppe kennen!

Produktinformationen müssen Nutzer oder Zielgruppe korrekt und effektiv vermittelt werden. Dabei ist es wichtig zu wissen, dass jede Zielgruppe eigene Eigenschaften besitzt, die bei der Erstellung der Anleitung berücksichtigt werden müssen. Beispielsweise besitzt der Durchschnittsverbraucher völlig andere Eigenschaften als der Monteur einer Wasseraufbereitungsanlage. Dies erfordert unterschiedliche Ansätze.

Beim Anleitung Schreiben wird meist mit mehreren Fachleuten gesprochen, etwa Ingenieuren (Werkzeugmachern, Elektrotechnikern, Industriedesignern), Monteuren, Wartungstechnikern, Marketing-Fachleuten usw. All diese Fachleute liefern Informationen zum Produkt. Und all diese Experten verwenden ihre eigene Fachsprache. Bei der Erstellung der Anleitung ist es die Kunst, all diese Informationen so der entsprechenden Zielgruppe näherzubringen, dass sie sie verstehen, ohne Zugeständnisse bei den Gegebenheiten machen zu müssen.

Zudem gilt für jeden Nutzer und für die Erstellung jeder Anleitung:

  • Überflüssiges weglassen. Effektiv schreiben. Oder wie Albert Einstein es formulierte: „Everything should be made as simple as possile, but not simpler.“
  • Der Nutzer muss sich möglichst wenig anstrengen müssen (laut Grundsätzen des Minimalismus ist jedoch etwas Anstrengung erlaubt).
  • Gliederung ist wichtig. Aus Inhaltverzeichnissen muss klar hervorgehen, welche Informationen auf welcher Seite gefunden werden können. Überschriften müssen angeben, warum der Nutzer Zeit investieren soll, jenen Abschnitt zu lesen. Nutzen Sie beispielsweise eine Überschrift wie How to connect to a device statt Bluetooth Connectivity.

2.  Richtlinien prüfen

Die Richtlinie über die Produkthaftung 85/374/EWG schützt den Verbraucher gegen Schäden infolge eines mangelhaften Produktes. Wenn ein Produkt Mängel aufweist, kann der Hersteller (oder Importeur) haftbar gemacht werden. Eine Anleitung wird als fester Bestandteil des Produkts betrachtet. Eine unzureichend effektive Anleitung kann somit dazu führen, dass das Produkt als mangelhaft eingestuft wird.

Zudem erfordern die CE-Richtlinien, dass eventuelle Restrisiken eines Produkts in der Anleitung beschrieben werden. Daher ist es entscheidend, über die für das Produkt geltenden Richtlinien informiert zu sein. Sind diese Richtlinien bekannt, kann davon abgeleitet werden, was bei der Erstellung der Anleitung berücksichtigt werden muss. Beispielsweise fordert die Maschinenrichtlinie unter anderem, sowohl die bestimmungsgemäße Verwendung als auch die vorhersehbare Fehlanwendung in die Anleitung aufzunehmen. Zudem müssen Informationen über Schallpegel, Stabilität, Hersteller usw. aufgenommen werden. Die Maschinenrichtlinie und einige andere Richtlinien stellen darüber hinaus Anforderungen an die Übersetzung von Anleitungen.

 

3.  Gliederung erstellen

Eine Anleitung muss vollständig sein und soll die korrekte und sichere Nutzung fördern. Häufig erfordern Richtlinien, bestimmte Aspekte aufzunehmen. In vielen Fällen lassen die Richtlinien auch Raum für eine eigene Auslegung. Eine Handreichung zur Erstellung einer guten Anleitung ist die Verwendung von Normen. Die DIN 82079  ist die deutsche Norm für Gebrauchsanleitungen. Die Norm beschreibt Inhalt, Struktur, Formulierung und Darstellung von Anleitungen. Es wird eine Gliederung beschrieben, die eine gute Anleitung enthalten sollte. Mindestbestandteile sind der Norm zufolge beispielsweise Sicherheitshinweise, technische Spezifikationen, Montage, Nutzung und Wartung. Die Norm enthält jedoch zum Beispiel auch Mindestanforderungen in Bezug auf die Titelseite oder das Vorwort sowie die Schriftgröße.

4.  Produktinformationen sammeln

Beim Dokumentation erstellen ist es entscheidend, möglichst viele Produktinformationen zu sammeln, etwa technische Spezifikationen, Montagepläne, Marketing-Dokumentation, eventuelle CAD-Dateien usw. Diese Informationen werden von Fachleuten im entsprechenden Unternehmen bereitgestellt. Es ist die Kunst, gut zuzuhören, die Informationen zu analysieren und zu verstehen, Fragen zur Bestätigung der Eindrücke zu stellen und eine Auswahl zu treffen.

5.  Erstellung wirkungsvoller und anleitender Texte

Wenn sämtliche Informationen gesammelt und ausgewählt wurden, können diese für die Erstellung der Texte verwendet werden. Die konsequente Berücksichtigung der Zielgruppe, für die die Anleitung erstellt wird, ist entscheidend. Informationen müssen nämlich der Zielgruppe verständlich nähergebracht werden. Im Allgemeinen müssen dann auch sämtliche Produktinformationen redaktionell bearbeitet werden. Häufig ist es so, dass Marketingtexte nicht genau genug sind und technische Beschreibungen nicht verständlich genug für die Zielgruppe. Die Grundsätze des Minimalismus und von Simplified Technical English (STE) können dazu beitragen, Informationen effektiver und besser zu kommunizieren. Der Einsatz von Minimalismus schafft eine um 30% geringere Schulungszeit und sorgt dafür, dass sich die Aufnahme der Informationen durch den Nutzer um 25% verbessert.

6.  Text komprimieren

Niemand möchte viel Text in einer Anleitung lesen und niemand freut sich über hohen Übersetzungsaufwand. Illustrationen ersetzen Wörter, Bilder sagen mehr als 1000 Worte und müssen natürlich nicht übersetzt werden. Auch das zuvor genannte STE verringert den Textumfang. Sätze enthalten häufig überflüssige Wörter und Informationen. Durch den Einsatz der Grundsätze der STE-Norm (ASD-STE100) wird alles Überflüssige weggelassen, was zu einer Verringerung von 30% führt.

Anleitung erstellen

7.  Einsatz von Illustrationen/Animationen

Illustrationen verringern den Textanteil. Zudem verdeutlichen Abbildungen Anweisungen im Gegensatz zu einer ausschließlich textlichen Beschreibung. Montage- und Installationshinweise werden meist durch Abbildungen ersetzt, so dass eine IKEA-ähnliche Anleitung entsteht. Vermeiden Sie die Verwendung von Fotos in einer Anleitung. Gelegentlich werden Anleitungen kopiert, worunter die Qualität eines Fotos leiden kann. Zudem enthält ein Foto zu viele überflüssige Informationen, was Unklarheit verursacht. Bei der Erstellung einer guten Illustration kann entschieden werden, welche Produktinformationen oder –details weggelassen werden, damit der Anleitung die gesamte Aufmerksamkeit zukommt. Illustrationen schaffen darüber hinaus eine freundliche Aufmachung der Anleitung, die angenehm zu lesen ist. CAD-Dateien, die verwendet werden, um Illustrationen zu erstellen, werden übrigens immer häufiger auch für 3D-Animationen eingesetzt, welche die Verwendung eines Produkts erläutern. Ein QR-Code auf der Maschine kann den Wartungstechniker beispielsweise direkt zu einer Animation führen, wie die entsprechende Komponente auszutauschen ist.

8.  Übersetzung/ Lokalisierung

Aufgrund der Internationalisierung muss eine Anleitung häufig übersetzt werden. Gelegentlich wird die Entscheidung, die Anleitung zu übersetzen, aus Sicht einer guten und anwenderfreundlichen Produktunterstützung getroffen und manchmal auch, um lediglich die gesetzlichen Anforderungen zu erfüllen. Übersetzen ist eine Fachdisziplin, weshalb der Übersetzungsdienstleister sorgfältig ausgewählt werden muss. Fachwissen und konsistenter Sprachgebrauch (u. a. Terminologie) sind wichtige Aspekte. Bei wiederkehrenden Projekten kann der Übersetzungsdienstleister seinen Übersetzungsspeicher im Computer nutzen. Auch mittels guter Verwaltung übersetzter Texte kann die Wiederverwendung gefördert werden, wodurch eine erhebliche Kosteneinsparung erzielt werden kann.

9.  Organisation/ Dokumentation

Zur intelligenten Erstellung und Verwaltung von Anleitungen gibt es zahlreiche Tools. Einige der sogenannten Tool für das Erstellen einer Anleitung Authoring/Editing/Publishing sind Autor-itMacCap Flare und FrameMaker. Diese Softwarepakete besitzen Stärken zur Organisation der Informationen: Damit können Informationen modular gespeichert werden, um die Wiederverwendung zu fördern. Selbst haben wir Software zur Speicherung von Textmodulen entwickelt. Diese Software passt besser zu den höheren Anforderungen bezüglich der grafischen Aufmachung der Anleitung.

10.  Output generieren

Produktinformationen werden mit Hilfe von Software-Tools in eine Anleitung umgesetzt. Wir unterscheiden zwischen drei Ausgabeformaten: Print, online und on device. Bei Anleitungen zur Verwendung online und on device können außer 2D-Abbildungen auch 3D-Animationen (Video-Anleitung) eingesetzt werden.


Fordern Sie direkt ein Angebot an!

Fordern Sie ein Angebot an