Sie suchen auf: {{ keyword }}

Leitfaden für das Erstellen einer Betriebsanleitung

22.5.2022 Ferry Vermeulen Betriebsanleitungen

In diesem Artikel werde ich Ihnen erläutern wie wir für unsere Kunden rechtskonforme gut entworfene und benutzerfreundliche Betriebsanleitungen für Maschinen erstellen können.

Eine gute Kommunikation darüber, wie Maschinen sicher, effektiv und effizient installiert, betrieben und gewartet werden ist die Grundlage eines erfolgreichen Kundenerlebnisses. Indem Sie Endverbrauchern, wie Installateuren, Wartungspersonal oder Technikern, Bedienern oder Abbaupersonal, professionelle Anweisungen an die Hand geben, erhalten Sie zufriedenere Kunden und verbessern Sie ihre Haftung.

Möchten Sie wissen, wie Sie eine Betriebsanleitung erstellen können, mit der Sie jeden beeindrucken, wie diese Installations- und Betriebsanleitung für die HITMETAL?

Installations- und Betriebsanleitung

Wie diese Betriebsanleitung für die Firma Van der Waay?

Betriebsanleitung Maschine

Oder diese Betriebsanleitungen für Banderoliermaschinen?

Betriebsanleitung Maschinenrichtlinie

 

werkinstructie voorbeeld

Wie dieses Beispiel, das wir für ein Produkt der Firma Skil erstellt haben (ein Elektrowerkzeug, das unter die Maschinenrichtlinie 2006/42/EG fällt)?

Maschine Betriebsanleitung

Oder diese Betriebsanleitung, die konform ist mit der Europäischen Norm EN 15194 (EPAC - Electrically Power Assisted Cycles/Elektromotorisch unterstützte Räder), die im Rahmen der Maschinenrichtlinie harmonisiert ist?

Betriebsanleitung Fahrrad

Nachdem Sie diesen Artikel gelesen haben können Sie selbstständig eine Betriebsanleitung erstellen, ohne einen Abschluss in Ingenieurswesen, Technischer Kommunikation, Design UND Jura.

MÖCHTEN SIE EINE VORLAGE FÜR EINE BETRIEBSANLEITUNG NUTZEN, DIE BEREITS ALLE RECHTLICHEN ASPEKTE ENTHÄLT?

Nehmen Sie den schnellsten Weg zu einer konformen Anleitung. Wir haben Vorlagen (in deutscher Sprache) für Betriebsanleitungen für Maschinen entwickelt, die bereits alle rechtlichen Inhalte beinhalten. 

HIER BESTELLEN!

Was sollte eine Betriebsanleitung für Maschinen beinhalten?

Eine Betriebsanleitung für Maschinen sollte die folgenden Informationen beinhalten:

  • Alle Informationen für die vorgesehenen Anwender der Maschine, damit diese die Maschine während deren Lebenszyklus sicher und effizient bedienen können.
  • Alle rechtlich (durch z. B. die Maschinenrichtlinie und relevante Normen der CE-Kennzichnung) vorgeschriebenen Inhalte, wie:
    • Sicherheitshinweise als Ergebnis der Risikoanalyse;
    • Sicherheitshinweise, wie sie meinen Standards für den jeweiligen Maschinentyp entnommen werden können;
    • Eine genaue Beschreibung der bestimmungsgemäßen Verwendung und der vernünftigerweise absehbaren Fehlanwendung;
    • Relevante Bestandteile wie von der IEC/IEEE 82079-1:2019 und ISO 20607 vorgegeben.

Je nach Maschine, für die Sie eine Betriebsanleitung erstellen, ist es gut möglich, dass es rechtliche Vorschriften zum Inhalt, der Darstellung und dem Format ihrer Betriebsanleitung gibt.

Diese können von nationaler Rechtsprechung in den USA, Richtlinien oder Verordnungen in der EU oder ähnlichen Rechtsvorgaben anderer Länder oder Staaten stammen.

Um diesen Vorgaben zu entsprechen, können bzw. müssen gewisse Normen befolgt werden.

Medizinische Geräte sind beispielsweise die am stärksten regulierten Produkte. In den USA gilt die Guidance on Medical Device Patient Labelling (Richtlinie zur Produktkennzeichnung von Medizinprodukten), wohingegen in der EU die Anforderungen an die Gebrauchsanweisung der Medizinprodukteverordnung gelten.

Indem Sie diese rechtlichen Vorgaben einhalten und die Normen anwenden, erstellen Sie eine rechtskonforme Betriebsanleitung. 

Damit vermeiden Sie jegliche rechtlichen Stolpersteine, Ihre Maschine besteht Test und Zollvorgaben, Sie reduzieren Ihre Haftung, verschaffen sich einen Wettbewerbsvorteil und ermöglichen Ihren Kunden einen noch sichereren Umgang mit der Maschine.

Grundsätzlich sollten die folgenden Punkte befolgt werden, um eine rechtskonforme Betriebsanleitung zu erstellen:

  • Rechtsvorschriften identifizieren (Gesetze/Richtlinien);
  • Normen identifizieren;
  • Vorgaben aus Gesetzen und Normen identifizieren, die auf ihre Maschine zutreffen;
  • Rechtliche Inhalte der Betriebsanleitung hinzufügen.

Über diesen Prozess habe ich eingehend sowohl für den amerikanischen als auch den europäischen Markt geschrieben.

Darüber hinaus können Ihnen diese Vorlagen oder dieses Fallbeispiel dabei helfen, rechtskonforme Betriebsanleitungen für Ihre Maschinen, Elektrogeräte, Spielzeuge, Medizinprodukte etc. zu erstellen. Oder lesen Sie diesen Fallspiel.

Inhalt betriebsanleitung nach maschinenrichtlinie

