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

Im Folgenden beschäftigen wir uns mit der Produktbeschreibung für den Benutzer. Sie erhalten einen Überblick über alles, was die Handbuch Erstellung betrifft. So können Sie selbst wählen, ob Sie ein Handbuch vom Experten erstellen lassen wollen oder ob Sie auf der Suche nach einer Beschreibung sind, wie Sie selbst am besten ein Handbuch erstellen können.

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. Technische Dokumentation umfasst viele Informationen, die Hersteller/Importeure/Händler von Produkten bereithalten müssen. Wichtig für Ihre Kunden bzw. die Produktanwender und Benutzer Ihrer Produkte ist die Anleitung, die entweder in Montageanleitung und Gebrauchsanleitung oder als gesamtes Handbuch Ihr Produkt für den Nutzer bzw. Anwender beschreibt.

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.

Interne und externe Dokumentation

Es gibt bei der Technischen Dokumentation die Unterscheidung zwischen "interner Dokumentation", das umfasst die Dokumente, die üblicherweise beim Produkthersteller verbleiben, und "externer Dokumentation", das sind die Dokumente, die z. B. an den Anwender oder Benutzer gehen – aber auch an Interessenten.

Beispiele für interne und externe Dokumentation wären:

Interne Dokumentation
Recherche nach zutreffenden Richtlinien, Normen, etc., Risikoabschätzung, Entwicklungszeichnungen, Lasten- und Pflichtenhefte, etc.
Externe Dokumentation
Bedienungsanleitung, Kataloge, Werbebroschüren, Flyer, etc.

Produktwissen dokumentieren

Im Sinne des Dokumentierens bedeutet Dokumentation, dass Sie als Produkthersteller/-importeur/-händler all jene Dokumente, Belege, Materialien, etc. erstellen oder zusammenstellen, die Ihr Produkt beschreiben, und dauerhaft (es gibt gesetzliche Vorgaben, wie lange) verfügbar machen, damit diese Beschreibungen verwendet werden können.

Interne Dokumentation

Im Rahmen der Produktsicherheit sind Sie als der verantwortliche Bereitsteller von Produkten dazu gesetzlich angehalten, nur sichere Produkte in Verkehr zu bringen. Wenn Sie mehr zu Ihren Pflichten wissen möchten, bietet Ihnen unsere Seite zur rechtssicheren Dokumentation weitere Informationen und die passenden Dienstleistungen dazu.

Auch hat die interne Dokumentation häufig Auswirkungen auf die externe Dokumentation. So werden häufig Normen angewendet, um die Produkte nach dem Stand der Technik systematisch zu gestalten. Oder es wird festgehalten, wie bestimmte gesetzliche Vorgaben erfüllt werden. Diese Normen und Vorgaben haben oftmals auch Anforderungen an die Informationen, die dem Benutzer des Produkts bereitgestellt werden müssen.

Externe Dokumentation

Die externe Dokumentation, die auch das Handbuch, die Installationsanweisung/Montageanleitung, die Bedienungsanleitung, die Wartungsanleitung und weitere Produkt-Lebenszyklus-nahe Fälle beschreibt, muss/sollte die gleichen Informationen wie Werbeblätter, Werbebroschüren, Kataloge, etc. bereithalten. Es handelt sich bei allen verschiedenen technischen Beschreibungen, die an Kunden und Interessenten gerichtet sind, um das gleiche Produkt. Sorgen Sie stets dafür, dass die Informationen in allen Medien und Kanälen gleich sind. Das geht bis hin zu Produkt-FAQs auf Ihrer Website oder den Anweisungen für die Service-Hotline. Und ziehen Sie bei Bedarf die Informationen in allen Medien auf den gleichen Stand, z. B. wenn es Änderungen gibt – entweder am Produkt oder der Art und Weise, wie das Produkt im Detail beschrieben wird.

Systematik mit Konzept und Redaktionsleitfaden

