Überspringen zu Hauptinhalt

Betriebsanleitung erstellen - Technische Dokumentation im Maschinenbau und Anlagenbau

Das Erstellen der Betriebsanleitung steht in engem Zusammenhang mit der technische Dokumentation im Maschinen- und Anlagenbau. Denn jedes Produkt und dessen technische Dokumentation ist nur mit einer Betriebsanleitung vollständig.

Die bereitgestellten Dokumente zum Produkt, zur Maschine oder Anlage sollen gut verständlich und haftungssicher sein – ein schwieriges Unterfangen, wenn in der eigenen Firma das Know-How hierzu fehlt. Darum suchen Projektleiter und Geschäftsführer oft nach geeigneten technischen Redakteuren oder Dienstleistungen, die diese Herausforderung annehmen.

Wir erklären Ihnen, wie Sie eine Betriebsanleitung erstellen und damit die Grundlagen für eine haftungssichere technische Dokumentation schaffen.

Das E-Book „Betriebsanleitung erstellen“ erhalten Sie nur bei uns: Ein praktischer Leitfaden inklusive Musteranleitung für das Erstellen einer hochwertigen Betriebsanleitung.

Wofür braucht es die Betriebsanleitung?

Mit der Betriebsanleitung werden alle Lebensphasen der Maschine inkl. dem Aufbau, Transport und der Entsorgung beschrieben. Die Betriebsanleitung ist ein unverzichtbarer Teil des Produktes, dient dem Kunden zur Erklärung der Maschine oder Anlage und weist auf wichtige Gefahren & Risiken hin.

Die Erstellung der Betriebsanleitung ist damit der wichtige letzte Schritt der Maßnahmen, die zu einer Verringerung von Risiken an der Maschine beitragen. An erster Stelle steht zunächst die sichere Konstruktion des Produkts, der Maschine oder Anlage und die dazugehörige Erstellung der Risikobeurteilung. Darin werden nicht nur alle Risiken aufgeführt, die mittels technischer Schutzmaßnahmen behoben werden, sondern auch alle verbleibenden Restrisiken.

An diesem Punkt helfen auch konstruktionsspezifische Maßnahmen nicht weiter, sodass zur Verringerung der Gefahren als letztes Mittel die Benutzerinformationen und die Betriebsanleitung genutzt werden, in der alle wichtigen Warnhinweise und Restrisiken an der Maschine aufgeführt sind.

Was muss eine Betriebsanleitung beinhalten und wie wird sie erstellt?

Die Inhalte der Betriebsanleitung sind bspw. durch die Norm IEC/IEEE 82079–1 (Erstellen von Nutzerinformationen) und durch verschiedene Richtlinien geregelt, deren Gültigkeit abhängig gegenüber der Art des Produkts ist. Zu diesen Richtlinien zählen u.a.:

  • Die Maschinenrichtlinie
  • Die EMV-Richtlinie
  • Die Niederspannungsrichtlinie

Die Einhaltung der Normen und Richtlinien ist notwendig für ein erfolgreiches Konformitätsbewertungsverfahren und die damit verbundene rechtmäßige Anbringung der CE-Kennzeichnung.

Erstellt der Redakteur dann die Betriebsanleitung, steht er im engen Kontakt mit den Konstrukteuren und hat das Produkt bestenfalls vorliegen oder besichtigt die Maschine oder Anlage gleich vor Ort. So sammelt er alle wichtigen Informationen zum bestimmungsgemäßen Gebrauch, dem Aufbau, Transport und der Entsorgung, entsprechenden Bedienhinweisen sowie Restrisiken. Zusätzlich benötigt der technische Redakteur alle Konstruktions- sowie CAD-Daten.

Liegen jetzt alle wichtigen Informationen vor, beginnt der technische Redakteur mit einem Redaktionssystem seiner Wahl die Betriebsanleitung zu erstellen. Für die verschiedensten Sicherheits- und Warnhinweise verwendet der Redakteur hierfür vorhandene Textmodule und Grafiken, welche er ggf. überarbeitet oder anpasst. Schritt für Schritt erstellt der Redakteur so die Betriebsanleitung und übergibt sie anschließend ins Lektorat zur ersten Qualitätskontrolle. Nach den darauffolgenden Arbeiten am Layout und der nochmals abschließenden Qualitätskontrolle (siehe Checkliste „Betriebsanleitung erstellen“) folgt die Abnahme durch und die Auslieferung an den Kunden.

Welche Probleme können beim Erstellen der Betriebsanleitung auftreten?

