Was ist eine Betriebsanleitung und worauf kommt es beim Erstellen an?

Im Folgenden wollen wir Ihnen einen ersten Überblick verschaffen, wie man eine Bedienungsanleitung erstellt. Wir wollen Ihnen damit die Entscheidung erleichtern, ob Sie ein Handbuch von Experten erstellen lassen wollen oder ob es Ihnen genügt, sich bei der Erstellung eines Handbuchs beraten zu lassen.

Sie haben ein Produkt, das Sie verkaufen oder zur internen Benutzung zur Verfügung stellen? Dann sind Sie vermutlich bereits auf das Thema Technische Dokumentation gestoßen.

Mit der Technischen Dokumentation sind die vielen Informationen gemeint, die man als Hersteller, Importeur oder Händler für Produkte bereithalten muss.

Wichtig für Ihre Kunden bzw. die Kunden Ihrer Produkte ist die Anleitung. Sie kann entweder als Montage- und Gebrauchsanleitung oder als gesamtes Handbuch Ihrem Produkt beiliegen.

Wir möchten Ihnen im Folgenden detailliert zeigen, was für Sie relevant ist, wenn Sie eine Technische Dokumentation erstellen wollen.

Was ist eine Dokumentation?

Dokumentation ist im Sinne einer Technischen Dokumentation ein festgehaltener Nachweis (etwas, das dokumentiert), was der Benutzer mit Ihrem Produkt wie, wann, warum und wofür machen kann und darf oder unbedingt unterlassen sollte.

Es handelt sich also um technisch bezogene Unterlagen zum Produkt.

Systematik mit Konzept und Redaktionsleitfaden

Bevor Sie sich daran machen, ein Handbuch zu erstellen, müssen die Anforderungen an Ihre Betriebsanleitung ermittelt werden.

Dabei geht es um Fragen wie "Wer liefert welchen Inhalt und welche Informationen?", "Wer soll das Handbuch lesen?" oder "Was soll und muss die Bedienungsanleitung beschreiben?". Die Antworten darauf halten Sie am besten in einem Konzept fest.

Im Redaktionsleitfaden wird dann festgelegt, wie die Technische Redaktion das erstellte Konzept umsetzt.

Konzept

In einem Konzept findet sich üblicherweise alles Wichtige für die Erstellung der Bedienungsanleitung. Das kann, je nach Unternehmensgröße und Produktvielfalt, viele Seiten bedeuten oder nur eine kleine Zusammenfassung, was, wo, wie, wofür und durch wen erledigt wird.

Das Konzept sollte übersichtlich und kompakt zeigen, wie Ihre Technische Dokumentation erstellt wird, wie mit Input umgegangen wird und was für den Output relevante Rahmenbedingungen sind.

Die Handbuch Experten halten in dem Konzept alle wissenswerten Informationen für Sie fest:

  • Gesetzliche und normative Vorgaben an die Benutzerinformation, dazu müssen auch die Anforderungen an das Produkt bekannt sein.
  • Organisatorisches Vorgehen (welche Abteilungen welchen Part zu welchem Zeitpunkt bei der Erstellung der Technischen Dokumentation erfüllen)
  • Zielgruppe
  • Produktspezifische Vorgaben (Eigenheiten, Varianten, Optionen, Zusatzteile, etc.)
  • Ausgabeformate (soll "nur" ein gedrucktes Handbuch oder auch eine Online-Hilfe oder weitere Dokumente generiert werden?)
  • Tools
  • Design Vorgaben, Layout-Anforderungen
  • Grob-Gliederung
  • Varianten der Dokumente (Welche Sprachen sind relevant? Gibt es Varianten im Produkt, die spezifische Anleitungsteile benötigen, die in anderen Produktvarianten nicht enthalten sein sollen?)

So erfassen wir systematisch die wichtigen Informationen für Ihre Technische Dokumentation. Und zwar so dargestellt und formuliert, dass Ihrer Technischen Redaktion sofort klar ist, welche Art von Information wo hingehört und wohin abgelegt werden muss.

Standardisieren Sie Ihren Dokumentations-Prozess mit einem Konzept.

Unterstützung für Ihr Konzept erhalten

Redaktionsleitfaden

In einem Redaktionshandbuch oder Redaktionsleitfaden erklären Sie konkret, was die Technische Redaktion bei der Erstellung der Technischen Dokumentation beachten und einhalten soll:

  • Definition der Formate für die entsprechenden Informationsarten
  • Bildeinsatz und Bildbeschaffung
  • Formulierungsmuster für Sätze
  • Terminologie-Management
  • Sicherheit und Warnhinweise – Unterscheidung, Vorkommen in der Anleitung
  • Übersetzungsmanagement der Technischen Dokumentation

