+49 3677 8782-0 info@highdoc.de

Die inhaltlichen Anforderungen an eine Betriebsanleitung sind unter anderem in der Norm DIN EN 82079-1 geregelt. Im Speziellen sind hier grundlegende Regeln und Prinzipien für eine vollständige und benutzerfreundliche Dokumentation definiert. Diese Regeln gelten jedoch nicht nur für reine Betriebsanleitungen, sondern können auf alle Anleitungen im Bereich der Technischen Dokumentation angewendet werden. Die Einhaltung der Normen und Richtlinien ist notwendig für eine erfolgreiche Konformitätsbewertung und die damit verbundene Vergabe der CE-Kennzeichnung.

Weitere Normen und Richtlinien, die bei der Erstellung von Betriebsanleitungen eine Rolle spielen, sind abhängig von der Art des Produkts. Daher müssen die normativen Anforderungen bei jeder Anleitung neu bestimmt werden. Beispiele für zu beachtende Richtlinien und Normen sind:

  • Maschinenrichtlinie
  • Niederspannungsrichtlinie
  • IEC/IEEE 82079-1 (Erstellen von Nutzerinformationen)
  • ISO 17644 (Herstellerangaben für Medizinprodukten)
  • ISO 26511 (Software und System-Engineering)

Im Folgenden werden nun wichtige Prinzipien für das Erstellen von Betriebsanleitungen beschrieben:

 

Die Zielgruppen berücksichtigen

Beim Erstellen einer Anleitung jeglicher Art ist es sehr wichtig, die Zielgruppe und deren Eigenschaften, Gewohnheiten und Erwartungen zu berücksichtigen. Hierfür kann eine Zielgruppenanalyse durchgeführt werden, bei der folgende Fragen geklärt werden:

  • Welche Altersgruppe wird angesprochen? Muss die Anleitung besonders kind- oder seniorengerecht gestaltet und geschrieben werden?
  • Müssen kulturelle oder soziale Besonderheiten beachtet werden?
  • Sind bestimmte Kenntnisse / Fähigkeiten vorhanden? Dem entsprechend können Fachbegriffe oder Handlungsschritte ohne zusätzliche Erklärung verwendet und beschrieben werden.
  • Wie ist das sprachliche Niveau? Eine Anleitung für Kinder / Jugendliche sollte anders geschrieben werden als eine Anleitung für Maschinenbau Ingenieure
  • Wird das Produkt unter besonderen Bedingungen genutzt und verwendet?
  • Wie wird die Zielgruppe diese Anleitung nutzen? Dient sie eher als Nachschlagewerk, Schulungsgrundlage, Handbuch oder Lerngrundlage?
  • Welche Erwartungen hat die Zielgruppe an die Anleitung?
  • Welche Erwartungen hat die Zielgruppe an das Produkt? Hieraus lässt sich das erwartungsgemäße Nutzerverhalten ableiten.

Auf Basis der Zielgruppenanalyse muss die Betriebsanleitung konzipiert werden. Dabei gilt es Folgendes zu beachten:

  • Eine zielgruppengerechte und einheitliche Terminologie-Liste anlegen und verwenden.
  • Einen sprachlichen Formulierungsstil festlegen, der möglichst einfache Satzkonstrukte verwendet. Hierbei helfen Styleguides und Technical Writing Sheets.
  • Grafiken und Illustrationen erstellen und im Dokument platzieren.
  • Eine übersichtliche Dokumentationsstruktur festlegen, bei der möglicherweise unterschiedliche Dokumente für unterschiedliche Zielgruppen erstellt werden. (Der Installateur bekommt eine andere Anleitung als der Bediener)
  • Eine inhaltliche Gliederung für das Dokument festlegen. Hier kann man sich zum Beispiel am Lebenszyklus der Maschine oder des Geräts orientieren.
  • Festlegen, wie die Qualität des Dokuments gesichert werden kann. Hierbei können Korrektur-Programme und Reviewprozesse angewendet werden.


Die Anleitung als einen Teil des Produkts betrachten

Die Anleitung(en) eines Produkts haben einen genauso hohen Stellenwert wie das Produkt selbst. Das heißt, wenn die Anleitung fehlt, ist das Produkt unvollständig und wenn die Anleitung fehlerhaft ist, ist auch das Produkt fehlerhaft. An diesem Ansatz wird deutlich, welche Wichtigkeit der Dokumentation zuzuschreiben ist.

Die Anleitung als Teil des Produkts dient dazu, dessen Bestimmungsgemäßen Gebrauch zu gewährleisten. Somit muss der Bestimmungsgemäße Gebrauch definiert und beschrieben werden. Darüber hinaus muss zusätzlich vor absehbarem Nicht-Bestimmungsgemäßen (zweckentfremdeten) Gebrauch gewarnt werden.

Um dem Nutzer die Installation, Bedienung, Wartung, Reinigung und sonstige Anwendungen möglichst leicht verständlich zu vermitteln, ist es sinnvoll, gerade bei komplizierteren Anlagen und Maschinen, das Dokument in mehrere Teildokumente zu gliedern. Dieser Ansatz wurde auch schon im Zusammenhang mit der zielgruppengerechten Dokumentation erwähnt.