Das Konzept behandelt, welche Anforderungen die verschiedenen Stakeholder an Ihre Benutzerinformation haben und wie die Benutzerinformation diesen gerecht wird. Im Redaktionshandbuch erfahren die Redakteure, wie sie es umsetzen.

Konzept

Üblicherweise findet sich in einem Konzept alles, das wichtig ist für die Erstellung der Dokumentation. 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.

Dieses vermittelt übersichtlich und kompakt, wie eine Dokumentation erstellt wird - wie mit Input umgegangen wird und was für den Output relevante Rahmenbedingungen sind.

In einem Konzept halten die Handbuch Experten 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, Zusatzteilen, 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 werden systematisch die wichtigen Informationen für den Benutzer erfasst und so dargestellt und formuliert, dass dem Nutzer sofort klar ist, um welche Art von Information es sich handelt.

Redaktionsleitfaden

Idealerweise wird in einem Redaktionshandbuch oder Redaktionsleitfaden dann auch noch konkret erklärt, worauf es bei der Erstellung der Betriebsanleitung unter anderem ankommt:

  • 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

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

Vorgaben

Es gibt viele Arten von Vorgaben, 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. Zum einen, dass ggf. eine Anleitung zum Produkt dazu gehört. Es existieren auch Anforderungen zur Sprache des Handbuchs, wie z. B. bei CE-kennzeichnungspflichtigen Produkten die Vorgabe, dass die Anleitung in der Landessprache mitgeliefert werden muss.

Das bedeutet, in Deutschland braucht Ihr Produkt eine deutsche Bedienungsanleitung, sobald es ein CE-Kennzeichen trägt, da die Amtssprache in Deutschland deutsch ist. In anderen EU-Mitgliedsstaaten müssen dann entsprechend die dort geltenden Amtssprachen zur Verfügung gestellt werden.

Normen für Technische Dokumentation

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

Es gibt einerseits die ISO/IEC/IEEE 82079 (ehemals DIN EN 62079) als Norm zum Erstellen von Gebrauchsanweisungen, in der neuen Form "Erstellen von Nutzungsinformationen (Gebrauchsanleitungen) für Produkte - Teil 1: Grundsätze und allgemeine Anforderungen" genannt, die mehr über die Fähigkeiten und Aufgaben eines ausgebildeten Technischen Redakteurs für die Bedienungsanleitung und seiner Arbeitsweise im Allgemeinen aussagt.

Andererseits 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" (EN ISO 20607). Diese Norm will auch nicht-ausgebildeten Redakteuren einen Leitfaden geben, wie man bei der Erstellung der Betriebsanleitung für Maschinen vorgehen soll, um die Sicherheit der Maschine 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 empfohlen, was für die Benutzerinformation zu beachten ist.

Sprache der Betriebsanleitung

Sofern es keine gesetzlichen Vorgaben zur Sprache gibt, können Sie die Sprache Ihrer Anleitung frei wählen. Aus Sicht der Produkthaftung sollte jedoch die Landessprache zumindest in Erwägung gezogen und 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 technisch beherrscht.

Gedruckte oder digitale Anleitung?

Es kann aber auch sein, dass Sie auch an die Form Ihrer Anleitungen spezifische Anforderungen stellen. Das kann beispielsweise die Form betreffen, in der Sie Ihr Handbuch zur Verfügung stellen (Papierform bzw. print, online oder digital).

Für oder gegen Papier mag für den Hersteller insbesondere eine Kostenfrage sein. Bisher geht die Rechtsprechung häufig davon aus, dass der Nutzer Papier benötigt. Aber es kommen immer wieder Fälle vor, die auch eine elektronisch zur Verfügung gestellte Bedienungsanleitung erlauben. Für die Zukunft ist vorhersehbar, dass das Papier als einzig wahres Medium abdanken wird – nur, wann genau und durch welchen Ersatz wird sich erst noch zeigen. Generell sind regulatorische Unterschiede abhängig davon, um welche Produkte und Branchen es sich handelt: Maschinen - Medizinprodukte - Software oder Endverbraucher-Produkte.