Die Inhalte Ihrer Benutzungsinformation werden so von verschiedenen Personen in einer sehr vergleichbaren Art und Weise erzeugt und Ihr Handbuch wirkt wie aus "einem Guss".

Durch klare Vorgaben im Redaktionshandbuch gelangt Ihre Doku zu mehr Konsistenz.

Unterstützung für Ihr Redaktionshandbuch erhalten

Vorgaben

Es gibt viele Vorgaben, die die Technische Dokumentation betreffen. Darunter fallen rechtliche Anforderungen (gesetzlich oder vertraglich geregelt), die Ihr Handbuch erfüllen muss, aber auch freiwillig anzuwendende Vorgaben.

Rechtliche Vorgaben für Dokumentation

Je nach dem, welche Vorgaben für Ihr Produkt relevant sind, müssen mehr oder weniger zusätzliche Punkte zu dem Grobkonzept dazu kommen. Zum Beispiel müssen alle Hersteller gesetzliche Vorgaben einhalten.

Es existieren auch Anforderungen zur Sprache des Handbuchs, wie z. B. die Anleitung in der Landessprache mitzuliefern, wenn Ihr Produkt mit CE gekennzeichnet ist.

Wenn Ihr Produkt beispielsweise das CE-Kennzeichen trägt, müssen Sie in Deutschland eine deutsche Bedienungsanleitung beifügen, da die Amtssprache in Deutschland deutsch ist. In anderen EU-Mitgliedsstaaten müssen dann entsprechend die dort geltenden Amtssprachen beachtet werden.

Normen

Zusätzlich spielen diverse Normen für die Erstellung des Handbuchs eine Rolle. Einerseits gibt es beispielsweise Normen für Betriebsanleitungen, wie ein Handbuch erstellt wird oder welche Inhalte relevant sind. Produktspezifische Normen können auch konkrete Anforderungen an die Benutzerinformation stellen. Zudem gibt es ggf. weitere technische Regeln oder Vorgaben seitens Ihrer Kunden, was für das Handbuch und seine Erstellung wichtig ist.

Es gibt zum einen eine Norm zum Erstellen von Bedienungsanleitungen die ISO/IEC/IEEE 82079 (ehemals DIN EN 62079) mit dem Titel "Erstellen von Nutzungsinformationen (Gebrauchsanleitungen) für Produkte - Teil 1: Grundsätze und allgemeine Anforderungen", die unter anderem auch die nötigen Fähigkeiten und Aufgaben einer ausgebildete Technischen Redaktion und deren Arbeitsweise im Allgemeinen beschreibt.

Zum anderen gibt es seit 2019 die Norm DIN EN ISO 20607, die zur Maschinenrichtlinie harmonisiert wurde. Der Titel ist "Sicherheit von Maschinen - Betriebsanleitung - Allgemeine Gestaltungsgrundsätze". Diese Norm will auch Nicht-Redakteuren einen Leitfaden geben, wie man bei der Erstellung der Bedienungsanleitung für Maschinen vorgehen soll, um die Sicherheit der Maschinen zu gewährleisten.

Für Software-Produkte sind die Normen ISO/IEC/IEE 26511, 26512, 26513, 26514 und 26515 relevant, die sich mit dem gesamten Lebenszyklus der Benutzerinformation befassen. Hier wird von der Planung bis zum Test der Verständlichkeit alles empfohlen, was für eine normengerechte Benutzerinformation zu beachten ist.

Erfüllt Ihre Technische Dokumentation die rechtlichen Vorgaben ausreichend?

Lassen Sie Ihre Dokumentation prüfen

Sprache der Betriebsanleitung

Sie können die Sprache Ihrer Anleitung frei wählen, sofern es keine gesetzlichen Vorgaben zur Sprache gibt. Aus Sicht der Produkthaftung sollte jedoch die Landessprache zumindest in Erwägung gezogen oder abweichendes Vorgehen begründet dokumentiert werden.

Die Handbuch Experten verfassen Ihre Betriebsanleitungen immer in deutscher Sprache. Das ist unsere Muttersprache. In der Muttersprache fallen Unklarheiten oder Missverständliches leichter auf als in einer Fremdsprache, unabhängig davon, wie gut man die Fremdsprache beherrscht.

Für Fremdsprachen greifen wir immer auf professionelle Übersetzer zurück. Mehr zur Übersetzung finden Sie im Abschnitt Mehrsprachigkeit.

Gedruckte oder digitale Bedienungsanleitung?