Mehrere Dokumentationen sind ebenfalls vorteilhaft, wenn das Produkt in verschiedenen Produktvarianten existiert. Hier ist es nutzerfreundlicher, genau die passende Dokumentation zu liefern, anstatt einem großen Dokument, indem der Nutzer vorab die passende Variante identifizieren muss.

Zuletzt sei erwähnt, dass eine bleibende Verfügbarkeit sowie die Möglichkeit zur Aktualisierung gegeben sein muss. Dies lässt sich beispielsweise über eine Internetpräsenz realisieren, bei der die Nutzer immer die aktuellste Version der Dokumentation herunterladen können.

i

Die Anleitung in geeigneter Weise bereitstellen

Die erstellten Betriebsanleitungen müssen dem Nutzer so leicht wie möglich zur Verfügung gestellt werden. Hierbei ist auch wieder die Zielgruppe zu berücksichtigen, da ältere Menschen eventuell schwerer Zugang zu z.B. mobilen Endgeräten haben als Jüngere. Bei der Bereitstellung stehen dem Hersteller unterschiedliche Medien zur Verfügung:

Anbringung auf dem Produkt

Je nach Größe und Beschaffenheit des Produkts können Symbole, Hinweise, kurze Erklärungen und Handlungsanweisungen auf der Produktoberfläche angebracht werden. Dies bietet sich bei kleinen Handlungsschritten oder wichtigen Sicherheitshinweisen an. Wichtig zu beachten ist hierbei, dass diese Informationen nicht die eigentliche Betriebsanleitung ersetzen, sondern lediglich als Ergänzung zu sehen sind.

Anbringung auf der Verpackung

Da die Verpackung meistens direkt entsorgt wird, muss sich der Hersteller genau überlegen, welche Informationen er hier anbringen will. Im Regelfall bietet es sich hier an, Transport- und Lageranweisungen sowie Tipps zum Entfernen der Verpackung zu platzieren.

Dokumentation in Papierform

Dies ist bislang die geläufigste Bereitstellungsmethode. Der Nutzer findet alle wichtigen Informationen gebündelt in einem Dokument (oder gegebenenfalls in mehreren Teildokumenten). Wichtig hierbei ist es, gerade bei großen Dokumentationen, den Inhalt gut zu strukturieren und mit Inhaltsverzeichnis und Index leicht auffindbar zu machen.

Dokumentation auf einem Datenträger

Es ist weiterhin möglich, die Dokumentation beispielsweise als PDF auf einem Datenträger (CD, USB-Stick) zu liefern. Hierdurch kann der Nutzer mittels Suchfunktion leichter nach bestimmten Inhalten suchen. Weiterhin können zusätzliche Dokumentationsmethoden zur Anwendung kommen. Zum Beispiel können Informationen mithilfe von Videos, Utility-Filmen oder Animationen übermittelt werden. Durch diese Medien lassen sich beispielsweise schwierige Handlungs- oder Montageschritte leicht und anschaulich erklären. Voraussetzung für diese Art von Dokumentation ist jedoch, dass der Nutzer im Anwendungsbereich des Produkts die Möglichkeit hat, auf einen PC, Laptop oder Tablet zuzugreifen.

Dokumentation im Internet

Diese Art der Bereitstellung ähnelt der Dokumentation auf einem Datenträger. Der Nutzer hat Zugriff auf die Dokumentation über die Internetseite des Herstellers. Vorteilhaft ist hierbei, dass der Hersteller die Informationen immer aktuell halten kann und der Nutzer somit immer Zugriff auf den aktuellsten Dokumentationsstand hat. Wenn die Dokumentation nicht für jedermann einsehbar sein soll, lässt sich der Zugriff steuern, z. B. über Benutzerkonten oder einem Zugriffscode.


Die Qualität der Anleitung sicherstellen

Wie oben erwähnt, ist die Technische Dokumentation ein Teil des Produkts und gewährleistet den Sicheren und Bestimmungsgemäßen Gebrauch. Des Weiteren ist sie notwendig für eine erfolgreiche Konformitätsbewertung und die Vergabe der CE-Kennzeichnung. Aus diesem Grund ist es wichtig, ein Qualitätssicherungskonzept bei der Erstellung zu verfolgen. Ein solches Konzept kann unter anderem folgende Regeln enthalten:

  • Erstellen einer Terminologie-Liste und striktes Anwenden dieser Terminologie. Das heißt man einigt sich auf eine feste Menge von Fachbegriffen, die im gesamten Dokument einheitlich verwendet werden. So wird vermieden, dass die gleiche Sache im Dokument verschiedene Bezeichnung bekommt (z.B.: Sechskantschlüssel und Schraubenschlüssel)
  • Konsequente Stilregeln in den Texten sowie im Layout
  • Erstellen eines Grafikkonzepts (Software, Farben, Stil der Grafiken)
  • Inhalte strukturiert erfassen, verwalten und wiederverwendbar gestalten (Dafür ist es ratsam, mit einem Redaktionssystem oder geeigneter Software zu arbeiten)
  • Durchführen von redaktionellen Reviewprozessen (Kontrolle von Layout, Inhalt, Rechtschreibung, Stil, Grafiken, usw.)