Es gab einen Fall, in dem ein Online-Shop keine Papier-Anleitung liefern musste, sondern eine per E-Mail versendete PDF-Anleitung ausreichte, da der gesamte Bestellvorgang online (Bestellung, Auftragsbestätigung, Rechnung, etc.) abgewickelt wurde. Allerdings war für die Produktgruppe auch keine gesetzliche Vorgabe vorhanden, die eine Papieranleitung gefordert hätte. Es muss also vorab für jeden Fall geprüft werden, wer beim Wettbewerb print vs. online am Ende gewinnt.

Möglichst rein grafische Anleitung

Vielleicht zählen Sie zu den Kunden, die an die Form Ihrer Anleitungen spezielle grafische Anforderungen stellen. Das kann beispielsweise die Art der Darstellung (Text-lastig oder Grafik-lastig, möglichst nur Text oder nur Grafiken) betreffen.

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 Versionen, wie gut das beim Nutzer angekommen ist und noch immer ankommt. Auch wenn diese Anleitungen vielfach professionell gemacht sind, sind bei komplexeren Produkten mit größerem Verletzungspotential 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.

Es ist also nicht nur eine Frage der Übersetzungskosten, die sich durch grafische Anleitungen 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 und es sollten auf jeden Fall Tests durchgeführt werden, ob die Grafiken auch richtig verstanden werden. Die Möglichkeit der Missinterpretation ist bei Bildern auf einem ganz anderen Niveau im Vergleich zu textlichen Anleitungen (die teilweise 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 Benutzer Ihres Produkts hilfreich ist. Damit Sie die richtigen Parameter auswählen, ist eine Einschätzung oder noch besser eine Analyse Ihrer Zielgruppe unerlässlich.

Üblicherweise wird die Zielgruppe nicht gerade extatisch 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 sinnvoll, sich von dem klassischen "Fachpersonal", das beispielsweise im Maschinenbau gerne genommen wird, zu verabschieden und genauer zu überlegen, wer denn mit Ihrem Produkt umgehen darf oder soll bzw. auch nicht sollte.

Sie können auch auf Nummer sicher gehen und die Verständlichkeit und Vollständigkeit ihrer Anleitung 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).

Wenn Sie die Redakteure frühzeitig in den Informationsfluss zur Produktentstehung einbinden, können diese sowohl bei der Recherche mitarbeiten und i. d. R. auch Hinweise, z. B. zur Usability, geben und damit die Entwickler entlasten.

Aufbau

Um Ihr Handbuch zu erstellen, müssen Sie den Aufbau Ihrer Bedienungsanleitung festlegen. Das sollte immer mit der Produktstruktur und den Produktvarianten einher gehen. Erst wenn das geschehen ist, können Sie Inhalte füllen. Normativ ist z. B. empfohlen, den Produktlebenszyklus zu betrachten, den der Anwender mit dem Produkt durchläuft.

Als grobe Richtlinie kann dabei für den Dokumentations-Aufbau folgendes dienen:

  • Inbetriebnahme mit Montage/Installation,
  • Benutzung/Betrieb/Bedienung,
  • Instandhaltung/Wartung,
  • Fehlersuche,
  • Außerbetriebnahme mit Demontage und Entsorgung,
  • sicherheitsrelevante Informationen 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, bevor das jeweilige Exemplar für das bestellte Produkt zur Verfügung gestellt wird. 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 steht, geht es daran, 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 evtl. zusammengefasst.