Bedienungsanleitungen können in Papierform, also in Printform, oder digital vorgelegt werden. In welcher Form Ihr Handbuch produziert werden soll, hängt von Ihren spezifischen und ggf. gesetzlichen oder vertraglichen Anforderungen an die Bedienungsanleitung ab.

Für oder gegen Papier mag für Sie als Hersteller des Handbuchs insbesondere eine Kostenfrage sein. Bisher geht jedoch die Rechtsprechung häufig davon aus, dass die Anleitung in Papierform beigelegt sein muss. Trotzdem kommen immer wieder Fälle vor, die auch digitale Bedienungsanleitungen erlauben.

Für die Zukunft ist vorhersehbar, dass das Papier als einzig wahres Medium abdanken wird. Wann genau und durch welchen Ersatz wird sich erst noch zeigen.

Generell gibt es regulatorische Unterschiede bei verschiedenen Produkten und in verschiedenen Branchen:

  • Maschinen
  • Medizinprodukte
  • Software
  • Endverbraucher-Produkte

Es gab einen Fall, in dem ein Online-Shop keine Papier-Anleitung liefern musste. Es reichte eine per E-Mail versendete PDF-Bedienungsanleitung aus, da der gesamte Bestellvorgang online (Bestellung, Auftragsbestätigung, Rechnung, etc.) abgewickelt wurde.

Allerdings gab es für die Produktgruppe auch keine gesetzlichen Vorgaben, die eine Papieranleitung gefordert hätten.

Es muss also vorab für jeden Fall geprüft werden, wer den Wettbewerb print vs. online am Ende gewinnt.

Möglichst rein grafische Anleitung

Eine rein in Textform vorliegende Bedienungsanleitung wie zum Beispiel die Beipackzettel bei Medikamenten können recht eintönig wirken. Grafiken lockern da den Text auf. Sie sind in einer Bedienungsanleitung allerdings nicht nur als reine Illustration einsetzbar. Wie Text- oder Grafik-lastig Sie ihre Handbücher erstellen wollen hängt von Ihren Anforderungen und Ihrem Produkt ab.

Ein klassisches Beispiel für möglichst Grafik-lastige Anleitungen ist die Montageanleitung von IKEA. Hier wird viel Zeit und Geld investiert, um viele, möglichst verständliche, Grafiken zu erstellen, die ohne weitere Übersetzungskosten für möglichst viele Sprachen gelten können. Da kennt jeder verschiedene Erzählungen, wie gut diese Grafiken zur Verständlichkeit beitragen.

Auch wenn diese Bedienungsanleitungen vielfach professionell gemacht sind, stoßen bei komplexeren Produkten Grafiken möglicherweise an ihre Verständnisgrenze. Bei Produkten mit größerem Verletzungspotential sind zudem entsprechende Warnhinweise nahezu unverzichtbar.

Eine sehr bildhafte Anleitung kann im europäischen Markt hilfreich sein, wenn das Produkt durch Grafiken ausreichend erklärt werden kann und wenige Gefahren auftreten. Für Amerika wäre eine gemischte Form immer vorzuziehen, bei dem der Text die Grafiken beschreibt und erklärt.

Bei der Erstellung von Handbüchern ist es nicht nur eine Frage der Übersetzungskosten, die sich durch grafische Bedienungsanleitungen einsparen lassen, sondern auch eine Frage der Zielgruppe sowie des Budgets. Denn, auch wenn Grafiken üblicherweise nicht übersetzt werden müssen, ist der Herstellungsprozess häufig deutlich aufwändiger.

So sollten auf jeden Fall (möglichst vor dem Einsatz) Tests durchgeführt werden, ob die Grafiken auch richtig verstanden werden. Die Möglichkeit der Missinterpretation liegt bei Bildern auf einem ganz anderen Niveau im Vergleich zu textlichen Bedienungsanleitungen (die selbstverständlich auch missverstanden werden können).

Zielgruppe

Was Ihr Handbuch am Ende beinhaltet und wie es aussieht, sollte sich vor allen Dingen daran orientieren, was für die Nutzung Ihres Produkts relevant und hilfreich ist. Damit Sie die richtigen Parameter auswählen, ist eine Analyse Ihrer Zielgruppe unerlässlich.

Üblicherweise wird die Zielgruppe nicht gerade exakt dokumentiert und beschrieben. Doch ein kleines Beispiel aus dem Marketing hilft Ihnen vielleicht zu erkennen, weshalb es sinnvoll sein kann, Ihre Zielgruppe genauer zu spezifizieren als nur "männlich, über 60, lebt in London, hat ein Einkommen über 1 Mio. Pfund". Wenn Sie diese sehr schmalen Angaben nutzen, könnte einerseits Prinz Charles herauskommen, andererseits Ossy Osbourne. Würden Sie beide bei der Produktwerbung vergleichbar ansprechen?