Laut Maschinenrichtlinie muss jede Betriebsanleitung, falls zutreffend, mindestens die folgenden Informationen beinhalten:

  1. Firmenname und vollständige Anschrift des Herstellers und seines Bevollmächtigten; 
  2. Bezeichnung der Maschine entsprechend der Angabe auf der Maschine selbst, ausgenommen die Seriennummer;
  3. die EG-Konformitätserklärung;
  4. eine allgemeine Beschreibung der Maschine;
  5. die für Verwendung, Wartung und Instandsetzung der Maschine und zur Überprüfung ihres ordnungsgemäßen Funktionierens erforderlichen Zeichnungen, Schaltpläne, Beschreibungen und Erläuterungen;
  6. eine Beschreibung des Arbeitsplatzes bzw. der Arbeitsplätze, die voraussichtlich vom Bedienungspersonal eingenommen werden;
  7. eine Beschreibung der bestimmungsgemäßen Verwendung der Maschine;
  8. Warnhinweise in Bezug auf Fehlanwendungen der Maschine, zu denen es erfahrungsgemäß kommen kann;
  9. Anleitungen zur Montage, zum Aufbau und zum Anschluss der Maschine, einschließlich der Zeichnungen, Schaltpläne und der Befestigungen, sowie Angabe des Maschinengestells oder der Anlage, auf das bzw. in die die Maschine montiert werden soll;
  10. Installations- und Montagevorschriften zur Verminderung von Lärm und Vibrationen;
  11. Hinweise zur Inbetriebnahme und zum Betrieb der Maschine sowie erforderlichenfalls Hinweise zur Ausbildung bzw. Einarbeitung des Bedienungspersonals;
  12. Angaben zu Restrisiken, die trotz der Maßnahmen zur Integration der Sicherheit bei der Konstruktion, trotz der Sicherheitsvorkehrungen und trotz der ergänzenden Schutzmaßnahmen noch verbleiben;
  13. Anleitung für die vom Benutzer zu treffenden Schutzmaßnahmen, gegebenenfalls einschließlich der bereitzustellenden persönlichen Schutzausrüstung;
  14. die wesentlichen Merkmale der Werkzeuge, die an der Maschine angebracht werden können;
  15. Bedingungen, unter denen die Maschine die Anforderungen an die Standsicherheit beim Betrieb, beim Transport, bei der Montage, bei der Demontage, wenn sie außer Betrieb ist, bei Prüfungen sowie bei vorhersehbaren Störungen erfüllt;
  16. Sicherheitshinweise zum Transport, zur Handhabung und zur Lagerung, mit Angabe des Gewichts der Maschine und ihrer verschiedenen Bauteile, falls sie regelmäßig getrennt transportiert werden müssen;
  17. bei Unfällen oder Störungen erforderliches Vorgehen; falls es zu einer Blockierung kommen kann, ist in der Betriebsanleitung anzugeben, wie zum gefahrlosen Lösen der Blockierung vorzugehen ist;
  18. Beschreibung der vom Benutzer durchzuführenden Einrichtungs- und Wartungsarbeiten sowie der zu treffenden vorbeugenden Wartungsmaßnahmen;
  19. Anweisungen zum sicheren Einrichten und Warten einschließlich der dabei zu treffenden Schutzmaßnahmen;
  20. Spezifikationen der zu verwendenden Ersatzteile, wenn diese sich auf die Sicherheit und Gesundheit des Bedienungspersonals auswirken;
  21. folgende Angaben zur Luftschallemission der Maschine:
    1. der A-bewertete Emissionsschalldruckpegel an den Arbeitsplätzen, sofern er 70 dB(A) übersteigt; ist dieser Pegel kleiner oder gleich 70 dB(A), so ist dies anzugeben;
    2. der Höchstwert des momentanen C-bewerteten Emissionsschalldruckpegels an den Arbeitsplätzen, sofern er 63 Pa (130 dB bezogen auf 20 µPa) übersteigt;
    3. der A-bewertete Schallleistungspegel der Maschine, wenn der A-bewertete Emissionsschalldruckpegel an den Arbeitsplätzen 80 dB(A) übersteigt.
  22. Kann die Maschine nichtionisierende Strahlung abgeben, die Personen, insbesondere Träger aktiver oder nicht aktiver implantierbarer medizinischer Geräte, schädigen kann, so sind Angaben über die Strahlung zu machen, der das Bedienungspersonal und gefährdete Personen ausgesetzt sind.

Dieses Video zeigt Ihnen, wie Sie die rechtliche Anforderungen für Ihre Maschine bestimmen:

HIER KAUFEN

Durchführung einer Risikoanalyse und alle Sicherheitshinweise

Ganz egal, wie gut und sicher eine Maschine entworfen wurde, birgt deren Verwendung trotzdem oft einige Risiken. Risiken könne mithilfe einer Risikoanalyse identifiziert werden.

Mit der Durchführung einer strukturierten Risikoanalyse werden alle Gefahren, die mit der Verwendung einer bestimmten Maschine zusammenhängen im Hinblick auf jegliche Risiken abgebildet und festgestellt, um infolge dessen Risiken reduzieren zu können.

Grundsätzlich ist man sich einig (in internationalen Normen, wie der ISO 12100), dass es drei Wege gibt, solche Risiken zu reduzieren:

Sie können das Design ihrer Maschine anpassen, die Maschine oder deren Benutzer mit Sicherheitsvorkehrungen (wie Schutzmaßnahmen, Persönliche Schutzausrüstung) ausstatten oder Sicherheitshinweise zur Verfügung stellen.

Diese drei risikominimierenden Maßnahmen sollten in spezifischer Reihenfolge eingesetzt werden. Eine Betriebsanleitung sollte niemals dazu genutzt werden, vor Risiken zu warnen, wenn das Design der Maschine dementsprechend noch verbessert werden könnte.

Eine Risikoanalyse identifiziert die Gefahren, die Risikostufe und die Maßnahme zur Risikominimierung.

Besteht die risikominimierende Maßnahme darin, Sicherheitshinweise auszugeben, kann dies durch Sicherheitsanweisungen an der Maschine oder in der Betriebsanleitung geschehen.

Risikoanalyse

Risikoanalyse ISO 12100

Informieren Sie sich über Normen und fügen Sie jegliche vorgeschriebenen Sicherheitshinweise ein

Rechtsprechung, so wie die Maschinenrichtlinie, verlangt, dass Maschinen sicher sind, gehen aber nicht im Detail darauf ein, wie diese Sicherheit erreicht werden kann.

Dafür sind die Standards und Normen da. Harmonisierte europäische Normen untermauern inhaltlich diese essentiellen Anforderungen, die in den Richtlinien festgeschrieben sind. Die harmonisierten europäischen Standards im Kontext der Maschinenrichtlinie sind in Standards von Typ A, B und C unterteilt.

Standards vom Typ A sind fundamentale Sicherheitsstandards.

Standards von Typ B befassen sich mit einem bestimmten Sicherheitsaspekt und gelten für Maschinen auf die die thematisierte Sicherheitsvorrichtung oder der Sicherheitsaspekt zutreffen.

Standards von Typ C betreffen spezifische Maschinenkategorien und sind in zahlreiche Hauptgruppen unterteilt, wie Handwerkzeuge, Elektrogeräte, Fördermaschinen, Pumpen und Kompressoren.

Kapitel 4 eines Standards der Kategorie C enthält eine Gefahrenliste. In Kapitel 7 wird beschrieben, was eine Betriebsanleitung zusätzlich zu den üblichen Themen, wie die Erklärung der Funktion und Bedienung der Maschine, beinhalten sollte.

Zum Beispiel beinhaltet der C-Standard einer elektrischen Heckenschere eine Gefahrenliste in einer bestimmten Reihenfolge, beginnend mit mechanischen Gefahren, gefolgt von elektrischen Gefahren, Gefahren durch Hitze usw.

Aus der Tabelle in der Norm kann entnommen werden, dass z. B. Gefahren durch Schnitte (1.2) eine relevante Gefahr darstellen und daraufhin die Maßnahmen in den Abschnitten 5.2.2, 5.2.3, 5.2.5 und 6.1 gelten.

Um die Gefahr vor Schnittverletzungen zu reduzieren, kann das Risiko durch das Maschinendesign selbst reduziert werden, z. B. durch eine zweihändige Bedienung, oder die Bediener können mittels Schutzvorrichtungen vor gefährlichen Teilen geschützt werden.