Die Erstellung einer Betriebsanleitung bringt viele Herausforderungen und Schwierigkeiten mit sich. Die meisten davon sind auf sehr kurzfristige Änderungen am Produkt bzw. der Maschine oder Anlage zurückzuführen. Denn solche Ergänzungen und Änderungen müssen die Redakteure nachträglich sehr aufwendig in die technische Dokumentation einpflegen, damit der Stand der Betriebsanleitung am Ende auch dem Stand der ausgelieferten Maschine oder Anlage entspricht.

Probleme aufgrund fehlender Vorbereitung und Mangel an Informationen

Eine weitere Schwierigkeit kommt hinzu, wenn die Maschine erst ganz am Ende ihrer Entwicklung für die technischen Redakteure zur Besichtigung bereitsteht. Nur bei Begutachtung des fertigen vorliegenden Produkts kann der Redakteur alle wichtigen Informationen sammeln, die er beim Erstellen der Betriebsanleitung benötigt. Eine fertige Dokumentation mitsamt Übersetzung können wir somit nur in absoluten Ausnahmefällen an Tag 1 der fertig entwickelten Maschine oder Anlage liefern.

Hinzu kommt in solchen Fällen, dass auch die Risikobeurteilung erst noch erstellt werden muss. Diese ist allerdings für eine vollständige, haftungssichere Dokumentation und die Erstellung der Betriebsanleitung unverzichtbar.

Probleme bezüglich Zielgruppe, Zielmarkt und Zielland

Zuletzt offenbaren sich beim Erstellen der Betriebsanleitung viele Schwierigkeiten bei der Definition der Zielgruppe und des Zielmarkts. Je nachdem, über welches (Nicht-)Wissen der Benutzer eines Produkts bzw. einer Maschine oder Anlage verfügt, benötigt er unterschiedliche Hinweise zur Bedienung, Wartung, Installation oder Montage. Eine Fachkraft hat logischerweise einen anderen Wissensstand als ein Laie, der zum ersten Mal ein Produkt nutzt oder bedient. Der Maschinenbediener wird zudem nur Informationen zur Bedienung benötigen, während der Monteur weitgehende Informationen zur Montage oder Wartung benötigt.

Bevor Sie also eine Betriebsanleitung erstellen oder erstellen lassen, müssen Sie diese wichtigen Informationen zur Zielgruppe und dem Zielmarkt sammeln. Zusätzlich müssen Sie beim Export in andere Länder beachten, dass Sie nicht nur eine Übersetzung der Betriebsanleitung mitliefern, sondern diese auch unter Berücksichtigung der spezifischen Normen, Richtlinien und Gesetze des Ziellands erstellen (z.B. ANSI für die USA).

Was ist das richtige Vorgehen beim Erstellen der Betriebsanleitung?

Ein systematisches Vorgehen bei der Erstellung der Betriebsanleitung merzt viele der erwähnten Probleme aus und ist Garant für dessen Haftungssicherheit. Der technische Redakteur sammelt schon während der Entwurfsphase der Maschine oder Anlage relevante Informationen bspw. zur Zielgruppe, Normen und Richtlinien. Außerdem erstellt er einen Zeitplan für das weitere Vorgehen. Stehen in dieser frühen Phase hierzu noch die Struktur der Betriebsanleitung oder die ein oder andere konkrete Benutzerinformation fest, kann er diese bereits in einem Redaktionssystem verarbeiten bzw. eine entsprechende Word-, Framemaker- oder Indesign-Datei anlegen.

Für den weiteren reibungslosen Ablauf sollten auch Sie aktiv sein und in Ihren Projektplänen zur Maschine oder Anlage festlegen, wann alle Informationen für die Betriebsanleitung zur Verfügung stehen. In diesen Planungen sollten Sie außerdem die nötige Zeit für die Lektorierung und eine mögliche Übersetzung der Dokumente berücksichtigen. Hat die Maschine oder Anlage weitestgehend ihren endgültigen Stand erreicht, kann der Redakteur ohne Umwege die Betriebsanleitung fertigstellen. Nachträglich dürfen dann am Produkt keine Änderungen mehr durchgeführt werden. Falls aber doch nochmals Änderungen anfallen, müssen Sie diese gut dokumentieren und wiederum den technischen Redakteur darüber in Kenntnis setzen.

In seltenen Fällen ist es sogar durchaus sinnvoll, dass Sie nur eine vorläufige technische Dokumentation ausliefern, bspw. wenn bei der Montage beim Kunden noch Änderungen anfallen könnten. Diese können dann noch gut dokumentiert, in die Betriebsanleitung integriert und anschließend dem Kunden vollständig übergeben werden.

Die Zusammenarbeit mit einem Dienstleister in der technischen Dokumentation