Es ist also durchaus hilfreich, sich von dem klassischen "Fachpersonal", das beispielsweise im Maschinenbau gerne angesprochen wird, zu verabschieden und genauer zu überlegen, wer denn mit Ihrem Produkt umgehen darf oder soll bzw. auch nicht sollte. Denn teilweise sind manche Vorkenntnisse nur für bestimmte Tätigkeiten am Produkt relevant, andere können auch ungelernte Kräfte gut durchführen.

Sie können auch auf Nummer sicher gehen und die Verständlichkeit und Vollständigkeit ihrer Bedienungsanleitung in Zusammenspiel mit Ihrem Produkt durch Usability-Tests prüfen lassen.

Handbuch erstellen

In diesem Abschnitt erklären wir, worauf es ankommt, wenn Sie Ihr Handbuch erstellen (lassen). Sie können die folgenden Punkte auch als grobe Anleitung für das Erstellen einer Bedienungsanleitung verwenden.

Es hilft, wenn Sie die Technische Redaktion frühzeitig in den Informationsfluss zur Produktentstehung einbinden. So kann sie sowohl bei der Recherche mitarbeiten und i. d. R. auch Hinweise, z. B. zur Usability, geben und damit die Entwicklungsabteilung entlasten.

Sie möchten mit Ihrer Anleitung kein Haftungsrisiko eingehen?

Setzen Sie auf professionelle Handbücher und unsere Expertise bei deren Erstellung.

Angebot noch heute anfordern
oder unter +49 9126 2611-12 beraten lassen

Aufbau

Um Ihr Handbuch zu erstellen, müssen Sie zuerst den Aufbau Ihrer Bedienungsanleitung festlegen. Dabei sollten Sie schon im Vorfeld beachten, wenn Ihr Produkt mit verschiedenen Varianten auf dem Markt bereitgestellt wird – oder Sie viele ähnliche Produkte haben. Normativ ist z. B. empfohlen, den Produktlebenszyklus, den der Anwender mit dem Produkt durchläuft, als Grundlage für den Aufbau einer Bedienungsanleitung zu wählen.

7 allgemeingültige Gliederungspunkte für Ihre Betriebsanleitung:

  • Sicherheitsrelevante Informationen,
  • Inbetriebnahme mit Montage / Installation,
  • Benutzung / Betrieb / Bedienung,
  • Instandhaltung / Wartung,
  • Fehlersuche,
  • Außerbetriebnahme mit Demontage und Entsorgung, sowie
  • Technische Daten.

Je nach dem, welche Varianten Ihr Produkt aufweist, macht es Sinn, Ihre Dokumente zu untergliedern oder modular aufzubauen und passgenau zusammenzufügen – oder, mit Metadaten versehen, passgenau zu filtern. So können Sie für jede Produktvariante das passende Handbuch erstellen. Diese Themen werden bei den Handbuch Experten bereits beim Aufbau und der Struktur des Handbuchs berücksichtigt. Die Automatisierung der variantenspezifischen Dokumentation haben wir bei AFASY erklärt.

Schreiben als Prozess

Sobald die Struktur für das Handbuch steht, gilt es, die Dokumentation zu schreiben. Üblicherweise beschreiben geübte Redakteure hierbei die einzelnen Abschnitte und justieren ggf. bei der Gliederung nach. Wenn einzelne Kapitel zu komplex und umfangreich scheinen, werden diese nochmal aufgeteilt. Kapitel mit wenig Inhalt werden evtl. zusammengefasst.

Häufig fallen beim Schreiben auch noch Punkte auf, die mit der Konstruktion / Entwicklung geklärt werden müssen. Zum Beispiel, weil es Ungereimtheiten zwischen Produkt und vorhandenen ersten Beschreibungen gibt oder komplizierte Bedienungsschritte sich mit kleinen Produktanpassungen optimieren lassen.

Gerade bei Software geht so etwas oft reibungslos. Hin und wieder wird die Technische Redaktion – manchmal ohne ihr Wissen – hier auch als beta-Tester genutzt.

Es ist also eine enge Abstimmung zwischen Entwicklung und Konstruktion des Produkts und der Redaktion notwendig. Dabei darf die Technische Redaktion als eine Art erste Produktnutzer durchaus auch mal kritisch Funktionsweisen und Vorgänge hinterfragen.

Sprache / Formulierungen

Für das Schreiben der Texte gilt das Prinzip "keep it simple". Einfache Sätze, wenig verschachtelt, immer gleich aufgebaut ist dabei die Maxime. So sind zum Beispiel Wiederholungen stilistisch nicht verpönt, anders als es in der Schule oftmals gepredigt wurde.