Häufig fallen beim Schreiben auch noch Punkte auf, die mit der Konstruktion/Entwicklung geklärt werden müssen, weil es Ungereimtheiten zwischen Produkt und vorhandenen ersten Beschreibungen gibt – oder Sachen nur kompliziert vom Nutzer gelöst werden können, die sich mit kleinen Produktanpassungen optimieren lassen. Gerade bei Software geht so etwas oft reibungslos. Hin und wieder wird der Redakteur auch als beta-Tester genutzt, bewusst oder ohne, dass er das weiß. Es ist also eine enge Abstimmung zwischen den Entwicklern und Konstrukteuren des Produkts und dem Redakteur notwendig, der als eine Art erster Produktnutzer durchaus auch mal kritisch Funktionsweisen und Vorgänge hinterfragt.

Sprache/Formulierungen

Relevant für die Texte ist es dabei das Prinzip "keep it simple" durchzuziehen. Einfache Sätze, wenig verschachtelt, immer gleich aufgebaut ist dabei die Maxime, die es anzustreben gilt. Ganz entgegen dem, was man für andere Lektüre bräuchte und in der Schule oftmals gepredigt bekommen hat.

Wichtig ist auch, dass eine einheitliche Terminologie verwendet wird und gleiche Vorgänge immer gleich betitelt 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

Wer sich außerdem schon mit dem Genre der Technischen Dokumentation befasst hat, weiß, dass das Thema Sicherheit immer heiß ist. Heiß begehrt bei denjenigen, die die Anleitung mit Warnungen pflastern wollen, heiß gehasst bei denjenigen, die vor lauter Warnungen nicht mehr finden, was sie eigentlich tun sollen.

Unerlässlich ist, dass die relevanten Rest-Risiken in der Anleitung dargestellt werden – und das in einem Maß, das die Augen des Lesers nicht überfordert, ihm aber die Dringlichkeit und Notwendigkeit zeigt. Hier die "wichtigen" Informationen vorzuenthalten wäre fatal – genauso, wie weniger relevante oder weniger gefährliche Aspekte zu deutlich hervorzuheben, um von den wichtigen Hinweisen abzulenken. Ein gesundes Maß ist hierbei das wichtigste – und auch, dass die Warnhinweise für die Zielgruppe relevant und verständlich sind. 

Bei den Sicherheitshinweisen, die ein erhebliches Maß an Kenntnissen erfordern, da helfen wir Ihnen gerne weiter, bewerten die von Ihnen erstellten oder erstellen diese auch gerne für Sie.

Technische Grafiken

Ebenso für das Verständnis relevant ist es üblicherweise, nicht ausschließlich Texte zu produzieren, sondern geeignete Grafiken mit relevantem Inhalt zur Verfügung zu stellen.

Das kann bedeuten, dass wir für Sie technische Zeichnungen erstellen, um Ihr Produkt geeignet zu umschreiben, oder Piktogramme erstellen, weil es möglicherweise relevante Informationen zu Ihrem Produkt gibt, die nicht genormt sind. Es kann aber auch heißen, dass wir Fotos überarbeiten und die notwendigen Details entsprechend kennzeichnen. Das ist abhängig vom Produkt, vom Komplexitätsgrad und auch von Ihren Corporate Design Regeln.

Gelungene Mischung Grafik/Text

Am Ende ist es wichtig, dass der Anwender weiß, was er wann und wie mit dem Produkt tun darf und soll – oder eben nicht. Hilfreich ist es üblicherweise, wenn eine Mischung aus Text und Grafik genutzt wird, um das Wissen für die effiziente und sichere Produktnutzung zu vermitteln. Hierfür spielt auch die Zahl der Varianten und Sprachanzahl der geplanten Übersetzungen eine Rolle.

Lektorat/Korrektorat

Lektorat

In unserem Haus gibt es eine goldene Regel: Jede geschriebene Anleitung wird mindestens im 4-Augen-Prinzip geprüft. Das hat nicht nur mit Rechtschreibung und Grammatik zu tun, sondern auch mit Nachvollziehbarkeit einzelner Schritte und wird idealerweise durch einen erfahrenen Technischen Redakteur geleistet. So können Sie sicher sein, dass Ihre Bedienungsanleitung optimal erstellt wurde. Gleichzeitig sollte eine das Produkt umfassend kennende Person das Handbuch fachlich prüfen. Ist Schritt A vor Schritt B oder sollte das doch umgekehrt durchgeführt werden?