In der Norm für Heckenscheren (EN ISO 10517) steht folgendes über Betriebsanleitungen:

Jede Heckenschere muss mit einer Betriebsanleitung versehen werden, die in einer der offiziellen Sprachen des Verkaufslandes verfasst ist und in der genaue Anweisungen zur Verwendungen aller Steuerungen, der Reparatur und Wartung zu finden sind. Die Betriebsanleitung muss die folgenden Anweisungen beinhalten.

  • DIESE HECKENSCHERE KANN SCHWERE VERLETZUNGEN VERURSACHEN. Lesen Sie die Anweisungen zur korrekten Verwendung, Vorbereitung, Wartung, zum Anlassen und Stoppen der Heckenschere sorgfältig durch. Machen Sie sich mit allen Schaltern und der ordnungsgemäßen Verwendung der Heckenschere vertraut.
  • Lassen Sie niemals Kinder die Heckenschere verwenden.
  • Seien Sie vorsichtig im Hinblick auf in der Höhe verlaufende Stromleitungen.

Maschinenkonstrukteure (oder Hersteller) sind angewiesen zu überprüfen, ob die in der betreffenden C-Norm angegebenen Gefahren auch für die eigene Maschine zutreffen.

Nicht alle beschriebenen Gefahren gelten für jede Maschine. Wenn eine Gefahr oder ein Risiko im Standard nicht erwähnt wird, heißt es andererseits nicht, dass es nicht existiert oder nicht relevant ist.

Stellen Sie die Beschreibung der bestimmungsgemäßen Verwendung und der vernünftigerweise absehbaren Fehlanwendung achtsam zusammen

Der Zweck ihrer Maschine wird auch bestimmungsgemäße Verwendung genannt.

Die folgende Definition der bestimmungsgemäßen Verwendung stammt aus der internationalen Norm für Nutzungsinformationen (IEC/IEEE 82079-1:2019):

An exhaustive range of functions or foreseen applications defined and designed by the supplier of the product / Eine umfassende Bandbreite von Funktionen oder vorgesehenen Anwendungen, die von Lieferanten des Produkts definiert und entworfen wurden

Eine eindeutige Beschreibung der bestimmungsgemäßen Verwendung steht im Zentrum einer Betriebsanleitung und bildet (mit weiteren Nutzungsbeschränkungen, wie technische oder umweltbedingte Begrenzungen) den schützenden Mantel der Verwendung Ihrer Maschine: Sie bildet die Grundlage einer sicheren, effizienten und effektiven Verwendung jeglicher Maschinen.

Die Beschreibung der bestimmungsgemäßen Verwendung gibt einen Rahmen für Ihre Haftung an und ist der Ausgangspunkt noch folgender Inhalte ihrer Betriebsanleitung.

Die Maschinenrichtlinie verlangt eine Beschreibung der bestimmungsgemäßen Verwendung und vernünftigerweise absehbarer Fehlanwendungen in der Betriebsanleitung.

Ein Beispiel für die bestimmungsgemäße Verwendung:

Bestimmungsgemaesse Verwendung 

Was ist also eine vernünftigerweise absehbare Fehlanwendung?

Die folgende Definition vernünftigerweise absehbarer Fehlanwendung stammt aus der Norm IEC/IEEE 82079-1:2019:

"The use of a product or system in a way not intended by the supplier, but which can result from readily predictable human behaviour"

(Die Verwendung eines Produkts oder Systems in einer durch den Hersteller nicht vorgesehenen Weise, die sich aber aus leicht absehbarem menschlichen Verhalten ergeben kann)

Einige Beispiele:

  • Verwendung eines aggressiven Reinigungsmittels in der Lebensmittelherstellung.
  • Einsatz einer automatischen Tür für Personenverkehr (in der Kinder stehen, während sie sich öffnet oder schließt)

 Bestimmungsgemäße Verwendung

Beispiel einer vernünftigerweise absehbaren Fehlanwendung

vernünftigerweise  vorhersehbare Fehlanwendung

Beispiel einer vernünftigerweise absehbaren Fehlanwendung

Schenken Sie der Beschreibung der vernünftigerweise absehbaren Fehlanwendung keine oder zu wenig Beachtung, kann dies auch ihre Haftung betreffen.

Wenn z. B. vernünftigerweise abzusehen ist, dass ein bestimmtes Kühlsystem, das in Krankenhäusern verwendet wird, als Kühlung für Organe verwendet werden könnte, sollte dies in der Betriebsanleitung erwähnt werden.

Unvorhersehbare Fehlanwendungen sollten nicht in der Betriebsanleitung besprochen werden, da diese grundsätzlich nicht unter Ihre Haftung fallen.

 

Vernünftigerweise vorhersehbare Fehlanwendung oder unvorhersehbare Fehlanwendung?

Verwenden Sie die Normen 82079 und 20607, um bessere Betriebsanleitungen zu erstellen

Der offizielle Titel lautet „IEC/IEEE 82079-1:2019 - Erstellen von Nutzungsinformationen (Gebrauchsanweisungen) für Produkte - Teil 1: Grundsätze und allgemeine Anforderungen“.

Es ist wichtig zu erwähnen, dass es sich hier um eine so genannte horizontale Norm handelt, d. h. sie betrifft nicht ein spezifisches Produkt oder eine Branche, sondern enthält Regeln über alle Sektoren für fast alle Industriezweige, von Spielzeugen über Medizinprodukte sowie Elektrogeräte und Maschinen.

Die Norm liefert Vorgaben zum Inhalt, der Struktur, Qualität, zu Prozessen, Medien und dem Format der Nutzungsinformationen.

Laut der Norm 82079 müssen Nutzungsinformationen die notwendigen Informationen für das Zielpublikum liefern, um ein Produkt sicher, effizient und effektiv verwenden zu können.

Die Anforderungen der Norm sind unterteilt in die Anforderungen an die Nutzungsinformationen (wie die Betriebsanleitung) und die Anforderungen zum Prozess des Informationsmanagements.

Für weitere Informationen zur Anwendung der Norm 82079, lesen Sie diesen Artikel:
https://instrktiv.com/de/82079/

Zusätzlich sollten Sie sich an die Norm ISO 20607 zu Betriebsanleitungen für Maschinen halten.

Die aktuelle Norm 20607 wurde auf Grundlage der Norm 82079 erstellt und sollte als Weiterentwicklung der Norm 82079 betrachtet werden. Sie enthält zusätzliche Richtlinien speziell zur Erstellung von Betriebsanleitungen für Maschinen.

Wenn Sie sicherstellen möchten, dass Sie alle rechtlichen und regulatorischen Anforderungen sowie Marktanforderungen für Ihre Maschine erfüllen, ist die Anwendung der ISO 20607 ein absolutes Muss.

Die Norm 20607 bietet Sicherheitsspezifikationen für Maschinen, die spezifischer verfasst sind, als die der Norm 82079. Es besteht eine starke Verbindung zur ISO-Norm 12100 zur Risikobeurteilung und Risikominderung.

Da die ISO-Norm 12100 nur für Maschinen gilt, wurde diese Norm bei der Entwicklung der Norm 82079 nicht berücksichtigt.