Wichtig ist auch, dass eine einheitliche Terminologie verwendet wird und gleiche Vorgänge immer gleich beschrieben werden. So werden bei den Handbuch Experten die Schrauben nicht mal angezogen, mal festgezogen, mal festgedreht, mal reingeschraubt – sondern es gibt eine Art und Weise, das auszudrücken und die wird durchgehend einheitlich verwendet.

Sicherheit

Das Thema "Sicherheit" wird in der Technischen Dokumentation besonders großgeschrieben. Da gibt es dann diejenigen, die die Anleitung mit Warnungen pflastern wollen, und diejenigen, die vor lauter Warnungen die eigentliche Bedienungsanleitung nicht mehr finden können.

Auf jeden Fall ist es unerlässlich, die relevanten Rest-Risiken in der Anleitung darzustellen. Und das in einem Maß, das die Aufmerksamkeit beim Lesen nicht überfordert, aber auf die Dringlichkeit und Notwendigkeit hinweist. Hier die "wichtigen" Informationen vorzuenthalten wäre fatal.

Genauso ist es falsch, weniger relevante oder weniger gefährliche Aspekte zu deutlich hervorzuheben, um von den wichtigen Hinweisen abzulenken. Ein gesundes Maß ist hierbei wesentlich.

Zudem müssen die Warnhinweise für die Zielgruppe relevant und verständlich sein.

Das Erstellen und Platzieren von Sicherheitshinweisen erfordert ein erhebliches Maß an Kenntnissen und Erfahrung in der Technischen Dokumentation. Wir helfen Ihnen gerne weiter, bewerten die von Ihnen erstellten Sicherheitshinweise oder erstellen diese auch gerne für Sie.

Technische Grafiken im Handbuch

Geeignete Grafiken mit relevantem Inhalt in einer Bedienungsanleitung erhöhen das Verständnis.

Wir können für Sie technische Zeichnungen erstellen, um Ihr Produkt geeignet zu umschreiben. Wir entwerfen für Sie auch geeignete Piktogramme, weil es möglicherweise relevante Informationen zu Ihrem Produkt gibt, für die noch keine genormten Piktogramme existieren. Ebenso überarbeiten wir Fotos und kennzeichnen die notwendigen Details entsprechend.

Welche Art von Grafiken gewählt wird, ist abhängig vom Produkt, vom Komplexitätsgrad und auch von Ihren Corporate Design Regeln.

Ziel bei der Erstellung von Bedienungsanleitungen ist am Ende, dass die Anwender wissen, was sie wann und wie mit dem Produkt tun dürfen und sollen – oder eben nicht. Eine gut ausgewogene Mischung aus Text und Grafik ist dabei hilfreich, um das Wissen für die effiziente und sichere Produktnutzung zu vermitteln.

Lektorat / Korrektorat

Lektorat

In unserem Haus gibt es eine goldene Regel: Jede geschriebene Bedienungsanleitung wird mindestens im 4-Augen-Prinzip geprüft. Das hat nicht nur mit Rechtschreibung und Grammatik zu tun, sondern auch mit der Nachvollziehbarkeit der Beschreibung.

Die Prüfung wird in der Regel durch einen erfahrenen Technischen Redakteur geleistet. So können Sie sicher sein, dass Ihre Bedienungsanleitung von uns optimal erstellt wurde.

Dennoch muss zudem noch eine Person aus Ihrem Unternehmen, die das Produkt umfassend kennt, das Handbuch fachlich auf Korrektheit prüfen. Erfolgt bei der Handhabung nun Schritt A vor Schritt B oder sollte das doch umgekehrt durchgeführt werden?

Korrektorat

Haben Sie die fachliche Richtigkeit sowie die Formulierungsmuster bereits geprüft und Sie stehen kurz vor dem Druck, kann Ihnen ein Korrektorat helfen, das nochmal auf Rechtschreibung, Grammatik und Orthografie prüft.

Qualität feststellen, erhöhen, halten

Ihre Produkte sind hochwertig und haben tolle Funktionen. Eine Qualität, die Sie auch als Standard in der Technischen Dokumentation festsetzen möchten. Doch wird in vielen Unternehmen die Qualität der Bedienungsanleitung nicht überprüft. Somit kann sie auch nicht nachvollziehbar erhöht oder gehalten werden.

Eine Möglichkeit, die Qualität Ihrer vorhandenen Dokumentation festzustellen, ist einen externen Experten zur Qualität zu befragen.