Wenn Ihnen das unternehmensinterne Knowhow für die technische Dokumentation fehlt, führt kein Weg an einem externen Dienstleister vorbei. Das hat den Vorteil, dass Sie damit auf technische Redakteure vertrauen können, die stets auf dem aktuellsten Stand der Normen und Richtlinien sind. Dabei müssen Sie nur wenige Dinge beachten, damit Sie die idealen Voraussetzungen für eine Zusammenarbeit schaffen. Zuallererst steht und fällt die Qualität der technischen Dokumentation mit der Kommunikation: Eine gute Zusammenarbeit aller Ansprechpartner erleichtert die Arbeitsprozesse, die es für die Erstellung einer Betriebsanleitung braucht.

Zusätzlich sollten Sie gemeinsam einen redaktionellen Leitfaden erarbeiten. Dieser erhöht die Qualität, reduziert Rückfragen sowie Korrekturen und vereinheitlicht die Struktur der Betriebsanleitung. Das Lektorat sollten Sie ebenfalls extern durchführen lassen, selbst wenn Sie intern die Kapazitäten hierfür hätten. Durch ein externes Lektorat wird ggf.  Betriebsblindheit vorgebeugt und eine hohe Qualität Ihrer technischen Dokumentation gewährleistet. Die Fertigstellung der Betriebsanleitung sollten die beauftragten Redakteure dann natürlich wieder in Abstimmung mit Ihnen vollziehen. Ist im weiteren Prozess noch ein Übersetzungsdienstleister involviert, sollten Sie zudem den Kontakt zwischen den Redakteuren und Übersetzern herstellen. Wenn Sie diese Schritte berücksichtigen, erhalten Sie am Ende eine hochwertige technische Dokumentation.

Das E-Book „Technische Dokumentation: Die wichtigsten 200 Fragen und Antworten“ erhalten Sie nur bei uns. Es enthält unser geballtes Wissen zur technischen Dokumentation.