Die Norm 82079 ist für ein breites Spektrum an Produkten ausgelegt, es obliegt daher dem Technischen Redakteur zu entscheiden, welche Anforderungen für welches spezielle Produkt gelten sollen, ob es nun ein Spielzeug, eine Maschine oder ein Medizinprodukt ist.

82079 Checkliste

Aus diesem Grund wird der Geltungsbereich der Norm 20607 definiert als „Festlegen von Anforderungen an den Maschinenhersteller bei der Gestaltung der sicherheitsrelevanten Teile einer Betriebsanleitung für Maschinen“.

Die Norm 20607 deckt alle Bestimmungen aus Abschnitt 1.7.2.4 der Maschinenrichtlinie und somit die gesamte Richtlinie komplett ab (mit Ausnahme der Anforderungen an die Schallemission, die durch andere Normen geregelt wird).

Die Norm 82079 deckt hingegen diese Bestimmungen der Maschinenrichtlinie nicht explizit ab.

Da die Norm 20607 als Ergänzung zu Norm 82079 zu verstehen ist, sollten bei der Erstellung einer Betriebsanleitung für Maschinen stets beide Normen angewendet werden.

Wenn Sie bei der Ausarbeitung Ihrer Betriebsanleitung beide Normen anwenden (sobald sie harmonisiert sind), schaffen Sie höchstmögliche Konformität mit den entsprechenden Anforderungen der Rechtsvorschriften zur Harmonisierung.

Gemäß der Norm 20607 sollte eine normenkonform gestaltete Betriebsanleitung die Leser entsprechend informieren, so dass sie nach der Lektüre wissen und verstehen, wie sie die Maschine über ihren gesamten Lebenszyklus sicher und bestimmungsgemäß verwenden können.

Aber genau wie die Norm 82079 enthält auch die Norm 20607 noch allgemeine Richtlinien, die zur Einhaltung der Maschinenrichtlinie zu befolgen sind. Es obliegt dem technischen Redakteur, mit Hilfe dieser Richtlinien eine klare und sichere Anleitung für einen bestimmten Maschinentyp zu erstellen.

Beispielsweise besagt die Norm 20607, dass eine Betriebsanleitung auch eine Installationsanleitung enthalten muss. Allerdings wird nicht näher darauf eingegangen, welche genauen Bestandteile eine solche Installationsanleitung enthalten muss.

In Hinblick auf die Maschinen und ergänzend zur Norm 82079 deckt die Norm 20607 also die folgenden Themen ab:

  • Inhalt und Aufbau der Betriebsanleitung;
  • Sprache und Formulierungen/stilistischer Leitfaden;
  • Publikationsformen.

Um die Einhaltung von Abschnitt 1.7.4.2 der Maschinenrichtlinie zu gewährleisten, sind Inhalt und Aufbau Bestandteil der Norm. Dieser Abschnitt beschreibt den Inhalt von Anleitungen für Maschinen ausführlich und übersichtlich.

Der Inhalt von Maschinenanleitungen unterscheidet sich häufig vom Inhalt der Anleitungen anderer Produktgruppen. Beispielsweise sollten Sie bei Maschinen eine Ersatzteilliste oder Inbetriebnahmeanleitung integrieren. Für Spielzeug hingegen sind Informationen dieser Art von geringerer Bedeutung.

Sprachliche Anforderungen und die Publikationsform unterscheiden sich ebenfalls leicht von denen anderer Produkte.

Die Norm 20607 bietet viel mehr Freiheit im Hinblick auf die elektronische Publikation von Betriebsanleitungen verglichen damit, wie dieses Thema im Leitfaden zur Anwendung der Maschinenrichtlinie interpretiert wurde.

Die Maschinenrichtlinie stellt Anforderungen zum Inhalt der Betriebsanleitungen. Die ISO-Norm 12100 verlangt ebenfalls jegliche Inhalte hinzuzufügen, die während des gesamten Lebenszyklus einer Maschine verwendet werden könnten.

Als Antwort darauf stellt die Norm 20607 beispielhaft vor, wie eine Betriebsanleitung strukturiert werden kann. In anderen Worten: wie das Inhaltsverzeichnis der Betriebsanleitung aussehen könnte. Natürlich sollte das Inhaltsverzeichnis noch weiter den Anforderungen der Verbraucher der spezifischen Maschine angepasst werden.

Inhaltsverzeichnis der Betriebsanleitung gem. ISO 20607:

Titelseite
Inhaltsverzeichnis
Vorstellung und Zweck der Betriebsanleitung
Sicherheit

  • Beschreibung der Maschine
  • Bestimmungsgemäße Verwendung
  • Wichtige Maschinenspezifikationen
  • Beschreibung der Steuerungen und Displays
  • Grundriss/Bauplan

Transport, Handhabung und Lagerung

  • Transportieren der Maschine und/oder Teilen davon
  • Handhabung der Maschine und/oder Teilen davon
  • Lagern der Maschine und/oder Teilen davon

Aufbau, Installation und Inbetriebnahme

  • Aufbau/Integration der Maschine
  • Standort/Positionierung der Maschine
  • Mechanische, pneumatische, hydraulische und elektrische Installation
  • Überprüfen und Testen der Sicherheitssysteme
  • Installationstest
  • Inbetriebnahme

Originalbauteile und Werkseinstellungen

  • Mechanische Einstellungen und Synchronisation
  • Sicherheitsparameter (Einstellungen)
  • Pneumatische, hydraulische, elektrische und Vakuumeinstellungen
  • Weitere Einstellungen

Betrieb

  • Betriebsmodi
  • Anfahren und Abschalten der Maschine
  • Sequenz oder Chronologie der Betriebsabläufe
  • Weitere Betriebsanweisungen, falls zutreffend

Umrüstung des Produkts oder der Kapazität

  • Generelle Angaben zur Umrüstung des Produkts oder der Kapazität
  • Angaben zu produktspezifischen Einstellungen

Inspektion, Tests und Wartung
Reinigung und Desinfektion
Fehlersuche/Problembehebung und Reparatur

  • Generelle Angaben zur Fehlersuche/Problembehebung und Reparatur
  • Tabelle zur Fehlersuche (Elektrotechnik)
  • Fehlersuche bei elektrischen Sensoren, Vakuumsystemen, pneumatischen Systemen und hydraulischen Systemen

Abbau, Außerbetriebnahme und Entsorgung
Dokumente und Zeichnungen

  • Dokumente
  • Zeichnungen
  • Teileliste

Index
Glossar
Anhänge

Wie sie eindeutige Texte schreiben können

Klare und eindeutige Texte, die zu einer umfassenden Betriebsanleitung beitragen, können folgendermaßen erstellt werden:

  • Sammeln aller relevanten Informationen;
  • Korrekte Organisation und Strukturierung der Informationen;
  • Fachjargon vermeiden;
  • Sinnvolle Überschriften erstellen;
  • Die Benutzer dazu anzuregen, Dinge zu erledigen;
  • Aktive Formulierungen wählen;
  • Fehlerbehebung einfügen.