Sie können auch selbst Checklisten erstellen, welche Kriterien für die Qualität Ihrer Dokumente relevant sind und welche weiteren Anforderungen ggf. von außen von Ihrer Bedienungsanleitung einzuhalten sind. Anschließend prüfen Sie neutral (idealerweise nicht von der Person, die die Dokumente erstellt hat), ob diese Kriterien und Anforderungen erfüllt wurden.

Die Handbuch Experten bieten hierzu ihren Doku-Check an.

Der systematisierte Doku-Check ist bei den Handbuch Experten ein gern genutztes Mittel, um konkret aufzuzeigen, welche Kriterien gut, mäßig oder nicht erfüllt wurden.

Dabei decken wir regelmäßig für den Laien kaum ersichtliche Mängel aufgrund unserer systematischen Vorgehensweise und Erfahrungen aus über 6.500 Projekten auf. Das hat häufig dazu geführt, dass die komplette Dokumentation grundlegend überarbeitet und damit die Qualität deutlich erhöht wurde.

Wenn die Überarbeitung durch unsere Kunden geschieht, bieten wir einen wiederholten Check an, ob die Änderungen alle konsequent umgesetzt wurden. Das kann übrigens auch eine gute Möglichkeit sein – selbst nach einiger Zeit – zu prüfen, ob die höhere Qualität nun gehalten wurde.

Verwendung für die erstellte Doku

Nachdem ein qualitativ und optisch ansprechendes Exemplar Ihrer Bedienungsanleitung erstellt wurde und einem Revisionsprozess unterzogen wurde, stellt sich häufig die Frage: Soll die Bedienungsanleitung gedruckt werden oder nur online zur Verfügung gestellt werden?

Idealerweise wurde diese Frage bei der Konzeption des Handbuchs bereits beantwortet. Wenn nicht, kann es einige Nacharbeiten erfordern, z. B. wenn neben einem klassischen Handbuch gleichzeitig eine nicht vorher eingeplante Online-Hilfe erstellt werden soll.

Sobald die Bedienungsanleitung in den gewünschten Medien erstellt ist, können diese nun (endlich) an die Produktnutzer verteilt werden.

Tools: Welche Software gibt es für Bedienungsanleitungen?

Software für Technische Dokumentation gibt es viele. Und genauso viele Tools, wie es gibt, gibt es viele Wege, wie die Bedienungsanleitung erstellt werden kann.

Der erste Punkt, über den man sich bei der Tool-Auswahl Gedanken machen muss, ist: Welche Kriterien sind für unser Unternehmen und unsere Bedienungsanleitung wichtig und welche können ggf. noch dazukommen, die die Gestalt des Handbuchs in die eine oder andere Richtung beeinflussen können.

Redaktionssystem / CCMS

Dabei lässt sich häufig schnell eine erste Tendenz erkennen: Eine ausgebildete Redaktion ist es gewohnt, systematisch zu arbeiten. Sie bevorzugt deshalb häufig die Arbeit mit einem Redaktionssystem, da hier komplexe Informationen zusammengetragen werden können und innerhalb des Tools verschiedene Arbeiten erledigt werden können.

Das beginnt mit der Trennung von Design und Inhalt, geht über die Bildbearbeitung bis hin zum Varianten- und Sprachmanagement und dem Revisionsprozess.

Wenn das Unternehmen sehr viele Produkte, Varianten, Sprachen, Bilder, etc. anbietet, ist ein Redaktionssystem im Vorteil. Üblicherweise gibt es dann auch eine eigene Technische Redaktion, die diese Arbeiten durchführt und eng mit Konstruktion und Entwicklung zusammenarbeitet.

Editoren

Kleinere Unternehmen, die keine eigene Technische Redaktion beschäftigen, erstellen hingegen häufig die Betriebsanleitung mit Software, die bereits im Unternehmen vorhanden ist. Diese sind üblicherweise klassische "Editoren" – häufig das weit verbreitete Microsoft Word© oder Adobe InDesign©.

Allerdings muss mit einem Editor konsequent und mit geeignetem Wissen über die Software gearbeitet werden, um am Ende eine qualitativ hochwertige und systematische Bedienungsanleitung zu erstellen, die dem Erscheinungsbild des Unternehmens gerecht wird.

Hier bieten die Handbuch Experten durch ihre Projekterfahrung für kleinere und mittlere Unternehmen nicht nur die Erstellung Ihrer Technischen Dokumentation in diesen Tools, sondern auch Schulungen an, die Ihr Personal dazu befähigen, die Dokumente sauber zu pflegen.

Variantenmanagement für Betriebsanleitungen

Letztendlich entscheidet häufig auch die Vielzahl an Produkt- oder Sprachvarianten darüber, welches Tool sich am besten für Ihr Handbuch eignet.