Korrektorat

Sollten die fachliche Richtigkeit sowie die Formulierungsmuster bereits geprüft und optimiert sein und Sie stehen kurz vor dem Druck, könnte Ihnen ein Korrektorat helfen, das nochmal auf Rechtschreibung, Grammatik und Orthografie prüft. Hier werden die einzelnen Sätze an sich nicht mehr angepasst.

Qualität feststellen, erhöhen, halten

Ihre Produkte sind hochwertig und haben tolle Funktionen. Eine Qualität, die Sie auch als Standard in der Dokumentation festsetzen möchten. Doch wird in vielen Unternehmen die Qualität der Anleitung nicht festgestellt. 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. Die Handbuch Experten bieten hierzu ihren Doku-Check [Link] an. Alternativ erstellen Sie selbst Checklisten, welche Kriterien für die Qualität Ihrer Dokumente relevant ist – und welche weiteren Anforderungen ggf. von außen von Ihrer Bedienungsanleitung einzuhalten sind. Und prüfen dann neutral (idealerweise nicht von der Person, die die Dokumente erstellt hat), ob diese Kriterien und Anforderungen erfüllt wurden.

Die Handbuch Experten haben im Doku-Check vorhandene Dokumente geprüft und für den Laien kaum ersichtliche Mängel aufgrund ihrer systematischen Vorgehensweise und Erfahrungen aus über 6.500 Projekten aufdecken können. Häufig hat das dazu geführt, dass die komplette Dokumentation grundlegend überarbeitet wurde, um die Qualität zu erhöhen. Wenn das im Haus des Kunden geschieht, ist ein wiederholter Check, ob die Änderungen alle konsequent umgesetzt wurden, eine gute Möglichkeit – auch nach einiger Zeit – zu prüfen, ob die höhere Qualität nun gehalten wurde.

Verwendung für die erstellte Doku

Nachdem das qualitativ ansprechende Exemplar erstellt wurde und einem Revisionsprozess unterlegen hat, stellt sich häufig die Frage: Bedienungsanleitung drucken oder nur online zur Verfügung stellen? Idealerweise wurde diese Frage im Rahmen des Konzepts bereits beantwortet und die Dokumente sind darauf ausgelegt. Wenn nicht, kann es einige Nacharbeiten erfordern, z. B. wenn neben einem klassischen Handbuch gleichzeitig eine Online-Hilfe generiert werden soll und das nicht von Vornherein geplant war.

Sobald die entsprechenden Medien der Bedienungsanleitung erstellt sind, können diese nun (endlich) an den Produktnutzer verteilt werden.

Tools: welche Software gibt es für Bedienungsanleitungen?

Software für Technische Dokumentation gibt es viele. Und genauso, wie es viele Tools gibt, gibt es verschiedene 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 Anleitung wichtig und welche gibt es ggf. noch, die eine Entscheidung in die ein oder andere Richtung beeinflussen können.

Redaktionssystem/CMS

Dabei lässt sich häufig schnell eine erste Tendenz erkennen: ausgebildete Redakteure sind es gewohnt, systematisch zu arbeiten und bevorzugen 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 Bildbearbeitung bis hin zum Varianten- und Sprachmanagement und dem Revisionsprozess.

Dabei lassen sich viele Vorteile erkennen, die sich vor allem dann ausspielen lassen, wenn das Unternehmen sehr viele ProdukteVariantenSprachen, Bilder, etc. anbietet. Üblicherweise gibt es dann auch mindestens einen Technischen Redakteur, der die Arbeiten betreut und eng mit Konstruktion und Entwicklung zusammenarbeitet.

Editoren