Oft wird die Bedeutung der Erstellung eindeutig formulierter Texte aufgrund fehlenden Wissens übersehen oder unterschätzt, da viele Betriebsanleitungen von den Technikern verfasst werden, die die Maschine entwickelt haben.

Sammeln Sie nur die Informationen, die Ihren Benutzern dabei helfen, deren Probleme zu lösen. Dadurch erstellen Sie eine Betriebsanleitung, die tatsächlich gelesen wird.

Eine Sache, der ich gerne etwas mehr Aufmerksamkeit widmen möchte, ist die Bedeutung dessen, dass Sie die Probleme ihrer Benutzer lösen. Das ist der Ausgangspunkt sowohl für die Befragung der Fachexperten (subject matter experts, SME) und die Darstellung, Strukturierung und Organisation Ihrer Informationen (siehe nächste Abschnitte).

Die Benutzer, für die Sie schreiben, werden während des Lebenszyklus der Maschine höchstwahrscheinlich mit Problemen konfrontiert sein. Diese Probleme möchten sie lösen. Und dafür brauchen sie Sie.

Wenn Sie also mit Ihren SMEs sprechen, Informationen sammeln etc., versuchen Sie stets, die möglichen Probleme der Benutzer zu identifizieren.

Typische Probleme sind den oben beschriebenen Fragen sehr ähnlich und drehen sich um die Installation, Verwendung, Wartung, Reparatur, Reinigung und Entsorgung der Maschine.

Die Probleme sind dabei sehr spezifisch, wie z. B.:

  • Wie kann ich Lärm oder Vibrationen reduzieren?
  • Wie kann ich die Gussform meiner Maschine ersetzen?
  • Was bedeutet das rot blinkende LED-Licht?
  • Darf ich das Gehäuse meiner Maschine mit einem Reinigungsmittel säubern?

Wir haben beispielsweise für einen Maschinentyp namens Roof Washer eine Betriebsanleitung erstellt. Einer der wichtigen Schritte, die vom Benutzer durchgeführt werden müssen, ist es, den Roof Washer für den Betrieb vorzubereiten.

Das Hauptproblem wäre dann also: Wie bereite ich den Roof Washer für den Betrieb vor?

Da es sich hierbei um einen RIESIGEN Themenbereich handelt, haben wir das Thema in die folgenden Chunks unterteilt:

  • Wie Sie den Inhalt der Lieferung überprüfen
  • Wie Sie die mobile Plattform vorbereiten
  • Wie Sie den Roof Washer vorbereiten
  • Wie Sie den Top Cleaner auf das Gewächshaus setzen
  • Wie Sie die mobile Plattform anpassen
  • Wie Sie den Roof Washer anpassen
    • Anpassung der Hauptbürsten
    • Einstellung des optionalen Fensterschutzschalters
    • Anpassung der optionalen Dachrinnenbürste
    • Einstellung der Vorderradumschalthebels

Hier beginnen Sie bereits, Themen zu erstellen. Themenbasiertes Authoring ist für die Erstellung klarer Betriebsanleitungen essentiell.

Ordnen Sie Ihre Themen, um die Navigation in der Betriebsanleitung zu erleichtern. Inhaltsverzeichnis = Ihre Anordnung der Themen in der Betriebsanleitung.

Organisieren und strukturieren Sie Informationen, um Ihre Benutzer bei der Suche nach Lösungen zu unterstützen

Sie ertrinken in Informationen: Von der Verwendung der Maschine und der Analyse aller zur Verfügung stehenden Dokumentation, bis hin zu den Informationen, die Sie von den Fachexperten bekommen.

In diesen Informationen stecken die Beschreibung der Probleme, die Ihre Benutzer gerne lösen möchten, die eigentlichen Lösungen, aber auch alle möglichen weiteren Informationen, wie elektrische Schaltbilder, Ersatzteillisten etc.

Eine der größten Herausforderungen eines Technischen Redakteurs ist es, alle Informationen zu sammeln, diese zu analysieren, festzulegen, was relevant ist, Informationen zu verwerfen, sie zu organisieren und zu strukturieren.

Wie sollen Sie all das verarbeiten und organisieren?

Das ist fast unmöglich, wenn Sie ihre Informationen nicht ordentlich bestimmen und anlegen. Nochmal: Ihr Ziel sollte es sein, alle nützlichen Informationen zu erhalten, um daraus Themen zu beschreiben, anhand derer die Fragen Ihrer Benutzer beantwortet werden können.

Diese Themen werden klar organisiert und nachvollziehbar in Ihrem Inhaltsverzeichnis oder dem Menü dargestellt, in der chronologischen Reihenfolge des Lebenszyklus ihrer Maschine (siehe nächster Abschnitt).

Aber bevor Sie ihr endgültiges, sorgfältig handgefertigtes (jawohl, dies sollte Ihr Meisterstück werden) Inhaltsverzeichnis haben, sollten Sie alle Informationen strukturieren und organisieren.

Einige Methoden und Tools, die Ihnen dabei helfen können:

  1. Erstellen Sie das Inhaltsverzeichnis von unterwegs;
  2. Wenden Sie Mind Mapping an;
  3. Verwenden Sie Information Mapping-Techniken;
  4. Verwenden Sie die guten alten Post-Its.

Alle Methoden basieren auf folgendem Prinzipien:

  • Alle wichtigen Informationen in kleine, verwertbare Chunks aufbrechen;
  • Jeder Informations-Chunk sollte sich nur einem einzelnen Thema widmen;
  • Benennen Sie jeden Informations-Chunk so, dass dessen Inhalte wiedergegeben werden, d. h. dass die Benennung den Inhalt beschreiben sollte. Es wäre beispielsweise besser, ‚Softwareupdate durchführen‘ mit Installation anstatt Verwendung zu überschreiben.
  • Organisieren und strukturieren Sie Informationen und stellen Sie dabei sicher, dass Sie bei der Organisation, Formatierung und Anordnung der Informationen konsistent bleiben (dasselbe gilt auch für die Verwendung von Terminologie).

Vermeiden Sie Fachjargon aus Gründen der Verständlichkeit

Betriebsanleitungen, die von Technischem Personal erstellt wurden, beinhalten oft sehr viel Fachjargon.

Was ist Fachjargon?

Fachjargon ist unnötig komplizierte Sprache, die zumeist verwendet wird, um die Leserschaft zu beeindrucken anstatt sie zu informieren.

Ich sage nicht, dass Sie keine technischen Fachausdrücke verwenden sollen. Oft brauchen Sie diese Ausdrücke, um eine Maschine ordentlich zu beschreiben.

Der Ausgangspunkt sollte sein, eine Betriebsanleitung zu erstellen, die so klar und verständlich wie möglich ist. Die Verwendung von Terminologie, die nicht Teil des normales Vokabulars Ihrer Leserschaft ist, trägt dazu nicht bei.

Erstellen Sie aussagekräftige Überschriften zur besseren Navigation

Eine Überschrift ist ein Titel am Beginn einer Seite oder eines Abschnitts einer Betriebsanleitung.

Eine Überschrift trennt oft Themen und Unterpunkte einer Betriebsanleitung. Eine gute Überschrift deckt den gesamten Inhalt des zugehörigen Themas ab.