Ein nicht vorhandenes Variantenmanagement im einfachsten Sinn wäre, wenn Sie alle Produkt- und Sprachvarianten in einer Bedienungsanleitung abbilden. Erfolgreiches Variantenmanagement könnte bedeuten, dass Sie für jede Produktvariante exakt passende Handbücher erstellen.

Die Handbuch Experten bieten dazu – je nach Tool – Automatisierungsmöglichkeiten, die für jeden Kunden die exakt passende Dokumentation auf Knopfdruck erstellen.

Kosten der Bedienungsanleitung

Die Kosten hängen von vielen Faktoren ab und müssen mit dem Nutzen, den das richtige Tool bringt, abgewogen werden. Üblicherweise lassen sich die Kosten wie folgt steigern:

  • Editoren mit eingeschränkter Funktionalität (die meist in den Unternehmen bereits vorhanden sind)
  • Funktions-mächtige Editoren wie FrameMaker oder Interleaf/QuickSilver teilweise fast vergleichbar zu einfachen Redaktionssystemen
  • Hochkomplexe Redaktionssysteme, die redaktionell keine Wünsche mehr offenlassen (außer, dass die Arbeit noch erledigt werden muss).

Allerdings sind die Kosten für das Tool nicht das einzige, das betrachtet werden muss. Sondern auch die Arbeitszeit für die Einarbeitung und Erstellung der ersten Version der Bedienungsanleitung oder das Zeitersparnis, sobald sich alles "eingeschwungen" hat, schlagen hier zu Buche.

Welchen Schwerpunkt jedes Unternehmen hier setzt, kommt auf die eigenen Maßstäbe an.

Vorteile / Nachteile Redaktionssystem

Wenn Sie Redaktionssysteme und Editoren vergleichen, werden Sie schnell feststellen: Die Anzahl der am Markt vorhandenen Tools ist gigantisch und wächst stetig.

Vorteile von Editoren: Sie sind meist bereits verfügbar oder sehr kostengünstig.

Nachteile von Editoren: Sie erfordern sehr sorgfältiges Arbeiten und notwendige Vorab-Arbeiten, die im Arbeitsprozess immer wieder geprüft werden müssen.

Vorteile von Redaktionssystemen: Sie ermöglichen sehr systematisches Arbeiten und ein einheitliches Dokumentations-Erscheinungsbild ohne größeren Aufwand. Weitere Versionen der Handbücher lassen sich relativ schnell erstellen.

Nachteile von Redaktionssystemen: der Preis und der Aufwand, bis das erste fertige Handbuch erstellt ist.

Für einen konkreten Vergleich ist es jedoch relevant, welche Kriterien für den jeweiligen Einsatzzweck wichtig sind, welche die Arbeit zwar angenehmer machen würden ohne zwingend notwendig zu sein und welche nicht relevant sind.

Messbarkeit / KPIs

Es gibt für die Technische Dokumentation, wie für jeden unternehmerischen Bereich, Kennzahlen. Es ist aber nicht gerade üblich, dass sie ermittelt und dann kontinuierlich betrachtet werden, besonders wenn die redaktionelle Arbeit im eigenen Unternehmen erfolgt. Am ehesten ermittelt und herangezogen wird das ROI (return on investment) eines Redaktionssystems.

Doch es gibt noch viel mehr Kennzahlen, die die Technische Dokumentation messbar machen. Dabei lassen sich Kennzahlen unterscheiden, die zum Aufwand für die Erstellung oder Pflege Aufschluss geben, sowie die Qualität der Anleitung beurteilen helfen oder auch den Nutzen des Handbuchs für Ihre Kunden ins Licht rücken.

Wichtig ist am Ende für die Technische Dokumentation, wie gezielt Ihre Kunden die gewünschte Information finden können – oder ob sie doch lieber direkt wieder bei der Hotline anrufen oder im Chat nachfragen.

Sollten Ihre Kunden lieber nachfragen statt nachzuschauen, hat sich weder der Aufwand tatsächlich gelohnt, noch ist die Qualitätsfeststellung hilfreich gewesen (falls sie stattgefunden hat). Wenn die Bedienungsanleitung nur halbherzig erstellt wurde, weil es gesetzlich vorgeschrieben ist, entstehen Mehrkosten, die weder Ihrem Unternehmen noch Ihren Kunden nutzen.

Trotzdem ist es aus unternehmerischer Sicht wichtig, sich mit dem Erstellungs-Prozess der Betriebsanleitung und dessen Kosten auseinanderzusetzen. Ebenso relevant sollte sein, ob die internen Kosten gerechtfertigt sind und was Sie ggf. dagegen tun können.

Die Handbuch Experten haben Kriterien entwickelt, anhand derer sie den Aufwand und die Qualität der Dokumente prüfen können.

