Sie möchten eine Anleitung schreiben?


Sie möchten eine Anleitung schreiben lassen?

Eine Anleitung vermittelt dem Leser Informationen zur Nutzung eines Produkts. Das Wort „Produkt“ bezeichnet in diesem Fall Geräte aller Art, Maschinen, Anlagen sowie Software. Die Anleitung erläutert dem Nutzer Punkte wie Installation, Montage, Inbetriebnahme, Bedienung, Transport sowie Störungen und deren Behebung. Manualise verfasst Ihre Anleitungen und ergänzt sie durch hilfreiche, optisch ansprechende Illustrationen.

Fordern Sie direkt ein Angebot an >

Eine Anleitung in 5 Schritten

Es gibt Punkte, die bei der Erstellung fast jeder Anleitung zu beachten sind, und deren Kenntnis wesentlich zur Qualität der Anleitung beiträgt. Diese Punkte sollen im Folgenden erläutert werden.

1. Sie möchten eine Anleitung schreiben? Dann müssen Sie zunächst Ihre Zielgruppe kennen!

Die Produktinformationen müssen dem Nutzer so präzise und effektiv wie möglich zur Verfügung gestellt werden. Jeder Nutzertyp besitzt andere Eigenschaften, so dass gegebenenfalls dieselben Informationen anders aufzubereiten und zu vermitteln sind. Um dies berücksichtigen zu können, muss der Verfasser einer Anleitung die betreffende Zielgruppe genau kennen. Nutzer eines Notrufsystems für Senioren haben einen komplett anderen Informationsbedarf als der Monteur eines modularen Pontonsystems.

Bevor mit dem Schreiben begonnen wird, müssen die benötigten Informationen von den unterschiedlichsten Beteiligten zusammengetragen werden. Unter diesen Fachleuten sind Entwickler, Elektrotechniker, Werkzeugmacher und Industriedesigner, aber auch Kommunikations- und Marketingexperten oder Wartungstechniker. Sie alle verfügen über unterschiedliche Informationen über das Produkt und werden sie in ihrer eigenen Fachsprache kommunizieren. Die Kunst ist nun, diese Informationen für die Zielgruppe verständlich aufzubereiten, ohne dabei wichtige Punkte außen vor zu lassen.

2. Inhaltsverzeichnis

Wenn Sie zehn gute Anleitungen vergleichen, werden Ihnen sicher Gemeinsamkeiten in der Struktur auffallen. Eine gute Anleitung ermöglicht die bestimmungsgemäße, korrekte und sichere Nutzung des Produkts. Dazu müssen die enthaltenen Informationen nicht nur vollständig sein, sondern auch logisch und verständlich gegliedert. Die in Deutschland geltende Norm für Gebrauchsanleitungen ist die DIN 82069 , die unter anderem Vorschriften zum Inhalt von Anleitungen enthält. Die dort beschriebene Gliederung beinhaltet u. a. Kapitel für Sicherheits- und Warnhinweise, Aufbau und Installation, Inbetriebnahme, Wartung und technische Spezifikationen und sollte Grundlage jeder Anleitung sein. Auch Empfehlungen zu Punkten wie Schriftgröße oder Inhalt der Titelseite sind in dieser Norm zu finden. Im Folgenden soll im Detail auf den Inhalt eingegangen werden.

3. Informationsrecherche

Ist die Struktur erst einmal festgelegt, kann sie mit Informationen gefüllt werden. Immer ist zu beachten, dass so viele Informationen wie möglich zusammengetragen werden müssen – CAD-Dateien, Marketingdokumentation, Risikoanalysen und vieles mehr. Der Verfasser sammelt, filtert und analysiert diese Daten und hakt nach, wenn Informationslücken auffallen oder weiterer Recherchebedarf entsteht.

Ein besonders wichtiger Punkt ist die Kenntnis sämtlicher Verpflichtungen bezüglich Produktsicherheit und Produkthaftung. Solche Verpflichtungen betreffen nämlich oft auch die Produktdokumentation und damit den Inhalt der Anleitung. Für Verbraucherprodukte gilt die Richtlinie über die allgemeine Produktsicherheit 2001/95/EG, die Verbraucher vor Schäden durch Produktmängel schützen soll. Unter Produktmängel fallen auch mangelhafte Anleitungen. Bei professionellen Produkten werden häufig in CE-Richtlinien Anforderungen an die Anleitung gestellt.