Es ist sehr wichtig, dass Sie ihre Überschrift bedacht formulieren und einen konsistenten Stil und ein konsistentes Format verwenden, damit die Benutzer die Informationen finden, nach denen sie suchen.

Versuche Sie nicht mehr als drei Überschriftsebenen zu verwenden: Die erste, zweite und dritte Ebene. Übertreiben Sie es nicht mit den Überschriftsebenen.

Sehen Sie sich diese Beispiele an:

 

Beachten Sie, dass die Formulierung der Überschriften konsistent ist: Die Überschrift der ersten Ebene beschreibt, wovon das ganze Kapitel handelt. Die Überschrift der zweiten Ebene verwendet eine Wie-Formulierung. Die Überschrift der dritten Ebene ist im Nominalstil verfasst.

Formulieren Sie die Überschriften so, dass sie selbsterklärend sind. Die Überschrift How to Band a Product ist viel benutzerorientierter als Using the Bandall Standard Machinery.

Und die Überschrift ‚Ölwechsel‘ ist viel eindeutiger als ‚Wartung‘.

Lassen Sie ihre Benutzer handeln, SOFORT!

Sie können zum Handeln anregen, indem Sie weniger konzeptuelle Informationen geben und sich auf Abläufe konzentrieren: Die Benutzer möchten die Dinge erledigen und nicht darüber lesen.

Sie können zum Handeln anregen, indem Sie weniger konzeptuelle Informationen geben und sich auf Abläufe konzentrieren: Die Benutzer möchten die Dinge erledigen und nicht darüber lesen.

In vielen herkömmlichen Betriebsanleitungen wird nicht viel Wert darauf gelegt, zu Beginn des Handbuchs Handlungen zu erwähnen, die die Benutzer durchführen müssen.

Viele Betriebsanleitungen beginnen mit Erläuterungen, Technischen Daten, Sicherheitsanweisungen, Prozessbeschreibungen usw. Diese Informationen sind sicherlich an gewisser Stelle wertvoll, lenken die Benutzer jedoch von ihrem eigentlichen Ziel ab.

Versuchen Sie, in Ihrer Betriebsanleitung nur das absolute Minimum der wichtigsten, Must-Know-Informationen, abzudecken und erachten Sie alle nebensächlichen, Nice-To-Know-Informationen, als obsolet.

Schaffen Sie es, sich kurz zu halten, wird die Betriebsanleitung den Eindruck erwecken, dass die Aufgaben der Benutzer keine besondere Anstrengung verlangen, sonder relativ leicht zu erledigen sind.

Wenn Sie nicht alles umfassend erklären, stimuliert die Betriebsanleitung die Benutzer, relevantes Vorwissen zu aktivieren und sich mehr auf das eigene Denken zu konzentrieren.

Meistern Sie es, Hintergrundinformationen zu minimieren und gerade genug Informationen zur Verfügung zu stellen, damit die Benutzer eine Aufgabe erledigen oder ein Konzept verstehen können, so werden Ihre Anweisungen sehr viel klarer.

Verwenden Sie aktive Formulierungen, damit Anweisungen besser verstanden werden können

Stellen Sie sicher, dass die Informationen, die Sie geben, so einfach und kurz wie möglich sind. Anweisungen sollten im Präsens Aktiv formuliert werden, unter Verwendung starker Verben.

Das Aktiv stellt den Benutzer in den Vordergrund und Anweisungen, die aktiv formuliert sind, lassen sich leichter lesen und verstehen.

Es ist in Aktivsätzen immer klar, was Subjekt und Verb sind. Zum Beispiel:

„Verbinden Sie eine Tastatur mit einem USB-Anschluss an der Fernbedienungseinheit.“

In diesem Satz ist Verbinden das aktive Verb und Tastatur, USB-Anschluss und Fernbedienungseinheit sind die Subjekte.

Vergleichen wir diesen Satz mit einem passiv formulierten Satz:

„Es muss eine Tastatur mit einem USB-Anschluss an der Fernbedienungseinheit verbunden werden.“

Im aktiv formulierten Satz ist es viel eindeutiger, dass der Leser die Person ist, die die Aufgabe erledigen wird.

Durch Verwendung des Aktivs werden Ihre Anweisungen klarer, deutlicher und direkter.

Fügen Sie eine Fehlerbehebung ein, um Fehler schneller zu korrigieren

Egal, wie gut eine Maschine oder deren Software entworfen wurde, passieren sicherlich Fehler bei der Verwendung. Als Technischer Redakteur sollten Sie das im Blick behalten.

Die Bediener einer Maschine machen viele einfache Fehler. Die Behebung dieser Fehler kann viel Zeit in Anspruch nehmen. Die Forschung [1] besagt, dass Benutzer zwischen 25 % und 50 % ihrer Zeit auf die Fehlerbehebung verwenden.

Es ist daher sehr wichtig, einer Betriebsanleitung ein Kapitel zur Fehlerbehebung beizufügen, das die Benutzer auch verstehen können.

Eine Fehlerbehebung anzubieten UND diese dort anzubieten, wo sie gebraucht wird, ist eine der unterschätztesten Aspekte einer Betriebsanleitung. Es gibt zahlreiche Möglichkeiten, wie gut entworfene Handbücher die Benutzer davor bewahren können, Fehler zu begehen.

Beispielsweise indem eine sichere Abfolge von Handlungsschritten angeboten wird, mit kurzen und einfachen Sätzen, minimalem Fachjargon, aktiven Verben usw.

Aber wie können Sie wissen, welche Fehlerinformationen Sie hinzufügen müssen?

Die Forschung [1] konnte zeigen, dass selbst erfahrene Technische Redakteure grundsätzlich nicht sehr gut voraussagen können, welche Probleme bei der Verwendung ihrer Betriebsanleitung entstehen könnten.

Der beste Weg, das herauszufinden, ist mit einem Usability-Test.

Wenn Sie die am häufigsten auftretenden Fehler identifiziert haben, schlägt ein Modell zum Einfügen von Informationen zur Problembehebung in Betriebsanleitungen folgende Schritte vor:

  • Das Problem erkennen;
  • Das Problem formulieren;
  • Die Informationen zur Problembehebung verarbeiten.

In anderen Worten: Stellen Sie sicher, dass Sie ihre Benutzer darin unterstützen, Fehler zu entdecken, diagnostizieren und zu beheben, wenn Sie Ihre Informationen zur Fehlerbehebung erstellen.

Sehen wir uns dieses Old-School-Beispiel an:

Fehlerinformation

Fehlerinformation eines Minihandbuchs zu WordPerfect.

Fehlerinformationen sind am effektivsten, wenn sie sich örtlich und zeitlich so nah wie möglich an der Fehlerquelle befinden. Das ist oft direkt nach einer bestimmten Handlungsanweisung.

Wenn Sie die Fehlerinformationen direkt an Ort und Stelle anbieten, wird der Fehler entdeckt und hoffentlich behoben, bevor es zu weiteren Fehlern kommen kann.

Ein separates Kapitel zur Fehlerbehebung, wie es oft zu sehen ist, ist nicht falsch, es macht den Benutzern aber den Zugang zu diesen Informationen schwerer und erschwert damit auch deren Verständnis, da ihnen der Kontext fehlt.