Dabei spielen Checklisten für die Qualität und Aufwandsabschätzungen eine wichtige Rolle, genauso wie das Herausfinden von Aufgaben, die die Technische Redaktion vielleicht mit erledigt, die an sich aber gar nichts mit der Bedienungsanleitung zu tun haben.

Übersetzung / Mehrsprachigkeit

Die Übersetzung der Bedienungsanleitung ist durch die Globalisierung ein Thema, das nicht nur große Unternehmen betrifft. Viele kleinere Unternehmen verkaufen Ihre Produkte inzwischen über Ländergrenzen hinweg.

Es gibt sogar einige gesetzliche Vorgaben zur Sprache der Anleitung.

Kein Wunder also, dass die Übersetzung technischer Texte auch vor der Technischen Dokumentation nicht Halt macht.

Ihre vorhandene Anleitung lassen wir mit muttersprachlichen Übersetzern in die gewünschten Sprachen transferieren. Selbstverständlich gilt auch hier die gleiche Sorgfalt wie bei der Erstellung: Es wird strikt nach dem 4-Augen-Prinzip gearbeitet.

Und auf Wunsch wird jede übersetzte Bedienungsanleitung optisch bis ins kleinste Detail geprüft und an das Original angepasst. So steht auf jeder Seite in jeder Sprache der gleiche Inhalt.

Das hilft vor allem Ihrem Service und Ihren Kunden. Denn der Service kann in seiner gewohnten Sprache die relevanten Inhalte der Betriebsanleitung finden und Ihr Kunde kann sie in seiner Sprache nachschauen. So sprechen beide vom Gleichen, selbst wenn sie miteinander in Fremdsprachen kommunizieren.

Ihr Handbuch soll schnell und unkompliziert in vielen Sprachen verfügbar sein?

Ihr Handbuch professionell übersetzen lassen

Variantenmanagement durch Automatisierung

Sollten Sie einige Produktkategorien haben, die wiederum verschiedene Varianten beinhalten, sollten Sie auch bei Ihren Handbüchern auf das Variantenmanagement achten.

Die Handbuch Experten haben schon immer gerne Arbeitsprozesse gezielt optimiert und sich wiederholende Arbeiten auf Möglichkeiten zur Automatisierung geprüft. Deshalb gibt es bei uns mit unserem System AFASY (Absolutely FAst and eaSY) die Möglichkeit, Ihre Betriebsanleitung auf Knopfdruck zu erstellen.

Dazu brauchen Sie eine gute Vorarbeit, mit der Sie dann exakt die variantenspezifische Anleitung für jedes einzelne Produkt generieren können, ohne dass es Sie Zeit kostet.

Durch eine Analyse Ihrer Produktkategorien und Produktvarianten lassen sich die Inhalte Ihrer Bedienungsanleitung mit Metadaten so auszeichnen, dass AFASY anhand Ihrer Bestelldaten im Bestellsystem bereits die passende Bedienungsanleitung erstellt.

Lassen Sie individuelle Produktvarianten automatisiert dokumentieren.

Lassen Sie Ihren Arbeitsprozess optimieren

Was Ihre Kunden davon haben

Unabhängig davon, wie viele Bedienungsanleitungen, Übersetzungen und Varianten Sie erstellen, sollten Sie sich die Arbeit mit dem Handbuch nicht "umsonst" gemacht haben.

Der Kundennutzen steht bei Ihrem Produkt im Vordergrund. Auch die Betriebsanleitung kann Ihren Kunden nutzen. Wieso also nicht auch die gleiche Sorgfalt, die Sie bei der Entwicklung Ihres Produkts walten lassen, auf die Erstellung des Handbuchs legen?

Indem Sie die relevanten Informationen für Ihren Kunden bereitstellen, kann eine ansprechende Bedienungsanleitung Ihr Produkt ins rechte Licht rücken und auch Ihr Haftungsrisiko senken.

Sie kann Ihren Kunden die Produktfunktionen näherbringen – aber auch zeigen, wie Ihr Produkt schonend verwendet wird, so dass Ihr Kunde lange Freude daran hat.

Wenn die Anleitung noch ansprechend und professionell gestaltet ist und hilft, die gewünschten Informationen schnell zu finden, kann sie sogar intern Ressourcen schonen.

Ihr Handbuch soll übersichtlich, ansprechend und hochwertig werden, wie Ihr Produkt es von Beginn an war?

Dann lassen Sie uns Ihre Bedienungsanleitung professionell überarbeiten, damit Ihr Kunde damit glücklich wird.

Angebot noch heute anfordern
oder unter +49 9126 2611-12 beraten lassen