Kleinere Unternehmen, die keine eigenen Redakteure beschäftigen, arbeiten hingegen häufig mit Software für die Betriebsanleitung, die bereits im Unternehmen vorhanden ist. Diese sind üblicherweise klassische "Editoren", (häufig Microsoft Word (c)), die bei Kunden weit verbreitet sind.

Allerdings muss mit einem Editor konsequent und mit Fachwissen gearbeitet werden, um am Ende eine qualitativ hochwertige und systematische Anleitung zu erstellen, die dem Unternehmenserscheinungsbild gerecht wird. Das kann bedeuten, dass im Unternehmen ein Produkt als Vorlage erstellt wird, anhand dessen man weitere Produkte und Varianten auflegen kann. Hier bieten die Handbuch Experten durch ihre häufige Arbeit für kleinere und mittlere Unternehmen systematische Vorgehensweisen und Schulungen [Link] an, die die Mitarbeiter Ihres Unternehmens dazu befähigen, ihre Dokumente sauber zu pflegen.

Variantenmanagement

Letztendlich entscheidet häufig auch die Vielzahl an Produktvarianten oder Sprachvarianten darüber, welches Tool sich am besten für Ihr Handbuch eignet. Und wie sehr sich die Varianten voneinander unterscheiden.

Ein nicht vorhandenes Variantenmanagement im einfachsten Sinn wäre, wenn Sie alle Produkt- und Sprachvarianten in einer Anleitung abbilden. Erfolgreiches Variantenmanagement könnte bedeuten, dass Sie für jede Produktvariante exakt passende Handbücher mitgeben können. Die Handbuch Experten bieten dazu – je nach Tool – Automatisierungsmöglichkeiten, die für jeden Kunden die exakt passende Dokumentation auf Knopfdruck erstellen lassen.

Kosten

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 vergleichbar zu einfachen Redaktionssystemen
  • hochkomplexe Redaktionssysteme, die redaktionell keine Wünsche mehr offen lassen, außer dass die Arbeit noch erledigt werden muss.

Allerdings sind die Kosten nicht das einzige, das betrachtet werden muss. Sondern auch die Arbeitszeit für die Einarbeitung und Erstellung der ersten Version können relevant sein – oder die Zeitersparnis, sobald sich alles "eingeschwungen" hat. Hier kommt es auf die unternehmensinternen Maßstäbe an.

Vorteile/Nachteile Redaktionssystem

Wenn Sie Redaktionssysteme und Editoren vergleichen, werden Sie schnell feststellen: die Anzahl an 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: sehr sorgfältiges Arbeiten und notwendige Vorab-Arbeiten, die durchgeführt werden müssen und im Arbeitsprozess immer wieder geprüft werden müssen.

Vorteil von Redaktionssystemen: sie ermöglichen sehr systematische Arbeiten und ein einheitliches Dokumentations-Erscheinungsbild ohne äußerlichen Aufwand und schnelle weitere Versionen.

Nachteile von Redaktionssytemen: der Preis und der Aufwand, bis das erste fertige Handbuch zu erhalten ist.

Für einen konkreten Vergleich ist es jedoch relevant zu wissen, 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, wie in jedem unternehmerischen Bereich Kennzahlen, also auch für die Technische Dokumentation. Häufig ist es aber unüblich, dass sie ermittelt und dann kontinuierlich betrachtet werden. Am ehesten ermittelt und herangezogen wird ein 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 bzgl. des Aufwands bei der Erstellung oder der Pflege Aufschluss geben, sowie die Qualität der Anleitung beurteilen helfen oder auch den Nutzen des Handbuchs für den Anwender ins Licht rückt.

Wichtig ist am Ende für die Technische Dokumentation, wie gezielt der Nutzer die gewünschte Information finden kann – oder ob er doch lieber direkt wieder bei der Hotline anruft oder im Chat nachfragt, wie er Probleme mit dem Produkt lösen kann. Sollte der Nutzer lieber nachfragen statt nachschauen, hat sich weder der Aufwand tatsächlich rentiert, noch ist die Qualitätsfeststellung hilfreich gewesen (falls sie stattgefunden hat). Wenn Sie Ihre Bedienungsanleitung dem Produkt nur halbherzig aus Pflichtbewusstsein oder weil es gesetzlich vorgeschrieben ist beifügen, haben Sie Kosten, aber weder Ihr Unternehmen, noch Ihr Kunde einen Nutzen daraus.