Liefern Sie die Fehlerinformationen direkt an passender Stelle, sparen Ihre Benutzer Zeit und sie sind weniger frustriert UND sie verlieren ihre Angst davor, lernen zu müssen, wie die Maschine verwendet wird.

Zusätzlich ist es auch produktiver, den Umgang mit einer Maschine über gute Fehlermanagement zu erlernen.

Wie Sie klare Visualisierungen für ihre Betriebsanleitung erstellen

Um umfassende Visualisierungen zur Unterstützung Ihrer geschriebenen Texte zu erstellen:

  • Verwenden Sie Illustrationen anstatt Fotos, um Ihre Anweisungen zu verbessern;
  • Verwenden Sie Tabellen, um Daten geordnet darzustellen;
  • Verwenden Sie standardisierte Symbole und Bildzeichen, wenn nötig;
  • Verwenden Sie standardisierte Sicherheitszeichen und -hinweise.

Illustration Betriebsanleitung

Verwenden Sie Strichzeichnungen, um die Anweisungen in Ihrem Handbuch zu verbessern

Sie können anhand von Strichzeichnungen Texte unterstützen, ersetzen oder verbessern und eine chronologische Abfolge eines zu folgenden Prozesses oder Schritts darstellen.

Stellen Sie sicher, dass die Abfolge der Illustrationen, die Sie in Ihrer Betriebsanleitung verwenden, logisch und nachvollziehbar ist.

Illustrationen Betriebsanleitung

Illustrationen, die eine Abfolge von Schritten beschreiben

Wenn Sie Illustrationen so nah wie möglich am Text platzieren, auf den sie sich beziehen, wird es deutlich, zu welcher verschriftlichten Anweisung sie gehören. Stellen Sie sicher, dass zusammengehörende Texte und Illustrationen zu selben Zeit sichtbar sind und dass sie sich gegenseitig für ein besseres Verständnis unterstützen.

Im Vergleich zu Fotos haben Sie mit Illustrationen viel mehr Spielraum, um sich auf besondere Details zu konzentrieren. Sie können ganz leicht weniger wichtige Informationen auslassen oder bestimmte Teile vergrößern.

Ein Vorteil, Text vollständig durch Illustrationen zu ersetzen, liegt darin, dass Illustrationen nicht übersetzt werden müssen. Seien Sie sich bewusst, dass die Erstellung verständlicher Illustrationen einiger Fertigkeiten bedarf.

Obwohl es viele Tools gibt, die Sie dabei unterstützen können, kann es eine kluge Entscheidung sein, sie von einem kompetenten Grafiker oder Technischen Zeichner erstellen zu lassen.

Bedenken Sie bei der Erstellung von Illustrationen auch die Druckqualität und Bildschirmauflösungen. Illustrationen, die auf Bildschirmen angezeigt werden, benötigen eine Mindestauflösung von 72 dpi und für den Druck ist eine minimale Auflösung von 300 dpi von Vorteil.

Fügen Sie nummerierte Bildunterschriften zu Ihren Illustrationen hinzu, damit es den Benutzern klar ist, wovon die Illustration handelt und sie die Illustration so besser identifizieren können, wenn von ihr im Text die Rede ist.

Illustrationen können darüber hinaus verwendet werden, um Maschinenteile und Hauptfunktionen der Maschine zu identifizieren, eine schematische Ansicht der Maschine oder z. B. eine Darstellung der Elektrik zu erhalten.

Illustration, die Hauptbestandteile eines Produkts darstellt

Manchmal werden Fotos anstatt Illustrationen verwendet. Ich bevorzuge jedoch sehr die Verwendung von Illustrationen, da diese oft viel eindeutiger sind.

Verwendung eines Fotos in einer Betriebsanleitung

Verwendung eines Fotos in einer Betriebsanleitung, die unser Kunde erstellt hat

Verwendung einer Illustration in der neuen Betriebsanleitung

Verwendung einer Illustration in der neuen Betriebsanleitung, die wir erstellt haben

Bei der Erstellung von Illustrationen können Sie irrelevante Informationen auslassen oder ganz leicht wichtige Angaben hervorheben. Bei Fotos ist das deutlich schwieriger.

Verwendung von Tabellen, um Daten zu ordnen und einen guten Überblick zu geben

Zur Anordnung von Daten, in Form von Zahlen oder Texten, können Sie Tabellen verwenden. Beispielsweise sind technische Daten besser zu lesen, wenn diese in einer Tabelle dargestellt werden. Oft kann der gesamte Text durch eine Tabelle ersetzt werden.

Stellen Sie sicher, dass Sie die Tabellen deutlich, informativ und in konsistentem Design erstellen. Positionieren Sie Tabellen in der Umgebung des dazugehörigen Texts. In Ausnahmefällen können Referenztabellen (wie Ersatzteillisten) in den Anhängen aufgelistet werden.

Tabellen Technische Daten

Technische Daten dargestellt in einer Tabelle


Verwenden Sie Zeichen und Symbole, um Informationen besser zu übertragen

Symbole, Zeichen und Sicherheitszeichen werden in Betriebsanleitungen oft verwendet. Sie vereint, dass sie eine vorgegebene und klar zu identifizierende Bedeutung tragen und zur sprachunabhängigen Weitergabe von Informationen dienen.

Diese Bedeutung wird durch eine Kombination aus Farben und geometrischen Formen erreicht.

Viele Symbole, Zeichen und Icons sind standardisiert. Einige viel verwendete Normen sind:

  • ISO 7010 - Graphische Symbole - Sicherheitsfarben und Sicherheitszeichen - Registrierte Sicherheitszeichen
  • IEC 60617 - Graphische Symbole für Schaltpläne
  • ISO 14617 - Graphische Symbole für Schemazeichnungen
  • ISO 5807 - Informationsverarbeitung; Dokumentationssymbole und -konventionen für Daten, für Programm- und Systemabläufe, für Pläne von Programmnetzen und Systemhilfsquellen

Wird ein graphisches Konzept durch ein in einer Norm registriertes graphisches Symbol dargestellt, so ist es sehr ratsam, dieses Symbol zu verwenden.

ISO-7010-symbols

Beispiele eindeutiger Symbole nach der ISO-Norm 7010

Verwenden Sie Warn-/Sicherheitshinweise, um die Sicherheitsinformationen zu verdeutlichen

Die Verwendung standardisierter Warnhinweise trägt zu einer klareren und sichereren Betriebsanleitung bei. Sie haben vorgegebene und klar identifizierbare Bedeutungen.

Die wichtigsten Normen für Sicherheitshinweise sind:

  • ISO 3864 - Graphische Symbole - Sicherheitsfarben und Sicherheitszeichen
  • ANSI Z535.6 - Product Safety Information In Product Manuals, Instructions And Other Collateral Materials

Produktsicherheitsschilder ISO 3864

Sicherheitshinweise nach der ISO-Norm 3864

ANSI Z535.6

Sicherheitshinweise nach ANSI Z535.6

Erklärung Sicherheitssymbole

Erklärung der Sicherheitssymbole