4. Texte verfassen

Sind alle nötigen Informationen vorhanden und übersichtlich geordnet, werden sie in Text gefasst. Meist müssen die Produktinformationen redigiert, also verständlich und leserfreundlich aufbereitet werden. Während Marketingtexte häufig weniger Wert auf tatsächliche Informationsvermittlung legen, sind technische Beschreibungen für Laien oft unverständlich oder zu detailliert. Die Zielgruppe spielt eine entscheidende Rolle, da eine präzise und effektive Informationsvermittlung für jeden Nutzertyp anders aussehen kann. Zwei Prinzipien spielen dabei eine wichtige Rolle: Minimalismus und Simplified Technical English (STE). STE reduziert die Textmenge – überflüssige oder nicht informationstragende Elemente werden weggelassen, wodurch eine durchschnittliche Reduzierung um 30 % erzielt wird. Die Grundsätze des STE sind in der Norm ASD-STE100 zu finden. Das Prinzip des Minimalismus dagegen optimiert die Informationsaufnahme und -speicherung – die erforderliche Aufnahmezeit kann um bis zu 30 % reduziert werden, während die Speicherung sich um bis zu 25 % verbessert.

Illustrationen in textlichen Beschreibungen können unterstützend wirken und sie unter Umständen auch komplett ersetzen. Ein großer Vorteil textersetzender Illustrationen ist die Reduzierung der anfallenden Übersetzungskosten. Ein Bild sagt bekanntlich mehr als 1000 Worte. Ein gutes Gleichgewicht von Text, Illustrationen und Leerraum lockert die Anleitung optisch auf und optimiert Leserfreundlichkeit und Verständlichkeit. Auf dieses Gleichgewicht sollte daher größter Wert gelegt werden.

5. Zusammenstellung

Der bekannteste und nach wie vor am weitesten verbreitete Anleitungstyp ist die gedruckte Anleitung in Papierform. Online– und On-Device-Anleitungen erfreuen sich jedoch steigender Beliebtheit. Für die Veröffentlichung unterschiedlicher Outputformate sind diverse Softwareprogramme auf dem Markt. Diese Software für Authoring, Editing und Publishing verwendet Datenbanken, mithilfe derer sich Texte und Inhalte verwalten lassen. Die Modularisierung von Texten und den entsprechenden Übersetzungen fördert den Wiederverwendungswert, was unter anderem die Übersetzungskosten beträchtlich reduziert. Besonders bekannt und in der technischen Dokumentation häufig verwendet sind FrameMaker und Author-it.

Herangehensweise bei Erstellung unterschiedlicher Anleitungen

Die grundlegenden Schritte zur Erstellung einer Anleitung sind jedoch bei Manualise für all diese Anleitungstypen gleich:

 

Schritt 1
Inhalte festlegen

Alle erforderlichen Produktinformationen werden zusammengetragen. Verfassen von Texten, ggf. ergänzt durch Illustrationen.

Schritt 2
Gestaltung und Darstellung festlegen

Die für die betreffenden Produktinformationen am besten geeignete Struktur wird ermittelt und festgelegt. Die Gestaltung wird festgelegt.

Schritt 3
Anleitung zusammenstellen

Stehen Inhalte und äußere Form fest, beginnt Manualise mit der Erstellung der eigentlichen Anleitung – Form und Inhalte werden im gewünschten Outputformat zusammengeführt.

Referenzen

Sie möchten eine Anleitung erstellen lassen und brauchen einen zuverlässigen Partner? Manualise unterstützt seine Kunden mit Rat und Tat bei der Erstellung, Optimierung und Verwaltung ihrer Anleitungen. Zu unseren Kunden zählen:

„Ich erfahre die Zusammenarbeit mit Manualise als nahezu perfekt. Es wird offen und ehrlich kommuniziert. Vereinbarte Fristen werden immer problemlos eingehalten.“

- Arjo van Geest , Big Green Egg Europe -


Möchten auch Sie Ihre Anleitungen bei Manualise erstellen lassen?

Fordern Sie direkt ein Angebot an >

Haben Sie Fragen zu unseren Leistungen?

Rufen Sie uns an: + 49 3222 10320-01 Ruf mich an >