Welche Schwierigkeiten entstehen durch die Übersetzung der haftungssicheren technische Dokumentation - Betriebsanleitung?

  • Kooperation und Abstimmung zwischen Maschinenhersteller und Übersetzungsdienstleister ist nicht ausreichend (Terminologie, Erklärung Vorort an der Maschine oder anhand eines Videos fehlen)
  • Keine Durchführung der Korrekturstufe/Lektorat
  • Abstimmung zwischen Übersetzer und Lektor nicht möglich/Vorübersetzungen führen zu Inkonsistenzen und unpassenden Textpassagen bei „haftungssichere technische Dokumentation / Betriebsanleitung erstellen“
  • Bereits übersetzte, fehlerhafte Texte sind im Translation Memory gespeichert und finden erneut Verwendung, da die fehlerhaften Texte immer wieder in den Vorschlägen auftauchen und nicht entfernt werden
  • Für das Translation Memory System ungeeignete Arbeitsweise in InDesign, Word oder Redaktionssystem (bspw. Verwendung von Leerzeichen für Einrückungen)
  • Wenn kein Translation Memory Anwendung findet, kann es zu Übersetzungswiederholungen der gleichen Textpassagen kommen
  • Titelseite, beim Betriebsanleitung erstellen sollten folgende Informationen auf der Titelseite stehen, um möglichst schnell und einfach dem Nutzer über die Produktbezeichnung, Produkttyp, Baujahr und weitere Merkmale zum Produkt, Maschine oder Anlage sowie die Version zu informieren
  • Impressum, beim Betriebsanleitung erstellen gibt es hier wichtige rechtliche Informationen welche im Impressum enthalten sein sollen, z.B. Copyright Informationen, Ausschlussklauseln bezüglich Vervielfältigungen, Bildverweise das diese nur als Beispiel dienen und nicht maßstabsgetreu sind
  • Erstes Kapitel, beim Betriebsanleitung erstellen ist für die Orientierung gedacht, es vermittelt einen kurzen Überblick für welchen Zweck die Anleitung geschrieben wurde sowie für welche Zielgruppe, zusätzlich werden die allgemeinen Symbole erläutert
  • Typenschild, beim Betriebsanleitung erstellen muss auf dem Typenschild, welches auch in der Anleitung abgebildet wird, der Hersteller, Bezeichnung der Maschine/Typ/Baureihe/Serie Nummer/Baujahr und CE-Kennzeichnung angebracht werden. In der Betriebsanleitung ist es sinnvoll den Ort des Typenschildes zu benennen oder abzubilden um dieses schnell bei Bedarf finden zu können
  • Aufstellen einer Maschine/Anlage, beim Betriebsanleitung erstellen muss ein Aufstellplan/Lageplan sowie Informationen über das Fundament, Ort und auch wer diese aufstellen darf benannt werden. Es ist z:B. möglich das hier nur Fachkräfte die Aufstellung durchführen dürfen oder eben der Kunde dies auch selber durchführen dar.
  • Tragekräfte Transport Maschine/Anlage, beim Erstellen der Betriebsanleitung ist es besonders wichtig das über die Gefahren beim Aufstellen einer Maschine (schwebende Lasten) hingewiesen wird. Angaben zu Tragekräften, die Leistung des Gabelstaplers oder auch Krans müssen definiert sein.
  • Lagerbedingungen einer Maschine, Anlage, beim Betriebsanleitung erstellen muss nicht nur der Untergrund und die Festigkeit beschrieben werden sondern auch die Luftfeuchte, Temperatur, Schutz vor Regen, Schnee, Eis beschrieben werden. Kann die Maschine draußen oder nur in einem Raum aufbewahrt werden, auch die Lagerung in einem Container muss bezüglich des hohen Salzgehaltes der Luft bedacht werden.
  • Vorhersehbarer Fehlgebrauch, beim Betriebsanleitung erstellen muss überlegt werden auf welche Ideen der Nutzer kommen kann um die Maschine/Anlage auch anderweitig zu benutzen (z.B. der Hund in der Mikrowelle, eine Leiter nicht auf einem Schlauchboot im Wasser verwenden). Hier sollten evtl. auch Rückfragen mit dem Service-Zentrum des Herstellers und dem Außendienst stattfinden um Fälle von der Praxis zu erhalten.
  • Zielgruppe, beim Betriebsanleitung erstellen ist es besonders wichtig die Zielgruppe für das Produkt zu kennen bzw. festzulegen. Es ist auch möglich mehrere Zielgruppen zu haben wie z.B. den Anwender, den Monteur, Personal für die Wartung und Instandhaltung, aber auch Kinder, ältere Menschen oder behinderte Menschen müssen je nach Produkt mit bedacht werden. Für die Zielgruppe sollte die Betriebsanleitung passend geschrieben werden.
  • Inbetriebnahme der Maschine, beim Betriebsanleitung erstellen sollten diese wichtigen Informationen alle enthalten sein: Abnahme-, Inspektions- und Betriebstest sowie Prüfungen bevor die Maschine oder Anlage in Betrieb geht. Besonders sollten auch die Sicherheitseinrichtungen und Anschlüsse für einen sicheren Betrieb kontrolliert werden.
  • Reparatur und Austausch, beim Betriebsanleitung erstellen sollten die Teile (Ersatzteile) oder Stoffe sowie die Bezugsquellen benannt werden. Meist ist dieser Bereich für geschultes Wartungspersonal vorgesehen und sollte nicht für jeden Nutzer zugänglich sein. Um Unfälle oder Verletzungen zu vermeiden ist es wichtig die Vorgehensweise beim Austausch oder der Reparatur zu beschreiben und mögliche Gefahren mit Sicherheitshinweisen zu kennzeichnen.
  • Demontage der Maschine/Anlage, beim Betriebsanleitung erstellen muss in einer Betriebsanleitung die richtige Reihenfolge der Demontage z.B. der Anschlüsse sowie damit verbundener Gefahren erläutert werden. Auch die Entsorgung von verbliebenen Flüssigkeiten oder Stoffen muss in der Betriebsanleitung beschrieben werden

Welche Lösungen gibt es bei der Übersetzung der haftungssichere technischen Dokumentation - Betriebsanleitung erstellen?

  • Terminologie vorab festlegen, übersetzen lassen und prüfen damit eine haftungssichere „haftungssichere technische Dokumentation / Betriebsanleitung erstellen“ entsteht
  • Termin mit Übersetzer Vorort an der Maschine machen, um diese zu erklären oder ein Video mit Beschreibung zur Verfügung stellen
  • Lektorat vorab planen und durchführen, z. B. mit einem zweiten Übersetzer oder bei der jeweiligen Niederlassung im Zielland
  • Kontakt ermöglichen zwischen Übersetzer und Lektor, um Rückfragen zu klären
  • Translation Memory von einem professionellen Übersetzungsdienstleister bereinigen lassen
  • Translation Memory sind sinnvolle Tools um Zeit und Geld zu sparen, es sollten die Grenzen eines solchen Tools allerdings im Vorfeld geklärt sein

Sie haben weitere Fragen? Rufen Sie einfach an oder schreiben Sie uns eine E-Mail:

info@gft-akademie.de +49-7836-9567-123

An den Anfang scrollen