Wie Sie ihre Betriebsanleitung darstellen

Um Ihre Betriebsanleitung ansprechend und deutlich zu präsentieren, stellen Sie sicher, dass:

  • Sie ein gutes Grafikdesign haben;
  • Sie sich für das richtige Medium entscheiden;
  • Sie einige allgemeine Gestaltungsrichtlinien einhalten.

Seien Sie sich zunächst bewusst, dass Sie entweder eine einzelne Betriebsanleitung oder ein Set aus separaten Dokumenten erstellen können.

Beispielsweise möchten Sie vielleicht ein separates Dokument für die Installation, die Wartung oder den Betrieb der Maschine. Andere Gründe, die Betriebsanleitung in mehrere Dokumente aufzuteilen könnten sein, dass ein einzelnes Dokument zu groß oder komplex sein könnte oder Sie eine separate Betriebsanleitung für jede einzelne Zielgruppe haben möchten.

Sollten Sie sich entscheiden, alle Informationen für verschiedene Zielgruppen in einem Dokument zu bündeln, stellen Sie sicher, dass Sie klar darauf hinweisen, welcher Teil für wen bestimmt ist.

Stellen Sie auch sicher, dass Sie Schriftarten und -größen verwenden, die groß und deutlich genug und damit gut lesbar sind. Als Richtlinie kann gesagt werden, dass eine Schriftgröße zwischen 8 und 14 für Textabschnitte in gedruckten Betriebsanleitungen zu empfehlen ist.

Die ISO-Norm 20607 beinhaltet die Tabelle die in der Norm 82079 verwendet wird, in der minimale Schriftgrößen und Höhen von Sicherheitszeichen und -symbolen empfohlen werden. Sicherheitsinformationen sollten sich klar und deutlich von anderen Informationen abheben.

Diese Art von Informationen kann durch Fett- oder Kursivschreibung, Unterstreichen, Einrahmen oder Kolorierung hervorgehoben werden.

Verwenden Sie gutes Grafikdesign, um eine originelle Betriebsanleitung zu erstellen, die man gerne liest

Diese Betriebsanleitungen

 

 sehen deutlich ansprechender aus als diese Betriebsanleitungen.

 

Die Norm IEC/IEEE 82079-1:2019 wurde hinsichtlich der Auswahl des Mediums und des Formats der Nutzungsinformationen gelockert. Diese sollten auf Grundlage der Bedürfnisse der Zielgruppe ausgewählt werden.

Es ist darüber hinaus wichtig, dass bei der Auswahl des Mediums die Betriebsbedingungen beachtet werden.

So sollte das Medium beispielsweise bei schlechten Lichtverhältnissen den Text ausleuchten und in lauten Umgebungen sollte keine Sprachausgabe genutzt werden. In feuchten Umgebungen oder Reinräumen sollte kein Papier verwendet werden.

Man ist sich grundsätzlich einig und in vielen Fällen ist es auch verpflichtend, dass Betriebsanleitungen (mindestens die Sicherheitshinweise) in Papierform vorliegen müssen.

Halten Sie sich an Designregeln für eine klare Darstellung ihrer Betriebsanleitung

Folgendes gilt es zu beachten, wenn Sie Ihre Betriebsanleitung formatieren und entwerfen:

  • Gestalten Sie Seiten mit druckfähigen Informationen so, dass sie gut lesbar sind.
  • Achten Sie darauf, dass herunterladbare Informationen auf gängigen Geräten angezeigt werden können.
  • Achten Sie darauf, dass herunterladbare Informationen auf gängigen Geräten angezeigt werden können.
  • Maximieren Sie den Helligkeitskontrast.
  • Achten Sie darauf, dass graphische Symbole den internationalen Normen entsprechen.
  • Es werden eindeutige Illustrationen verwendet, um den Text zu ergänzen.
  • Tabellen sind übersichtlich, informativ und einheitlich aufgebaut.
  • Farben werden nur verwendet, um auf bestimmte Informationsbereiche aufmerksam zu machen.
  • Symbole sind klar und werden eindeutig verwendet.

Verwenden Sie Farben, um auf etwas aufmerksam zu machen. 

Lassen Sie viel unbeschriebenen Freiraum.

Verwenden Sie eine klare, lesbare und serifenlose Schrift. Achten Sie darauf, dass die Schriftgröße auf das Publikum zugeschnitten ist. Verwenden Sie nicht zu viele verschiedene Schriftgrößen.

Setzen Sie Fett-, Kursiv- oder Courierschrift für Terminologie, Referenzangaben oder Input ein.

Installationsanleitung

Verwendung von Fettschreibung, um auf Maschinenteile hinzuweisen.

Designregeln Anleitung

Andere Abschnitte werden kursiv geschrieben.

Verschiedene Schriftschnitte können, sparsam eingesetzt, wichtige Stellen im Text hervorheben.

Setzen Sie Farbe gegebenenfalls konsistent und gemäß anzuwendender Standards ein.

Farben in einer Betriebsanleitung

Verwenden Sie für jede Seite ein konsistentes Layout.

Fazit

Nun, es gibt viel darüber zu erzählen, wie eine Betriebsanleitung für Maschinen erstellt werden sollte. Und ich habe nur die wichtigsten Themen angesprochen!

Wenn Sie eine wirklich herausragende Betriebsanleitung erstellen möchten, werden Sie viel üben müssen.

Oder wie es Malcolm Gladwell in seinem Buch „Überflieger“ beschreibt: es braucht 10.000 Stunden, bis man in einer Kompetenz meisterlich ist.

Ich hoffe, dass ich Ihnen mit dieser Zusammenfassung auf Grundlage meiner Ansichten zum Schreiben guter Betriebsanleitungen ein wenig hilfreichen Input geben konnte.

Wenn Sie sich an diese Tipps halten und sich die zur Verfügung gestellten Beispiele anschauen, bekommen Sie, wie ich hoffe, ein besseres Verständnis von der Erstellung von Betriebsanleitungen.

Also, machen Sie sich ans Werk und erstellen Sie großartige Anleitungen!

Wenn Sie diesen Beitrag als hilfreich empfinden, würde ich mich freuen, wenn Sie mir unten einen Kommentar hinterlassen.

   

Ferry Vermeulen ist Experte für technische Kommunikation und Geschäftsführer von INSTRKTIV GmbH. Ferry hat es sich zur Aufgabe gemacht, digitale Benutzeranleitungen für alle Produkte der Welt zu erstellen. Hören Sie sich den INSTRKTIV-Podcast auf Spotify an oder lesen Sie einen seiner letzten Blogartikel

Xing I Spotify I YouTube I Facebook I Twitter

MÖCHTEN SIE EINE VORLAGE FÜR EINE BETRIEBSANLEITUNG NUTZEN, DIE BEREITS ALLE RECHTLICHEN ASPEKTE ENTHÄLT?

Nehmen Sie den schnellsten Weg zu einer konformen Anleitung. Wir haben Vorlagen (in deutscher Sprache) für Betriebsanleitungen für Maschinen entwickelt, die bereits alle rechtlichen Inhalte beinhalten. 

HIER BESTELLEN!