Trotzdem ist es aus unternehmerischer Sicht wichtig, sich mit dem Erstellungs-Prozess der Betriebsanleitung auseinanderzusetzen – und welche Kosten er verursacht. Und ob die internen Kosten gerechtfertigt sind, oder was die Personen, die mit der Erstellung der Anleitungen betraut sind, überhaupt das, was sie tun sollen, in der gewünschten Qualität tun (können).

Die Handbuch Experten haben dazu 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.

Übersetzung/Mehrsprachigkeit

Die Übersetzung der Bedienungsanleitung ist durch die Globalisierung ein typisches Thema, das nicht nur große Unternehmen betrifft. Viele kleinere Unternehmen verkaufen Ihre Produkte inzwischen über Ländergrenzen hinweg. Sogar einige gesetzliche Vorgaben gibt es zum Thema Sprache der Anleitung, kein Wunder also, dass die Übersetzung technischer Texte auch vor der Technischen Dokumentation nicht Halt macht.

Wir vertreten die Auffassung, dass wir gute Benutzerinformationen nur in unserer Muttersprache verfassen können. Das bedeutet im Regelfall deutsche Anleitungen. Diese lassen wir dann mit muttersprachlichen Übersetzern in die gewünschten Sprachen transferieren. Selbstverständlich gilt auch hier die gleiche Sorgfalt wie bei der Erstellung: es wird 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, um gleiche Inhalte in jeder Sprache schnell zu finden, selbst wenn man in der Sprache selbst nicht erfahren ist.

Variantenmanagement durch Automatisierung der Technischen Dokumentation

Sollten Sie einige Produktkategorien haben, die wiederum verschiedene Varianten beinhalten, sollten Sie auch für Ihre Handbücher auf das Variantenmanagement achten. Die Handbuch Experten hatten schon immer Interesse daran, Arbeitsprozesse gezielt zu optimieren und sich wiederholende Arbeiten zu automatisieren. Deshalb gibt es AFASY – die Möglichkeit, Ihre Betriebsanleitung auf Knopfdruck zu erstellen.

Dazu brauchen Sie zwar eine gute Vorarbeit, können dann aber exakt die variantenspezifische Anleitung für jedes einzelne Produkt, das Ihr Kunde konfigurieren und bestellen kann, generieren, 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 richtige Anleitung erstellt.

Laden Sie sich unser Produktblatt zu AFASY – Ihre automatische Anleitung herunter.

Oder lassen Sie uns direkt über Ihre Produkte und das optimale Variantenmanagement Ihrer Anleitungen sprechen.

Kundennutzen

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

Die Betriebsanleitung kann Ihrem Kunden nutzen. Und der Kundennutzen steht bei Ihrem Produkt vermutlich bereits im Vordergrund. Wieso also nicht auch die gleiche Sorgfalt, die Sie bei der Entwicklung Ihres Produkts walten lassen, auf die begleitenden Dokumente legen?

Indem Sie die relevanten Informationen für Ihren Kunden bereitstellen, kann eine ansprechende Betriebsanleitung Ihr Produkt ins rechte Licht rücken und auch Ihr Haftungsrisiko senken. Sie kann die Funktionen näher bringen, die Ihr Kunde nicht auf den ersten Blick sieht – aber auch zeigen, wie Ihr Produkt schonend verwendet wird, so dass Ihr Kunde lange Freude daran hat. Wenn die Anleitung noch hübsch aussieht und hilft, die gewünschten Informationen schnell zu finden, kann sie sogar intern Ressourcen schonen, statt für die Erstellung nur zu benötigen.