Überspringen zu Hauptinhalt

FAQ zur Technischen Dokumentation

Auf dieser Technischen Dokumentation FAQ Seite finden Sie unsere stetig wachsende FAQs zu Dokumentation und Übersetzung mit den häufig gestellten Fragen und Antworten.

Ziel dieser FAQ Seite ist es, fundiertes Wissen zu vermitteln und dadurch Kundennutzen zu schaffen. Gut fundiertes Wissen kann helfen, ein besseres Verständnis zu erlangen.

Haben Sie auf dieser FAQ Seite keine Antwort auf Ihre Fragen gefunden? Sie brauchen Hilfe oder suchen nach weiteren Infos? Kontaktieren Sie uns direkt! Unser GFT Team ist gerne für Sie da.

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

Die Inhalte dieser Seite sind nach bestem Wissen und Kenntnisstand erstellt worden. Viele unserer FAQs basieren auf bei der Veröffentlichung geltenden Gesetzen, Normen und Richtlinien. Normen, Richtlinien und Gesetze verändern sich jedoch im Laufe der Zeit. Daher können auch unsere FAQs veralten und nicht mehr dem aktuellen Stand von Gesetzen, Normen und Richtlinien entsprechen. Die FAQs dienen ausschließlich der generellen Information und ersetzen keine qualifizierte Beratung. Sie stellen keine Beratung juristischer oder anderer Art dar und sollen auch nicht als solche verwendet werden.

Wir übernehmen insbesondere keine Haftung von Handlungen, die auf Grundlage des auf dieser Seite enthaltenen Informationsmaterials unternommen werden. Weitere Informationen zum Haftungsausschluss finden Sie auch in unserem Impressum.

FAQ-Kategorien

Technische Dokumentation (224)

Was versteht man unter technischem Lektorat?

Im Rahmen des Lektorats geht es um die Überprüfung von Texten hinsichtlich der Einhaltung grammatikalischer, rechtschreiblicher und stilistischer Kriterien. Diese Prüfung wird gemeinhin für alle Texte unabhängig von ihrem Inhalt durchgeführt.

Kommen noch fachlich-inhaltliche Prüfkriterien hinzu, spricht man in der technischen Dokumentation vom technischen Lektorat. So wird hier geprüft, ob alle für das jeweilige Informationsprodukt gültigen Normen und Richtlinien eingehalten werden. Hierzu gehören beispielsweise die Prüfung auf Vollständigkeit, Plausibilität und Auszeichnung von Sicherheits- und Warnhinweisen, die Prüfung auf zielgruppengerechte Verständlichkeit, Dokumentenstruktur und einsatzbezogene Medienverwendung oder auf die Berücksichtigung von Besonderheiten für bestimmte Zielländer hinsichtlich der bildlichen Darstellung, Verständlichkeit, Farben oder allgemeinen Übersetzungskriterien (Lokalisierung).

Im Rahmen der Plausibilitätskontrolle (auch Plausibilitätsprüfung genannt) wird geprüft ob die technische Dokumentation grundsätzlich nachvollziehbar und damit für die Zielgruppe ausreichend verständlich ist. Dabei ist zu beachten, dass bei dieser Prüfung der rein technische Bereich im technischen Lektorat meist nicht berücksichtigt werden kann und die Prüfung in dieser Hinsicht dann nur geringe oder keine Aussagekraft besitzt.

Die Inhalte für eine Technische Dokumentation für Russland muss ebenfalls relevante Informationen für eine sichere Nutzung des Produktes beinhalten. Ähnlich wie die europäischen Anleitungen gehören dazu Angaben zur Bedienung der Maschine, Informationen über Restrisken, Vorgehensweisen für Montage und Instandsetzung. Eine nach der internationalen Dokumentationsnorm DIN EN IEC/IEEE 82079-1 erstellte Betriebsanleitung deckt all diese Anforderungen ab.

Eine Technische Dokumentation für Russland ist nach den Normen GOST R 54121-2010, GOST R 2.601-2019 und 2.610-2019 zu erstellen. Zu den Inhalten zählen alle wichtigen Angaben über Arbeitsweise, Eigenschaften, Bestandteile, Entsorgung, Transport, Wartung und technischen Zustand einer Maschine. Es ist zudem möglich eine Bedienungsanleitung für mehrere gleichartige Produkte, Typen, Modellen oder Serien zu erstellen.

In der Technischen Dokumentation müssen folgende Informationen mittels des Technischen Pass abgedeckt sein:

  • Basisinformationen über das Produkt, die technischen Eigenschaften und Konformitätsbewertung
  • Komplettierung
  • Lebensdauer und Lagerungsdauer, Garantie des Herstellers
  • Konservierung
  • Hinweise zur Verpackung
  • Hinweise zur Annahme
  • Hinweise zur Ausleihung von Geräten während der Benutzung
  • Hinweise zur Reparatur
  • Hinweise zum Betrieb und Lagerung (falls erforderlich)
  • Angaben zur Entsorgung

Unter den Normen, die einen Technischen Pass für die Technische Dokumentation fordern, gehören die GOST-Normen 2.601-2019 und 2.610-2019. Die GOST-Norm 2.601-2019 trägt den Titel: Einheitliches System der Konstruktions- und Betriebsunterlagen. Die GOST 2.610-2019 hat den Titel: Einheitliches System der Konstruktionsunterlagen.

Der Technische Pass ist ein Dokument, welches in einer Technischen Dokumentation für eine Maschine für das Bestimmungsland Russland nötig ist. Der Technische Pass beinhaltet die wichtigsten technischen Daten der Maschine. Während des gesamten Lebenszyklus einer Maschine muss der technische Pass vorhanden sein.

Bei Weiterverkauf einer Maschine benötigt der nächste Besitzer ebenfalls eine Technische Dokumentation, um die Maschine sicher nutzen zu können. Die Betriebsanleitung ist auch als ein Teil des Produktes anzusehen. Oft finden sich in den Betriebsanleitungen auch Hinweise, dass die Anleitung bei Weiterverkauf an den neuen Besitzer zu übergeben ist.

Es empfiehlt sich neu entwickelte Piktogramme mit textlichen Informationen in der Technischen Dokumentation zu erläutern. Ebenfalls ist eine Kombination von Text und Piktogramm auf dem Warnschild am Produkt denkbar, damit die Benutzer sich an das neue Piktogramm schneller gewöhnen. Um das neu entwickelte Piktogramme am Markt zu etablieren, empfiehlt es sich dieses einem Normenausschuss wie beispielsweise DIN einzureichen.

Vorgaben für neue Piktogramme für die Technische Dokumentation sind in den Normen ISO 3864-1 und ISO 3864-3 zu finden. Die Normen geben Gestaltungskriterien vor hinsichtlich:

  • Geometrische Form
  • Farbe
  • Größe und Position des Symbols
  • Freizubleibende Bereiche
  • Linienbreite
  • Einheitlichkeit
  • Determinanten (Teilsymbole)
  • Kombinationen
  • Pfeile
  • Schrift

Auch die Darstellung von Menschen auf Sicherheitszeichen behandeln die Normen. Ansichten sowie die Animationen sind durch die Normen geregelt. Auch ist zu prüfen, ob das neue Zeichen nicht dieselbe Aussage vermittelt wie ein bereits bekanntes Piktogramm der ISO 7010. Dann ist nämlich das genormte Piktogramm zu wählen.

Benötigen Hersteller für Ihre Technische Dokumentation spezielle Sicherheitszeichen, ist es auch möglich diese selbst zu entwerfen. Der umfangreiche Symbolkatalog der DIN EN ISO 7010 deckt jedoch die meisten Gefahrensituationen ab. Ist kein Piktogramm durch eine Norm definiert, kann der Hersteller auch eigene Piktogramme nach den Vorgaben der ISO 3864 erstellen.

Es ist nicht erforderlich eine Angabe des Baujahres einer Maschine in der Technischen Dokumentation anzugeben. Solch eine Angabe in der Anleitung kann aber hilfreich sein, falls die Angabe auf dem Typenschild nicht mehr lesbar ist. Der Hersteller kann dann über die Angabe in der Technischen Dokumentation leichter den Maschinentyp bestimmen. Dies erleichtert dem Hersteller ein Ersatz für das nicht mehr lesbare Typenschild bereitzustellen.

Der Begriff Animation hat seinen Ursprung im lateinischen animare (zum Leben erwecken). Sollen beispielsweise bestimmte Prozesse oder Funktionsabläufe in Maschinen oder Anlagen erklärt werden, stößt man mit einer rein textlichen Form schnell an Grenzen. Eine Visualisierung der Vorgänge bietet hierbei wertvolle Hilfe.

Mit einer spezialisierten Software werden aus – meist bereits vorhandenen – technischen Zeichnungen die erforderlichen Komponenten extrahiert und ihre jeweiligen Bewegungsparameter in sog. Schlüsselbildern (Keyframes) festgelegt. Die Software errechnet und generiert anhand dieser Vorgaben fließende Bewegungsabläufe.

Je nach Ausgangsmaterial und Animationsaufwand entstehen so zwei- oder dreidimensionale filmähnliche Sequenzen, welche anschließend beispielsweise in eine Website oder ein PDF-Dokument integriert werden können.

Digitale Anleitungen lassen sich prinzipiell in nahezu jedem elektronischen Format erstellen. Bei der Formatauswahl sind in erster Linie Parameter wie beispielsweise die Nutzungsumgebung, die Medienkompetenz der Benutzergruppe oder die beim Nutzer vorhandenen technischen Voraussetzungen zu berücksichtigen.

Im Sinne einer effizienten Produktion ist darauf zu achten, dass sich die textlichen Inhalte möglichst aus einem Redaktionssystem generieren lassen. Derzeit werden digitale Anleitungen überwiegend als PDF-Dateien sowie Online-Hilfen (Websites / WebApps) publiziert. Enthalten sind dabei meist auch multimediale Inhalte wie 2D/3D-Animationen, Videoclips oder Audiokomponenten.


An Bedeutung gewinnen in zunehmendem Maße bereits im Gerät implementierte Benutzerführungen, Wartungsanleitungen (sogar ausführbare Wartungsroutinen) sowie Virtuelle Realität (VR) und Erweiterte Realität (Augmented Reality).

Gegenüber einer gedruckten Anleitung bieten digitale Anleitungen eine Vielzahl an Vorzügen, z. B.:

Einbindung multimedialer Komponenten

Textpassagen lassen sich mit audiovisuellen Inhalten ergänzen, was zu einer deutlich verbesserten Informationsverarbeitung beim Nutzer führt. Wo praktikabel, kann ggfs. durch entsprechend erstellte multimediale Inhalte auf Anleitungstext vollständig verzichtet werden (Einsparung von Übersetzungskosten)


Mobile Verfügbarkeit

Digitale Anleitungen sind über Endgeräte wie beispielsweise Smartphones oder Tablet-PC von jedem Standort aus abrufbar. Dies kann beispielsweise für Servicetechniker im Auslandseinsatz bei fehlenden technischen (gedruckten) Unterlagen von besonderer Bedeutung sein.


Schnelle Aktualisierbarkeit

Notwendige Änderungen im Informationsprodukt (z. B. aufgrund von Produktänderungen oder Fehlern im Dokument selbst) sind in kurzer Zeit durchgeführt und stehen bei Verteilung über das Internet „in Echtzeit“ zur Verfügung


Platzsparend

Auf einem digitalen Endgerät lassen sich eine Vielzahl von Betriebsanleitungen, Servicehandbüchern, etc. ablegen. Ein Servicetechniker braucht somit keine umfangreiche Sammlung von gedruckten Ausgaben mitzuführen. Vor Ort nicht vorhandene Informationsprodukte können bei Bedarf per E-Mail oder im Download kurzfristig vom Hersteller bezogen werden.


Eingebettete Benutzerführung

Produktabhängig lassen sich Informationen zur Bedienung oder Wartung auch im Gerät implementieren und dem Benutzer über Schnittstellen wie Bildschirm oder Klein-Display zur Verfügung stellen.


Kostensenkung

Wo durch Normen/Gesetzgebung erlaubt, lassen sich durch die Publikation digitaler Anleitungen Druck- und möglicherweise auch Verteilkosten (z. B. bei notwendigen Aktualisierungen durch Produktänderung oder Fehlern in der Anleitung) sparen. Dort wo gedruckte Anleitungen vorgeschrieben sind, lassen sich durch Einsatz eines geeigneten Redaktionssystems entsprechende Inhalte für die Erstellung der digitalen Formate wiederverwenden (Beispiel: Export in HTML zur Einbindung in eine WebApp / eine Website)


Interaktionsmöglichkeit des Benutzers

Sie ermöglicht den effektiven und gezielten Abruf benötigter Informationen durch entsprechend gestaltete Navigationselemente, Suchfunktion, Steuerung der Informationsausgabe oder die Verknüpfung mit weiteren Quellen (Datenbanken, etc.)


Messbarkeit

Wie bei der Auswertung von Zugriffen auf Websites, lassen sich auch die Zugriffe auf Online-Anleitungen auswerten. Hiermit stehen dann Informationen über die Nutzung der Online-Dokumente zur Verfügung (welche Seiten werden wie oft aufgerufen, wie lange verweilt der Benutzer auf einer bestimmten Seite, wie oft wird ein bestimmtes Video abgerufen, etc.). Die so gewonnenen Daten lassen sich ggfs. zur Überarbeitung/Verbesserung eines Dokumentes bzw. bei einer Neuanlage heranziehen.

Anforderungen zur Technischen Dokumentation von Sicherheitsbezogene Teile von Steuerungen stehen in der DIN EN ISO 13849-1:2016-06. Im Kapitel 10 stehen die Anforderungen an die Technische Dokumentation. Unter Kapitel 11 finden sich Informationen zu den Benutzerinformationen.

Das Projektmanagement für die Erstellung einer Technischen Dokumentation besteht im Wesentlichen aus den folgenden vier Hauptschritten:

1. Das Definieren und priorisieren von Anforderungen, welche die Technische Dokumentation einhalten muss.

2. Erstellen der Arbeitspakete und Priorisierung bei der Abarbeitung der Pakete

3. Überprüfen der Ergebnisse aus den Arbeitspaketen

4. Präsentation bzw. Demonstration der Technischen Dokumentation

Die Einhaltung von Terminologie in der Technischen Dokumentation ist immer wichtig, um ein mögliches Begriffschaos vermeiden.

Zum einen ist Terminologie sinnvoll, um verschiedene Dinge nicht beim gleichen Namen zu nennen. Eine Unterlegscheibe ist etwas anderes wie eine Fensterscheibe. Dabei nur den Oberbegriff Scheibe zu verwenden, kann für Unstimmigkeiten sorgen.

Auf der anderen Seite ist es nicht ratsam unterschiedliche Begriffe für gleiche Sachen zu verwenden. Beispielsweise die Steuerkonsole und das Bedienfeld, was ein und dieselbe Sache sind. Unterschiedliche Benennungen für dieselbe Komponente bzw. Bauteil verwirren den Leser der Technischen Dokumentation.

Die Technische Dokumentation muss dem Produkt zuordbar sein. Eine Namensänderung des Produktes muss dann für die neu in Verkehr gebrachten Produkten auch in der Anleitung erfolgen. Eine Nachbesserung für bereits im Markt befindliche Dokumente ist hingegen nicht nötig.

Es gibt keine Pflicht, dass eine Technische Dokumentation nur aus einem Dokument bestehen darf. Ob die Anleitung daher aus einem oder mehreren Dokumenten besteht, bleibt dem Verfasser überlassen.

Es kann sinnvoll sein, die Technische Dokumentation nach den jeweiligen Zielgruppen aufzuteilen. Dem Wartungspersonal genügt ein Wartungshandbuch mit allen benötigen Informationen für die Wartung. Das Bedienpersonal reicht die Bedienungsanleitung, die alle Informationen zur Bedienung des Produktes enthält. Der Verfasser muss nur sicherstellen, dass es den Lesern klar ist, dass es mehrere Dokumente zu verschiedenen Themen gibt. Zum Beispiel durch ein Kapitel „mitgeltende Dokumente“.

Eine Technische Dokumentation ohne oder mit nur wenigen Abbildungen ist selten verständlich. Trotzdem finden sich genügend Anleitungen mit nur wenigen Abbildungen. Gründe sind vermutlich die zeitintensive und kostenaufwendige Erstellung und Aufbereitung von Abbildungen. Die vorhandenen Abbildungen vom Produkt sind zudem auch meistens unzureichend in der Qualität. Häufig fehlt es im Unternehmen an Fotografen bzw. Illustratoren und externe Leistungen verursachen hohe Kosten.

Um Kosten bei der Technischen Dokumentation zu sparen, sind wiederverwendbare Grafiken eine gute Möglichkeit. Der Änderungsaufwand für solche Abbildungen ist minimal, da meisten nur Positionsnummer oder Symbole zu tauschen sind. Richtig aufbereitete Grafiken lassen sich in verschiedenen Kapiteln bzw. Dokumenten einsetzten. Beispiele hierfür sind wiederkehrende Bedienelemente wie der Hauptschalter oder die Not-Aus-Taste. Oder abstrakte Zeichnungen vom Transport des Produktes, indem nur Quadrate bzw. Rechtecke ein Schema für die Befestigungspunkte liefern.

Ein Lektor für eine Technische Dokumentation sollte sich an folgende Qualitätskriterien halten:

  • Übersichtlichkeit: Sind die Informationen übersichtlich dargestellt?
  • Vollständigkeit: Fehlen auch keine Informationen?
  • Verständlichkeit: Sind die vorhanden Informationen verständlich?
  • Nachvollziehbarkeit: Ist der Informationsgehalt nachvollziehbar?
  • Korrektheit: Sind Informationen fachlich korrekt?
  • Minimalismus: Wiederholen sich bekannte Informationen?

Ein Lektorat bei einer Technischen Dokumentation ist ein wichtiges Qualitätskriterium. Es ist wichtig die fertige Anleitung von einem zweiten Technischen Redakteur prüfen zu lassen. Ganz nach dem Prinzip „4 Augen sehen mehr wie zwei“ ist es möglich so erst übersehene Fehler doch noch zu erkennen und zu beheben.

Aspekte für die Qualitätssicherung einer Technischen Dokumentation erfolgen nach dem bekannten PDCA-Zyklus.

P (Plan) = Planen

D (Do) = Umsetzen

C (Check) = Prüfen

A (Act) = Handeln

Zuerst sind in der Planungsphase Konzepte für die Technische Dokumentation zu entwickeln und zu testen. In der Phase des Umsetzen entsteht die Technische Dokumentation. In der Check-Phase gilt es die erstellte Technische Dokumentation zu testen und neue Standards zu definieren. In der Act-Phase gilt es die Technische Dokumentation zu optimieren.

Unter den Produktspezifikationen versteht man die technischen und funktionalen Aspekte eines Produktes seitens eines Herstellers oder Verbrauchers. Dazu gehören auch technische Daten, geometrische Ausmaße und die Zusammensetzungen von Betriebsstoffen. Die Produktspezifikationen sind in der Technischen Dokumentation abgebildet und sind auch für sicherheitsrelevante Hinweise relevant. Beispielsweise die geometrischen Ausmaße, um den Platzbedarf für das Produkt zu ermitteln.

Der Informationsbedarf den eine Technische Dokumentation abdecken muss, hängt von der jeweiligen Zielgruppe ab. Die Zielgruppen unterscheiden sich durch typische Merkmale. Diese können das Alter, die berufliche Bildung oder andere verhaltensorientierte Merkmale sein. Auch Psychologischen Merkmale wie Motivation, Meinungen oder Wünsche der Zielgruppe können Merkmale sein.

In der Technischen Dokumentation kommt eine Was-macht-wer-Matrix bei der Definition der Zielgruppe zum Einsatz. Diese Matrix bildet Handlungsorientiert ab, welche Personen welche Handlungen mit dem Produkt durchführen und welches Wissen dafür vorauszusetzen ist. Der Redakteur, welcher die Technische Dokumentation erstellt, kann mit Hilfe der Matrix die Eigenschaften der Zielgruppe darstellen.

Für Geräte, die unter die EMV-Richtlinie fallen, müssen Informationen zur Nutzung des Gerätes in einer Betriebsanleitung enthalten sein. Dazu zählen unter anderem Angaben über Vorkehrungen, die bei Montage, Installation, Betrieb oder Wartung des Gerätes zu treffen sind.

Sinnvollerweise erscheinen in der Technischen Dokumentation die Inhaltspunkte in der Reihenfolge entsprechend dem Lebenszyklus der Maschine. Demnach beginnt eine Betriebsanleitung nach den allgemeinen Hinweisen mit Installation und Inbetriebnahme, geht dann vom Normalbetrieb über andere Lebensphasen wie Wartung, Reparatur, Störungsbehebung und endet mit Außerbetriebnahme, Demontage und Fragen der Entsorgung und Verschrottung.

Die digitale Technische Dokumentation bietet einige Vorteile in der Navigation. So ist das Auffinden von Informationen im digitalen Dokument durch Suchfunktionen viel einfacher als auf der Papierfassung. Relevante Informationen wie Sicherheitshinweise lassen sich schnell in einer pdf-Datei mit entsprechenden Stichworten finden.

Gibt es beim Kauf einer Maschine zwischen dem Hersteller und dem Käufer keine vertragliche Vereinbarung über die Erstellung der Technische Dokumentation, so zählt die üblich zu erwartende Beschaffenheit. Dieser Begriff aus dem Produktrecht besagt, dass ein Produkt über solche Eigenschaften verfügen muss, die bei einer vergleichbaren Sache üblich ist und vom Käufer zu erwarten ist. Ist beispielsweise zwischen den beiden Vertragsparteien nichts wegen der Erstellung der Technischen Dokumentation vertraglich vereinbart, so muss diese nach den üblich zu erwartenden Normen erstellt sein. Im Falle einer Maschine wären das die Normen DIN EN ISO 20607 für die Betriebsanleitung einer Maschine sowie die Horizontalnorm IEC/IEEE 82079-1 für das Erstellen von Nutzungsinformationen.

In der Technischen Dokumentation müssen nur relevante Informationen vorkommen. Die Nutzugsinformationen müssen für den gesamten Produktlebenszyklus alle durchzuführenden und erlaubten Tätigkeiten abdecken. Ebenfalls müssen sicherheitsrelevante Informationen zu den jeweiligen Lebensphasen vorliegen. Deckt ein Produkt aufgrund seiner Eigenschaften bestimmte Lebensphasen nicht ab, so müssen in den Nutzugsinformationen auch keine Informationen darüber vorkommen. Beispielsweise wenn ein Produkt nur in einem anderen Produkt zum Einsatz kommt und keinen eigenständigen Betrieb aufweist. Gibt es in dieser Lebensphase auch keine sicherheitsrelevanten Informationen dem Benutzer mitzuteilen, kann diese Lebensphase in den Nutzungsinformationen entfallen.

Rudimentäre Vorgaben für die Technische Dokumentation finden sich in der IEC/IEEE 82079-1. Diese Horizontalnorm gilt für alle Arten von Produkten. Daneben gibt es noch weitere produkt- oder branchenspezifische Normen. Bei Medizinprodukten liefert die EN ISO 20417 detaillierte Anforderungen für die Nutzungsinformationen und dient als sinnvolle Erweiterung zur Horizontalnorm IEC/IEEE 82079-1.

Warnungen vor Restrisiken in der Technischen Dokumentation beginnen nach dem SAFE-Prinzip mit einem Signalwort. Die Norm IEC/IEEE 82079-1 schlägt dabei eine Vorgehensweise aus der ANSI Z535.6 vor, um das richtige Signalwort auszuwählen:

Signalwörter Auswahlprozess

Die IEC/IEEE 82079-1 fordert für Warnhinweise in Technische Dokumentationen eine entsprechende Gestaltung, damit diese entsprechend auffallen. Durch eine Kopfzeile kann das einleitende Signalwort in einer anderen Schriftgröße oder Schriftart hervorgehoben werden. Sind Warnhinweise zwischen Handlungsschritten eingebettet, sollte die Formatierung des Warnhinweises nicht die Nutzer von den Handlungsschritten ablenken.

Die Technische Dokumentation ist Teil des Produktes, daher gilt es die Kosten für die Erstellung in die Produktentwicklung mit einzurechnen.

Umso komplexer ein Produkt, desto umfangreicher ist natürlich auch die Technische Dokumentation. Gewisse Mindestinhalte müssen in jeder Dokumentation vorhanden sein. Daher umfasst ein Dokument erfahrungsgemäß schnell mal mindestens 40 Seiten Umfang in einer Sprache. Alleine für die Neuerstellung einer A4-Seite können mehrere Stunden Arbeit vergehen. Auch besuchen Technische Redakteure regelmäßig Schulungen und Weiterbildungen, um auf einem aktuellen Wissenstand zu bleiben.

Schnell kommen dort einige Kosten zusammen. Der Alltag ist jedoch, dass die Kosten für die Technische Dokumentation viel zu niedrig angesetzt sind. Unerfahrene Unternehmen rechnen mit Kosten unter 1.000 Euro für die Erstellung der Dokumentation. Dies ist natürlich komplett unrealistisch, wenn man bedenkt wie viel Zeit die Erstellung einer Anleitung benötigt. Wenn wir nun die Kosten für einen Technischen Redakteur betrachten und wieviel Zeit in einer Technischen Dokumentation steckt, landen wir schnell in einem Kostenbereich von 6.000 – 10.000 Euro. Weitere Nebenkosten wie Softwarelizenzen, Anschaffung von Normen oder ähnlichem sind dabei noch nicht mal berücksichtigt.

Für Lastaufnahmemittel schreibt die Maschinenrichtlinie in Bezug auf die Technische Dokumentation bzw. Betriebsanleitung im Anhang I folgendes vor:

“4.4.1 Lastaufnahmemittel

Jedem Lastaufnahmemittel und jeder nur als Ganzes erhältlichen Gesamtheit von Lastaufnahmemitteln muss eine Betriebsanleitung beiliegen, die mindestens folgende Angaben enthält:
a) bestimmungsgemäße Verwendung;

b) Einsatzbeschränkungen (insbesondere bei Lastaufnahmemitteln wie Magnet- und Sauggreifern, die die Anforderungen der Nummer 4.1.2.6 Buchstabe e nicht vollständig erfüllen);

c) Montage-, Verwendungs- und Wartungshinweise;

d) für die statische Prüfung verwendeter Koeffizient.“

Die Frage wer die Technische Dokumentation liest, ist eine essentielle Frage. Jedoch spielt diese Frage schon vor dem Erstellungsprozess einer Betriebsanleitung eine Rolle. Schon in der Produktentwicklung gilt es zu überlegen, wer das Produkt nutzt. Innerhalb der Risikobeurteilung gilt es sich über die Benutzer des Produktes Gedanken zu machen und eine Zielgruppenanalyse zu erstellen. Folgende Vorgehensweise ist bei einer Zielgruppenanalyse empfehlenswert:

  1. Hypothesen aufstellen, in welcher man aufschreibt wer an der Maschine / dem Produkt was macht. Es empfiehlt sich, diese Hypothesen in Form einer Matrix darzustellen.
  2. Mit Befragungen der potentiellen Zielgruppen überprüfen, ob die Hypothesen zutreffen (Fragebögen an Kunden/Servicetechniker herausgeben)
  3. Die Zielgruppe beschreiben und Sonderfälle festhalten
  4. Rückschlüsse für die Risikobeurteilung und die Betriebsanleitung ziehen (Welche Ausbildung haben die Zielgruppen, welche Erfahrungen mit dem Produkt, die Häufigkeit der Nutzung, das Nutzungsumfeld der Anleitung)

Ein Muster für eine Technische Dokumentation spart Ihnen viel Zeit und Aufwand beim Erstellen einer Betriebsanleitung. Vorgefertigte Strukturen und Inhalte erleichtern den Erstellungsprozess und sorgen für eine Konsistenz bei unterschiedlichen Anleitungen. Aus einem Muster kann man so dann schnell seine Bedienungs-, Reparatur-, Montage-, Wartungs- oder Betriebsanleitung erstellen. Wiederkehrende Textelemente wie bspw. die Erläuterung von Symbolen und Hinweisen im Text oder das Impressum der Anleitung muss der Ersteller auch nicht immer wieder neu schreiben. Dies kann auch Übersetzungskosten sparen, falls die Übersetzungen wiederkehrender Textstellen bereits im Muster hinterlegt sind.

Warum ist es sinnvoll, sich ein Muster anzulegen?

Es ist sehr hilfreich, sich ein Muster für eine Technische Dokumentation anzulegen. Absatz- und Zeichenformaten in den Formatvorlagen legt man nur einmal für das Muster an. Ein einmalig sauberes erstelltes Seitenlayout ist dann auf jedes Dokument anwendbar. Inhaltsbausteine wie vorgefertigte Tabellen lassen sich ebenfalls für weitere Dokumente wiederverwenden. Das wiederverwendbare Muster ermöglicht dadurch einen maximalen Komfort beim Erstellen vieler Dokumente, die ähnlich aufgebaut sind.

Wie sollte ein Muster für eine Technische Dokumentation gestaltet sein?

Wenn die Inhalte für das Muster fest stehen, gilt es diese noch ansprechend in Form zu bringen. Dafür legt man sich ein sauberes Seitenlayout an und legt alle wichtigen Attribute fest. Hierzu gehören:

  • Design der Titelseite
  • Design des Inhaltsverzeichnis
  • Die Inhalte der Kopf- und Fußzeilen
  • Festlegung der Ränder und Abstände
  • Schriftarten und Größen für Überschriften, Kapitel, Abbildungen, Tabellen und Fließtext
  • Absatzformate für Aufzählungen, Nummerierungen und Einrückungen
  • Konzipierung von Formatvorlagen für eine schnelle Anwendung von Formaten
Technische Dokumentation Muster

Das Muster und weitere hilfreiche Materialien wie Checklisten können Sie bei uns kostenlos in unserem Downloadbereich herunterladen.

Die Entscheidung hinsichtlich welche Norm für die Technische Dokumentation zu wählen ist, hängt in erster Linie davon ab, was der jeweilige Hersteller produziert. Ein Hersteller von Haushaltsgeräten interessiert sich für die DIN EN ISO 20607 nur bedingt. Seine Geräte fallen häufig unter die Niederspannungsrichtlinie und unter dieser ist die DIN EN ISO 20607 nicht harmonisiert. Dieser Hersteller sollte sich daher mit der Dokumentationsnorm IEC/IEEE 82079-1 befassen, damit seine Technische Dokumentation dem Stand der Technik entspricht.

Für einen Hersteller von Produkten, welche unter die Maschinenrichtlinie fallen, ist die DIN EN ISO 20607 wesentlich interessanter. Die DIN EN ISO 20607 ist eine harmonisierte Norm für die Maschinenrichtlinie und kann eine Konformitätsvermutung auslösen. Aufgrund dieser Bedeutung werden Hersteller und deren Betriebsanleitungen an den Vorgaben der Norm gemessen. Ein Verstoß gegen die Norm wirkt sich nachteilig für den Hersteller aus.

Um den Stand der Technik vollständig zu entsprechen muss jedoch auch Maschinenbauer die IEC/IEEE 82079-1 umsetzen. Denn diese Norm behandelt die Themen Informationensmanagement und Informationserstellung umfassender als die DIN EN ISO 20607.

Ein Instruktionsmangel liegt vor, wenn der Hersteller den Benutzer der Maschine mit seiner Technischen Dokumentation nicht ausreichend instruiert. Die Instruktion umfasst alle Informationen in der Betriebsanleitung und Informationen über Restgefahren mittels Warnschilder und Signaleinrichtungen an der Maschine. Die Instruktionsanweisungen müssen vor allen Gefahren an der Maschine warnen, die nicht offensichtlich sind und nicht konstruktiv beseitigt werden konnten.

Beispiel für einen Instruktionsmangel. In der Betriebsanleitung einer Maschine steht die Handlungsanweisung: „Schlagen Sie die Sicherungsschraube heraus.“ Ein Bediener schlägt deswegen mit einem Eisenhammer auf die Sicherungsschraube, wodurch sich ein Metallsplitter löst und ihm ins Auge fliegt. Dies führt zu einer einseitigen Erblindung des Bedieners. Dem Bediener fehlten weiterführende Informationen, wie dass er nur bestimmtes Werkzeug (wie einen Plastikhammer) verwenden darf. Auch fehlten Informationen zu Schutzmaßnahmen bei der Ausführung der Tätigkeit. Das Tragen einer Schutzbrille hätte den Bediener vor dem Metallsplitter bewahrt. Hier lag ein klarer Fall von einem Instruktionsmangel des Herstellers vor.

Falls Fehler in der Technischen Dokumentation nach dem Inverkehrbringen des Produktes herauskommen, geht es hierbei um einen Fall der Produktbeobachtung. Der Hersteller muss beobachten, was mit seinem Produkt am Markt geschieht. Dies betrifft auch die Anleitung. Der Hersteller ist daher verpflichtet, auf den Fehler in der Anleitung auf eine Weise zu reagieren. Abhängig davon welche Folgen durch diesen Fehler entstehen können, muss der Hersteller entsprechend handeln. Beispielsweise kann der Hersteller in moderaten Fällen durch ein Warnschreiben seine Kunden informieren und eine neue Anleitung zur Verfügung stellen. In schwerwiegenden Fällen genügt eine Produktwarnung möglicherweise nicht und der Hersteller muss sogar einen Produktrückruf einleiten. 

Bei vielen Unternehmen, die eine Technische Dokumentation für Ihre Produkte erstellen, zeigt sich, dass die Anleitung zu viele Warnhinweise enthält. Grund ist die Angst vor Haftungsrisiken bei den produzierenden Firmen. Das wiederholte aufführen des gleichen Warnhinweises oder die Klassifikation eines Warnhinweises in eine höhere Gefahrenkategorie sind nur ein paar Fälle. Um auf Nummer sicher zu gehen, wählt das Unternehmen beispielsweise für einen Warnhinweis der Stufe „Vorsicht“ lieber die Warnstufe „Gefahr“. Auch das warnen vor offensichtlichen Gefahren, beispielsweise dass ein Messer scharf ist, findet häufig statt. Das Überfrachten einer Anleitung mit zu vielen Warnhinweisen macht diese unverständlich und der Leser neigt dazu, die Warnungen zu überfliegen oder gänzlich zu ignorieren.

Die Informationen in der Technischen Dokumentation und an der Maschine müssen wichtige Hinweise zum Gebrauch des Produktes liefern. Auf dem Typenschild sind unter Umständen Angaben zu Betriebsmitteln zu finden, die Aufschluss über Menge und Klassifizierung des Betriebsmittels geben. Sollten im Falle von Reparaturen Ergänzungen oder ein Austausch dieser Betriebsmittel nötig sein und die Spezifikationen der Betriebsmittel haben sich geändert, so gilt es die geänderten Sachinformationen auf dem Typenschild zu aktualisieren. Dies ist wichtig, damit die Informationen den aktuellen Stand wiedergeben. Hierfür kann man die Ergänzung beispielsweise handschriftlich auf einem Aufkleber eintragen. Der Stift sollte dazu aber die Dauer der Lesbarkeit der handschriftlichen Ergänzung sicherstellen.

Durch die PSA-Verordnung 2016/425 besteht eine Pflicht zur Bereitstellung einer Technischen Dokumentation für eine persönliche Schutzausrüstung. Der Hersteller muss laut der Verordnung für folgende „technische Unterlagen“ sorgen:

  • Eine vollständige Beschreibung und die bestimmungsgemäße Verwendung der PSA
  • Beurteilung von Risiken, vor welchen die PSA schützen soll
  • Eine Liste mit Fundstellen der harmonisierten Normen für die PSA, welche bei Entwurf und Herstellung der PSA zum Einsatz kam
  • Zudem Untersuchungen hinsichtlich der Überprüfung der Konformität
  • Weiterhin Berichte welche Prüfungen zur Ermittlung der jeweiligen Schutzklasse zum Einsatz gekommen sind

Ebenso muss die Anleitung zur PSA die Name und Anschrift des Herstellers beinhalten und Angaben zum Monat und Jahr der Herstellung der PSA sowie über mögliche Verfallszeiten der PSA machen.

Eine Forderung für ein eigenes Kapitel zum vorhersehbaren Fehlgebrauch in der Technischen Dokumentation existiert nicht. Der Inhalt dazu muss in der Betriebsanleitung vorkommen, die Wahl der Darstellung ist einem aber selbst überlassen. Häufig bietet sich das Kapitel „Produktbeschreibung“ an, in der neben der bestimmungsgemäßen Verwendung auch der vorhersehbare Fehlbrauch beschrieben ist. Ein eigenes Unterkapitel bietet sich jedoch für die schnelle Suche nach diesem Inhalt an.

Durch die Einführung der Zubehörteile in die EU und dem Weiterverkauf sind Sie für die Sicherheit einschließlich der Technischen Dokumentation verantwortlich. Wenn es zur Nutzung der Zubehörteile etwas zu beachten gilt, müssen entsprechende Informationen in der Technischen Dokumentation dargestellt sein. Ein Verweis auf die Dokumentation des Fremdlieferanten ist möglich. Sollte die Anleitung des Fremdlieferanten fehlen, entbindet Sie das aber nicht von Ihrer Pflicht Informationen über das Zubehörteil bereitzustellen. Im Fall, dass der Lieferant keine Anleitung mitschickt, hätte das Zubehörteil gar nicht in die EU gelangen oder weitergegeben dürfen.

Der Gesetzgeber fordert, dass der Hersteller die Technische Dokumentation zu seinen Produkten ab dem Zeitpunkt des Verkaufs mindestens 10 Jahre vorhalten muss. Der Verkauf jedes Produktes setzt diesen Zeitpunkt wieder zurück. Falls im Zuge der Produktbeobachtungspflicht die Dokumentation anzupassen ist, muss später nachvollziehbar sein, wann welche Änderungen vorgenommen wurden.

Falls die Marktaufsicht die Anleitung des Standes „a“ von 2011 haben möchte, welches dem fehlerhaften Produkt beilag, muss der Hersteller diesen Stand vorlegen können. Neuere Versionen der Anleitung sind dann irrelevant. Kann das Dokument nicht vorgelegt werden, führt dies zu Strafen und Maßnahmen seitens der Marktaufsicht.

Gerade für Hersteller von Serienprodukten ist daher die Nachverfolgbarkeit von den einzelnen Ständen von großer Bedeutung und die Pflege der einzelnen Versionen ohne Redaktionssystem oder ähnlicher Software eine Herausforderung.

Sind Informationen für den Umgang mit entzündlichen Stoffen zu beachten, muss der Hersteller entsprechende Informationen in seiner Technischen Dokumentation bereithalten. Die Maschinenrichtlinie fordert zudem, dass eine Maschine so konstruiert und gebaut sein muss, dass keine Brand- und Überhitzungsgefahren entstehen können. Auch von Gasen, Flüssigkeiten, Stäube, Dämpfe und andere von der Maschine freigesetzte bzw. verwendete Stoffe dürfen keine Gefahren ausgehen. Mögliche Sicherheitsmaßnahmen bezüglich des Brandschutzes wie beispielsweise die Kennzeichnung von Fluchtwegen sind daher auch in der Betriebsanleitung zu nennen.

Falls mehrere Dokumente die „Betriebsanleitung“ in einer Technischen Dokumentation ausmachen, muss der Zusammenhang der einzelnen Dokumente klar erkennbar sein. Dies kann man mithilfe von entsprechenden Verweisen und Verzeichnissen in allen Dokumenten sicherstellen. Dadurch ist ersichtlich, welches Dokument welchen Zweck erfüllen soll und welche Inhalte darin vorkommen. Die Inhalte in den Dokumenten sind „zielgruppengerecht“ aufzuteilen. Ein Montagehandbuch beschäftigt sich nur mit den Inhalten der Montage, das Wartungshandbuch nur mit den Inhalten zur Wartung und Instandhaltung. Vorhandene Inhalte, die übergreifend in mehreren Dokumenten anwendbar sind, sollte man aber nicht doppelt aufführen. Besser und sinnvoller ist es hierbei auf die jeweiligen anderen Teile der Anleitung zu verweisen.

Eine Betriebsanweisung muss an geeigneter Stelle an der Arbeitsstätte zugänglich sein. Dies ist eine Forderung aus der Betriebssicherheitsverordnung. Wenn es die betrieblichen Tätigkeiten erfordern, wie beispielsweise im Umgang mit Gefahrstoffen, muss die Betriebsanweisung in unmittelbarer Nähe in gedruckter Form vorliegen. Eine Gefährdungsbeurteilung des Arbeitsplatzes hilft zudem zu bewerten, in welcher Form den Beschäftigten die Betriebsanweisungen zugänglich zu machen ist.

Es empfiehlt sich über Zündgefahren für Geräte in explosionsfähigen Atmosphären entsprechende Informationen in der Technischen Dokumentation bereitzustellen. Es bietet sich an Information zu Zündgefahren und mögliche Maßnahmen für die entsprechende Zielgruppe (Anwender, Reinigungs- oder Wartungspersonal) anzugeben. Beispielsweise welche Maßnahmen, der Anwender vor Benutzen des Gerätes zu treffen hat. Oder welche Schutzeinrichtungen bzw. Funktionen zum Explosionsschutz vor Benutzung zu prüfen sind. Zur Darstellung hierfür bietet sich eine Tabelle mit den Angaben Zündrisiko, Technische Maßnahmen, Verhaltensregeln und Zielgruppe an.

Der Hersteller einer Maschine oder Anlage hat darauf zu achten, dass seine Technische Dokumentation dem aktuellen Stand der Technik entspricht. Wenn durch neue Entwicklungen verbesserte Methoden zur Sicherheit des Produktes bekannt sind, müssen diese Aktualisierungen in die Betriebsanleitung mit einfließen.

Ein Hersteller muss in seiner internen Technischen Dokumentation auch entsprechende Unterlagen bereithalten. Dazu gehören auch Nachweise zur Umsetzung von Anforderungen an sicherheitsrelevante Funktionen wie Schutzeinrichtungen. Zu diesen internen Entwicklungsdokumenten, die das Know-how des Herstellers wiederspiegeln, zählen unter anderem:

  • Die Eigenschaften von Sicherheitsfunktionen
  • Einsatzbedingungen mit genauem Beginn und Ende der Sicherheitsfunktionen
  • Fehlerbetrachtungen an Sicherheitsfunktionen und Rechtfertigung von Fehlerausschlüssen
  • Festlegen von Performance Level PL ausgewählter Kategorien der Sicherheitsfunktionen
  • Maßnahmen gegen systematische Fehler
  • Maßnahmen gegen vernünftigerweise vorhersehbaren Fehlanwendung
  • Softwaredokumentation von Sicherheitsfunktionen

Um eine Technische Dokumentation übersichtlich zu gestalten, können Orientierungshilfen auf den Seiten die Aufmerksamkeit des Lesers entsprechend steuern. Die geläufigste Orientierungshilfe ist die Seitenzahl. Aber auch Zwischenüberschriften, Marginalien, Stichwörter oder Register helfen dem Benutzer bei der schnellen Navigation durch das Dokument. Einige dieser Orientierungshilfen finden sich in den Kopf- und Fußzeilen des Dokumentes. In der Kopfzeile können z. B. die Kapitelüberschriften stehen. Die Seitenzahlen stehen üblicherweise in der Fußzeile.

Andere Orientierungshilfen wiederum sind im seitlichen Bereich zu finden und grenzen sich vom eigentlichen Satzspiegel ab, um beim Blättern schnell aufzufallen. So können Marginalienspalten den Inhalt von wichtigen Absätzen hervorheben. Am Ende eines Kapitels kann auch eine Zusammenfassung für den Leser hilfreich sein. Zwischenüberschriften lockern den Text ebenfalls auf. Die Untergliederung dieser sollte jedoch maximal bis zur 3. Stufe reichen, um die Übersichtlichkeit zu wahren.

Das Inhaltsverzeichnis einer Technischen Dokumentation bietet dem Leser einen Überblick über die Inhalte der Dokumentation. Zwar genügt es die Inhalte mit einer Nummerierung und entsprechenden Überschriften zu versehen, jedoch ermöglichen visuelle Hilfsmittel die unterschiedlichen Ebenen besser darzustellen. Beispielsweise kann man die untergeordneten Ebenen mit Einzügen einrücken. Die oberste Hierarchieebene kann man durch eine entsprechende Schriftstärke zusätzlich hervorheben. Mit zusätzlichem Weißraum zwischen den unterschiedlichen Ebenen schafft man zudem sinnstiftende Einheiten. Dadurch kann sich der Leser einen schnelleren Überblick über die einzelnen Kapitel verschaffen.

Einen Vergleich zwischen einem einfachen Inhaltsverzeichnis und einem optimierten Inhaltsverzeichnis führen wir hier nachfolgend auf:

Das typografische Gestalten einer Technischen Dokumentation ist ein funktionaler Prozess. Gut gestaltete Texte helfen dem Benutzer zeitsparend und energiesparend benötigte Informationen zu finden. Um dem Leser einer Dokumentation den textlichen Inhalt gut zu präsentieren, gibt es einige Punkte die es zu beachten gilt:

  1. Achten Sie darauf, dass zwischen Schriftfarbe und Hintergrundfarbe der Helligkeitsunterschied ausreichend groß ist.
  2. Gliedern Sie Inhalte zudem hieratisch durch entsprechende Abgrenzungen wie weißer Raum oder Trennlinien
  3. Verwenden Sie für die Wahrnehmung von Informationen nur bekannte Konventionen wie Verzeichnisse, Marginalien oder hierarchisch abgestufte Überschriften, um dem Leser den Umgang mit dem Text zu erleichtern
  4. Nutzen Sie gezielt Auszeichnungen wie beispielsweise Größe, Schriftstärke oder Farbe, um den Benutzer auf wichtige Inhalt hinzuweisen

Die Bestimmungen für eine Technische Dokumentation für den australischen Markt sind sehr eng mit dem europäischen Markt gekoppelt. In Australien kommen dabei die Warnsymbole der internationalen Norm ISO 7010 zum Einsatz. Zudem übernehmen die Australier viele Bestimmungen aus dem europäischen Markt. So sind in einem gegenseitigen Abkommen die Konformitätsbewertungsverfahren durch eine Selbsterklärung der Hersteller anerkannt.

Die Technische Dokumentation muss vor dem Inverkehrbringen des Produktes abgeschlossen sein. Daher ist es sinnvoll die Technische Redaktion frühzeitig im Konstruktionsprozess mit einzubinden. Spätestens dann wenn das Lastenheft für das Produkt vorliegt. Aus den Anforderungen an das Produkt im Lastenheft kann der Technische Redakteur viele Informationen gewinnen und mit der groben Gliederung der Technischen Dokumentation beginnen.

Um die Technische Dokumentation sinnvoll zur strukturieren, bietet sich die Norm DIN EN 82079-1 an. Diese sorgt mit ihren klaren Konzepten für eine gute Struktur und ist zudem eine echte Hilfestellung beim Erstellen einer Anleitung. Dabei enthält die Norm Prinzipien zur Verständlichkeit einer Anleitung und fordert mit dem Minimalismus-Prinzip, die Anleitungen nicht künstlich aufzublähen. Die Anleitung soll die Aufmerksamkeit des Benutzers auf wichtige Einzelheiten hin steuern. Auch sollen Warnhinweise nicht überbetont dargestellt sein. Warnhinweise sollen den Leser nicht vom Lesen der Anleitung abhalten.

Das Überfrachten der Technischen Dokumentation mit Warnhinweisen – auch Warning Pollution genannt – gilt es zu vermeiden. Durch die Aneinanderreihung vieler (häufig gleicher) Sicherheitshinweise verschlechtert man die Lesbarkeit einer Anleitung. Nur wo es handlungsbezogen relevant ist, gilt es vor Gefahren zu warnen. Wiederholungen von Warnhinweisen sind ebenfalls zu vermeiden, wenn diese nicht für eine Handlung relevant sind. Eine Überfrachtung der Anleitung mit Warnhinweisen kann zudem aus rechtlicher Sicht zu einer fehlerhaften Anleitung führen. 

Für Ersatzteile einer Maschine ist keine zusätzlich oder neue Technische Dokumentation notwendig. Es genügt, wenn die vorhandene Betriebsanleitung der Maschine für den sachgerechten und sicheren Einbau von Ersatzteilen ausreicht. Manche Hersteller entscheiden sich jedoch dazu zusätzliche (nicht geforderte) Einbauinformationen mitzugeben. Damit wollen Sie sichergehen, dass der Kunde die Ersatzteile korrekt in die Maschine einbauen kann.

Die Technische Dokumentation nach einem Konzept auszurichten ist nur ein logischer Schritt. Ohne Konzept fehlt eine klare didaktische Ausrichtung und der Ersteller der Dokumentation schreibt an seiner Zielgruppe vorbei. Die Texte sind dann unverständlich, haben keine Struktur und enthalten zu wenige oder zu viele Informationen. Auch auf der inhaltlichen Ebenen sind Anleitungen ohne Konzept schnell überfrachtet. Der Ersteller packt die ganze Dokumentation voll mit Warnhinweisen und versucht eine gewisse Struktur zu suggerieren. Ein durchdachtes Konzept hilft hingegen die Technische Dokumentation einheitlich aufzugliedern und sinnvoll zu strukturieren.

Die Norm ISO 3864 behandelt innerhalb der Technischen Dokumentation die Gestaltung von Sicherheitszeichen. Die Norm hat den Titel „Graphische Symbole – Sicherheitsfarben und Sicherheitszeichen“ und legt dabei Gestaltungsgrundlagen für Sicherheitszeichen und Markierungen fest.

Bevor man eine Technische Dokumentation erstellen kann, geht es zuerst darum einige grundlegende Informationen zu beschaffen.

Welche Vorgaben hat der Kunde an die Maschine bzw. das Produkt und hat er auch Anforderungen an die Technische Dokumentation?

Über die Maschine bzw. das Produkt sollten grundlegende Dinge wie Positionen und Einbauweise von Komponenten und Bauteilen oder der zeitliche Ablauf von Arbeitsschritten bekannt sein. Informationen sind in Unterlagen wie Lasten- und Pflichtenhefte, Design-Spezifikationen oder Besprechungsprotokolle zu finden und helfen eine Technische Dokumentation zu erstellen.

Der redaktionelle Prozess um eine Technische Dokumentation zu erstellen, kann sehr kompliziert sein. Normen und Richtlinien schreiben vor, welche Inhalte die Technische Dokumentation beinhalten muss. Daher ist es ratsam auf entsprechende Hilfsmittel zurückzugreifen, wenn man eine Technische Dokumentation erstellt. So kann man beispielsweise eine Terminologieliste verwenden, welche einheitliche Formulierungen von Fachbegriffen enthält. Auch die sprachlichen Regelungen, Layoutvorgaben und die Informationsverteilung in der Dokumentation mittels einem Redaktionsleitfaden festzulegen ist sinnvoll. Auch der Einsatz entsprechender Software wie eines Redaktionssystems ist ein nützliches Hilfsmittel in der Technischen Dokumentation.

Das Bestimmungsland für eine Maschine bzw. Anlage ist vor dem Erstellen einer Technischen Dokumentation relevant. Eine Maschine ist meistens den Bestimmungen des Ziellandes entsprechend konstruiert und darauf ausgelegt. Für andere Länder ist die Maschine möglicherweise nicht ausgelegt, weil die Maschine diese Anforderungen (beispielsweise ein anderes Stromnetz) nicht erfüllt. Deswegen ist es sinnvoll, das Bestimmungsland bereits im Vorfeld vertraglich (bspw. Kaufvertrag) festzulegen. Eine zusätzliche Nennung des Bestimmungslandes in der Betriebsanleitung ist daher auch nicht notwendig.

Sollte die Maschine anschließend durch den Käufer oder andere Dritte Parteien in ein anderes Land gehen, können andere Bestimmungen gelten. Der (eigentliche) Hersteller kann sich auf die vertragliche Festlegungen des ursprünglichen Bestimmungsland berufen und hat keine Verpflichtungen hinsichtlich einer Nachrüstung.

Der Zeitpunkt des erstmaligen Inverkehrbringen ist auch dieser Zeitpunkt an dem die Technische Dokumentation für das Produkt vorliegen muss.

Folgende Merkmale sind beim erstmaligen Inverkehrbringen von Bedeutung:

  • Ein neues Produkt am Markt,
  • welches erstmalig entgeltlich oder unentgeltlich bereitgestellt wird,
  • im europäischen Binnenmarkt,
  • im Rahmen einer Geschäftstätigkeit.

In der Serienproduktion und manchmal auch in der Technischen Dokumentation hört man von Chargennummern. Eine Charge stellt eine Summe von Teilen bzw. Erzeugnissen dar, die unter einer gleichbleibenden Bedingung hergestellt sind. Alle Teile in einer Charge sind gleichartig. Die Chargennummer hilft dabei ein Produkt seinem genauen Produktionsvorgang zuzuordnen. Die Chargennummern werden nach erfolgter Produktion systematisch erfasst. Falls ein Produktionsfehler in dem Produkt auftaucht, kann man nachvollziehen, welche weiteren Teile davon betroffen sind. Die Chargennummer gibt Auskunft über:

  • Herstellungsort
  • Herstellungszeitpunkt
  • Hersteller
  • Angabe des Einsatzes von Maschinen und/oder Rohstoffe

Bei kritischen Produkten wie Arzneimittel oder Lebensmittel ist die Vergabe von Chargennummern sogar eine gesetzliche Pflicht. Die Technische Dokumentation des Produktes hilft dabei, die Vergabe von Chargennummern zu beschreiben. Dann kann man beim Vorkommen von Produktfehlern mit Hilfe der Chargennummern die betroffene Menge an Teilen ermitteln.

Der Umgang mit Betriebsmitteln wie Öle und Fette und deren Entsorgung müssen in der Technischen Dokumentation beschrieben sein. Durch Rückstände von Öle und Fette bestehen Restgefahren. Für den Benutzer der Maschine muss daher nachvollziehbar sein, wie Rückstände von Betriebsmitteln zu entfernen sind. Die Handhabung der Betriebsmittel ist meist in den mitgelieferten Datenblättern der Hersteller zu entnehmen. Die Abfallentsorgung ist lokal durch den Gesetzgeber vorgeschrieben und von Region und Land verschieden. Bei unproblematischen Produkten genügt hier meist ein Verweis, dass der Benutzer des Produktes mit dem örtlichen Entsorgungsunternehmen in Kontakt treten und die Entsorgung veranlassen muss.

Es gibt hinsichtlich der Erläuterungen von Störungsmeldungen in der Technischen Dokumentation keine speziellen Vorgaben. Die Angaben aus Richtlinien und Normen sind dort eher allgemein gehalten. Daher genügt es Erläuterungen von Störungsmeldungen auch nur auf dem Bedienbildschirm anzeigen zu lassen. Anders sieht es aus, wenn es bei der Störungsbeseitigung zu möglichen Gefährdungen kommen kann. Dann ist unbedingt auf diese Gefährdungen in der Betriebsanleitung und auf dem Bedienbildschirm hinzuweisen.

Einer Erläuterung der Ingangsetzung bzw. Starten einer Maschine muss in der Technischen Dokumentation vorkommen. Die Maschinenrichtlinie fordert, dass eine Ingangsetzung der Maschine nur durch das absichtliche Betätigen einer vorgesehenen Befehlseinrichtung (z.B. Hauptschalter) erfolgen darf. Daher ist es auch nur sinnvoll, die Vorgehensweise für die Ingangsetzung der Maschine in der Technischen Dokumentation zu erläutern.

Die Übernahme der Technischen Dokumentation einschließlich der Betriebsanleitung ist ohne Absprache mit dem ehemaligen Hersteller nicht möglich. Das geistige Eigentum bzw. die Urheberrechte der erstellten Unterlagen verbleiben beim Ersteller. Durch die Veränderungen an der Maschine müssen Sie auch die Unterlagen anpassen. Daher ist auch die Genehmigung des Herstellers erforderlich, wenn Sie dessen Dokumentation verändern wollen. Eine Veränderung ohne Rücksprache verstößt gegen geltendes Recht, weil Sie dann ein urheberrechtlich geschütztes Werk verändern.

Eine Technische Dokumentation nach der ATEX-Richtlinie muss folgende Mindestangaben erfüllen:

  • Angaben zur (sicheren)
    • Inbetriebnahme
    • Verwendung
    • Montage und Demontage
    • Wartung und Störungsbeseitigung (Instandhaltung)
    • Installation
    • Rüsten
  • erforderlichenfalls die Markierung von gefährdeten Bereichen vor Druckentlastungseinrichtungen;
  • erforderlichenfalls Angaben zur Einarbeitung;
  • Angaben, die zweifelsfrei die Entscheidung ermöglichen, ob die Verwendung eines Geräts (entsprechend seiner ausgewiesenen Kategorie) oder eines Schutzsystems in dem vorgesehenen Bereich unter den zu erwartenden Bedingungen gefahrlos möglich ist;
  • elektrische Kenngrößen und Drücke, höchste Oberflächentemperaturen sowie andere Grenzwerte;
  • erforderlichenfalls besondere Bedingungen für die Verwendung, einschließlich der Hinweise auf sachwidrige Verwendung, die erfahrungsgemäß vorkommen kann;
  • erforderlichenfalls die grundlegenden Merkmale der Werkzeuge, die an dem Gerät oder Schutzsystem angebracht werden können.

Auf dem betreffenden Gerät bzw. Schutzsystem und der Betriebsanleitung müssen zudem die folgenden Angaben deutlich und dauerhaft angebracht sein:

  • Name, eingetragener Handelsname oder eingetragene Handelsmarke und Anschrift des Herstellers,
  • CE-Kennzeichnung (siehe Anhang II der Verordnung (EG) Nr. 765/2008),
  • Bezeichnung der Serie und des Typs,
  • gegebenenfalls die Chargen- oder Seriennummer,
  • das Baujahr
  • das spezielle Explosionsschutzkennzeichen, gefolgt von dem Kennzeichen, das auf die Gerätegruppe und -kategorie verweist,
  • für die Gerätegruppe II der Buchstabe „G“ (für Bereiche, in denen explosionsfähige Gas-, Dampf-, Nebel-, Luft- Gemische vorhanden sind)
  • der Buchstabe „D“ (für Bereiche, in denen Staub explosionsfähige Atmosphären bilden kann).
  • Zusätzlich und wenn erforderlich müssen auch alle für die Sicherheit bei der Verwendung unabdingbaren Hinweise (Warnhinweise) angebracht werden.

Es ist sinnvoll, die Technische Dokumentation in Bereiche und Abschnitte zu gliedern. Dann muss der Anwender sich nicht jede einzelne Seite der Betriebsanleitung durchschauen. Mit Orientierungshilfen wie Inhalts-, Abkürzungs-, Tabellenverzeichnis, Index oder einem Glossar kann der Benutzer sinnvoll durch die Technische Dokumentation navigieren.

Die Technische Dokumentation enthält auch Angaben zur Entsorgung einer Maschine. Hat die Maschine ausgedient, ist diese fachgerecht zu entsorgen. Dabei müssen Informationen hinsichtlich Außerbetriebnahme, Demontage, Recycling und Entsorgung dem Benutzer in der Betriebsanleitung zur Verfügung stehen. Da gesetzliche Vorgaben zur Entsorgung von Maschinen(-teilen) sich ändern, ist ein Vermerk in der Betriebsanleitung zu hinterlegen. Der Benutzer muss sich über die geltenden Bestimmungen informieren und sich daran halten.

Wie der Benutzer mit gefährlichen Stoffen im Betrieb umzugehen hat, muss über die Technische Dokumentation beschrieben sein. Die in Kühlschmierstoffe enthaltenen Stoffe, sind gesundheitlich nicht unbedenklich. Bei Hautkontakt können diese allergische Gesundheitsschäden verursachen. Durch das Einatmen der aus dem Kühlschmierstoff entstandenen Aerosole besteht zudem für den Benutzer eine gefährliche gesundheitsschädliche Gefahr. Diese Stoffe können unter anderem Krebs verursachen. Daher ist es wichtig, dass die Benutzer über die möglichen Gefahren im Umgang mit Kühlschmierstoffen informiert sind. Durch richtiges anleiten mittels der Technischen Dokumentation ist ein sicherer Umgang mit diesen Stoffen dann auch möglich.

Nominalisierung in der Technischen Dokumentation ist, wenn die Texte der Anleitungen mehr Substantive als Verben enthält.

Ein Beispiel für solch einen Nominalisierung ist folgender Satz:

Durch Drücken der Taste „Start“, kann die Maschine gestartet werden

Der Einsatz von mehr Substantiven macht den Satz nicht mehr verständlich. Zur besseren Verständlichkeit ist es besser, eine Variante mit mehr Verben zu wählen. Eine bessere Formulierung könnte sein:

Drücken Sie die Taste „Start“, um die Maschine zu starten.

Durch den gezielten Einsatz von Verben wirkt das Geschriebene nicht zu formal oder zu umgangssprachlich und ist trotzdem verständlich.

Eine aktive Ansprache in einer Technischen Dokumentation klingt ansprechender als eine Passiv formulierte. Formaler und unpersönlicher Satzbau sind keine interessanten Inhalte für den Leser. Passiv eignet sich nur für Beschreibungen und Erklärungen, in denen die Benutzer nicht wichtig sind. Der Benutzer ist direkt anzusprechen. Hierzu eignen sich Personalpronomen wie „Sie“ und „Ihr“. Achten Sie dabei, dass die Pronomen groß geschrieben sind. Mit dem Leser in Kontakt zu treten und eine aktive Schreibweise zu verwenden, ist immer die bessere Lösung.

Es gibt mehrere Möglichkeiten, die Verständlichkeit in den Sätzen einer Technischen Dokumentation zu erhöhen. Zum einen gilt es, die Bildung von Schachtelsätzen zu vermeiden. Eine gute Technische Redaktion spaltet unverständliche Bandwurmsätze in kleine Informationshappen auf. Eine verständliche Satzlänge beträgt durchschnittlich 15 Wörter. Hier ist aber der Rhythmus entscheidend. Wechseln sie längere und kürzere Sätze ab.

Verzichten Sie zudem auf Weichmacher in Ihrem Text. Der Text sollte nicht abstrakt gehalten sein, sondern konkret den Sachverhalt vorgeben. „Sollte“ ist ein gutes Beispiel für einen Weichmacher.

In das Innere der Maschine sollte keine Feuchtigkeit geraten.

Stattdessen ist folgende Formulierung verständlicher in einer Anleitung:

Es darf keine Feuchtigkeit in das Innere der Maschine gelangen.

Durch das Weglassen des Weichmachers „Sollte“ ist in diesem Beispiel konkret und verständlich ersichtlich, dass keine Feuchtigkeit in die Maschine gelangen darf.

Die Aufteilung der Technischen Dokumentation und auch der Betriebsanleitung in einzelne Dokumente ist durchaus sinnvoll und auch häufig gängige Praxis. Falls verschiedene Inhalte für unterschiedliche Zielgruppe vorgesehen sind, ist es übersichtlicher diese jeweiligen Inhalte in getrennten Dokumenten aufzuführen. Die Aufteilung verdeutlicht, dass die Dokumententeile für unterschiedliche Benutzer mit bestimmte Qualifikationen bestimmt sind. Ebenfalls bleibt eine komplexe und umfangreiche Dokumentation durch eine Aufteilung übersichtlich. Beispielsweise könnte der Teil des Einrichtens der Maschine ein eigenständiges Dokument sein und ist trotzdem ein Bestandteil der gesamten Betriebsanleitung. Der Ersteller der Dokumentation muss dabei darauf achten, dass der Zusammenhang der Einzeldokumente klar erkennbar ist.

Fachbegriffe in der Technischen Dokumentation einheitlich zu benennen sorgt für Verständlichkeit und Eindeutigkeit in einer Betriebsanleitung. Das Festlegen auf eine vorrangige Benennung von einem Fachausdruck ist auch als Terminologie bekannt. Das ist die Basis für Wiederverwendung, Konsistenz und Verständlichkeit der Betriebsanleitung. In der Produktentwicklung kommt es häufig vor, dass sich die Inhalte und Fachausdrücke von Risikobeurteilung zu Betriebsanleitung sich unterscheiden. Die unterschiedliche Namensgebung sorgt dann für Verwirrung unter anderen Mitarbeitern bzw. Abteilungen. Die Werbeabteilung könnte beispielsweise annehmen, dass es sich um verschiedenen Produkte handelt, obwohl es nur unterschiedliche Begriffe für dasselbe Produkt sind. Die richtige Verwaltung des Fachwortschatzes ist in Programmen, sogenannten Terminologie-Manager hinterlegt.

Im Juni 2019 erschien die ISO Norm 20607, welche für die Technische Dokumentation von Maschinen einige nützliche Gestaltungsgrundsätze für Betriebsanleitungen enthält. Die Norm gibt Inhalte und Struktur einer Betriebsanleitung vor. Zu jedem Kapitel einer Anleitung finden sich dazu detaillierte Aufstellungen zu den Inhalten der jeweiligen Kapitel.

Weitere Vorgaben für die Dokumentation der IT-Schnittstellen der Maschine behandelt die ISO 20607. Dabei geht es um Benutzerrechte, Benutzerkonten und Maßnahmen zur Gewährleistung der IT-Sicherheit. Die Norm verweist dabei auf ein neues technisches Regelwerk: die ISO/TR 22100-4. Zudem ist es möglich mit einer vorgefertigten Struktur einer Betriebsanleitung die Erstellungsarbeit einer Anleitung zu vereinfachen. Eine weitere Hilfestellung für Technische Redakteure dazu ist das Muster einer Fehlerliste in dieser Norm. In dem Muster finden sich Beispiele für Fehlern samt Informationen zur Fehlerbeseitigung sowie zur Wiederherstellung der Funktionalität der Maschine. Ergänzende Felder für Klassifikation der Fehler und der Zuweisung von entsprechendem Fachpersonal runden das Muster ab.

Die Technische Dokumentation einer Maschine oder Anlage musste bisher immer in Papierform vorliegen. Die Dokumentationsnorm ISO 20607 schließt diese Lücke nun und passt dazu den Sachverhalt an den Stand der Technik an. Es ist nun möglich unterschiedliche Publikationsmedien zu wählen, die zum Produkt und der Verwendung passen. Für die Technische Dokumentation muss daher nun nicht mehr ausschließlich nur die klassische Papierform zum Einsatz kommen. Die ISO 20607 gibt folgende Publikationsformen zur Auswahl:

  • Die Bereitstellung der Betriebsanleitung wie bisher gewohnt in gedruckter Form
  • Bereitstellung durch Zugriff auf externen Server, interne Server, Webseiten oder Speichermedien
  • Die Bereitstellung über ein mit der Maschine verbundenes Speichermedium
  • Zudem die Bereitstellung in Form einer Audio- oder Videoanleitung auf Webseiten, Steuerterminals oder ähnlichem

Da die Bereitstellung der Anleitung auch im digitalen Fall dauerhaft gewährleistet sein muss, kann je nachdem auch weiterhin nicht auf die gedruckte Anleitung verzichtet werden. Beispielsweise falls nicht dauerhaft ein elektronisches Gerät zum Abruf der Anleitung zur Verfügung steht.

Im Gegensatz zur Technischen Dokumentation einer Maschine benötigen Medizinprodukte eine Gebrauchsanweisung. Dies fordert die Medizinprodukteverordnung für Medizinprodukte. Die Verordnung macht genaue Angaben zu den Inhalten der Gebrauchsanweisung. Daneben kommen von der IEC 62366-1, der IEC 60601-1, der DIN EN 1041, der Invitro Diagnostik Verordnung oder der Verordnung 207/2012 für elektronische Gebrauchsanweisungen zudem weitere Anforderungen an die Gebrauchsanweisung. Zwar kann die DIN EN 82079-1 als Leitfaden dienen, jedoch sollte man die Norm nicht alleine zum Erstellen verwenden.

Die Fehler, die beim Erstellen einer Gebrauchsanleitung für Medizinprodukte auftreten, unterscheiden sich nicht merklich von einer Technischen Dokumentation im Maschinenbau. Auch bei Medizinprodukte treten die üblichen Fehler auf, die bei der Erstellung einer Betriebsanleitung vorkommen. Zu den häufigsten Fehlern bei der Erstellung von Anleitungen gehört, dass:

  • Wichtige Teile oder Kapitel in der Gebrauchsanleitung fehlen.
  • Der inhaltliche Teil der Anleitung falsch ist.
  • Die Texte der Anleitung unverständlich sind, zu passiv oder abstrakt formuliert sind.
  • Keine Bilder oder Grafiken in der Anleitung vorhanden sind.
  • Sicherheits- und Warnhinweise nur unzureichend beschrieben sind.
  • Die Anleitung nicht oder nicht mehr mit dem Produkt übereinstimmt.
  • Die Zusammenfassung von mehreren Produkten in einer Anleitung.
  • Keine Anwendung einer konsistenten Terminologie.
  • Keine Struktur in der Anleitung vorhanden ist (Inhaltsverzeichnis oder ähnliche Dinge, die dem Leser die Navigation durch das Dokument erleichtert).
  • Schriftgröße zu klein gewählt ist oder eine ungeeignete Schriftart zum Einsatz kommt.
  • Übersetzungen schlecht oder falsch sind.
  • Überflüssige Informationen wie Dankeswünsche enthalten sind, die das Dokument aufblähen.

Der Umfang der Warnhinweise in der Technischen Dokumentation hängt von der Risikobeurteilung ab. Diese beschreibt Tätigkeiten und legt für diese Tätigkeiten auch die entsprechenden Personalqualifikationen fest. Bei den Beschreibungen der Tätigkeiten ermittelt man dann die Risiken bei den Tätigkeiten. Eine elektrische Gefahr nach Öffnen einer Schutzabdeckung ist ein ernstes Risiko für den Benutzer. Ein entsprechendes Warnschild an der Abdeckung sorgt für die entsprechende Information des Benutzers. Zusätzlich sollte auch die Gefahr in der Betriebsanleitung vermerkt sein.

Zwar ist in Deutschland das Fachpersonal für Elektroarbeiten mit vielen Risiken vertraut und man könnte erwägen diese Stellen nicht in der Betriebsanleitung zu erwähnen. Jedoch ist dabei der internationale Markt eher das Problem. In vielen Ländern gibt es keine ausgebildeten Fachkräfte, da die Ausbildungsstandards dort anders geregelt sind. Daher sollte man auf die Beschreibung der Warnungen auch nicht in der Betriebsanleitung verzichten.

Die Gliederung einer Technischen Dokumentation sollte sich an den Nutzergruppen orientieren. Dabei sollten zur besseren Überschaubarkeit von Informationen diese so aufgeteilt sein, dass nur die für die jeweilige Nutzergruppe benötigten Informationen in einem Abschnitt vorkommen. Das Schichtpersonal an der Anlage benötigt beispielsweise nicht unbedingt Informationen über die Elektrik der Anlage. Ein Elektriker, der sich um die Inbetriebnahme der Anlage kümmert, hingegen schon. Solch eine Aufteilung hilft die Menge an gedruckten Unterlagen für die jeweiligen Personengruppen auf ein Minimum zu reduzieren.

Die Technische Dokumentation einer Anlage unterscheidet sich zu einer normalen Dokumentation eigentlich nur in ihrem Umfang und der Komplexität. Da eine Anlage aus einem Verbund von Maschinen besteht, ist für jede der Maschinen eine Dokumentation notwendig. Häufig füllt eine Anlagendokumentation daher weit mehr als einen Ordner. Bezüglich Organisation und Bereitstellung der Dokumentation einer Anlage muss sich der Hersteller überlegen, wie er diese bereitstellt. Sinnvoll ist es, die Dokumente auf die jeweiligen Arbeitsstationen und/oder Nutzergruppen anzupassen und nur die benötigten Informationen bereitzustellen.

Der Benutzer blickt zuerst in das Inhaltsverzeichnis einer Technischen Dokumentation. Darin möchte er schnell seine gesuchte Information finden. Die richtigen Überschriften der einzelnen Kapitel sind daher wichtig, um dem Nutzer eine einfache Art der Navigation durch das Dokument zu ermöglichen. Sind die Überschriften sinnvoll gewählt, kann der Benutzer sich leicht durch die Struktur und Inhalt der Anleitung durcharbeiten. Innerhalb des Textes kann der Autor seinen Text mit kleinen Zwischenüberschriften auflockern und diesen so einfacher und schneller lesbar machen.

Der Leser der Technischen Dokumentation soll sich angesprochen fühlen. Es ist daher nicht ratsam, sich beim Text verfassen hinter einer unpersönlichen Ausdrucksweise zu verschanzen. Eine Handlungsanweisung wie „Der Schalter ist zu drücken“ ist für den Leser nicht sonderlich ansprechend. Eine persönliche Aufforderung wie „Drücken Sie den Schalter“ spricht den Leser mehr an und verleitet Ihn zudem auch eher zum Handeln als eine passive Ansprache.

Um eine verständliche Technische Dokumentation zu schreiben, ist der Stil beim Erstellen des Textes ein wichtiges Kriterium. Ist die Satzkonstruktion beispielsweise sehr kompliziert, verstehen die Leser die Inhalte der Dokumentation nicht. Viele Nebensätze erschweren das Lesen des Inhaltes und können für den Leser verwirrend sein. Kürzere und prägnante Sätze mit weniger als 20 Wörtern sind besser für die Technische Dokumentation. Zu viele kurze Sätze wiederum könnten auf den Leser aufdringlich wirken. Es kommt also auf die wichtige Abwechslung von langen und kurzen Sätzen an.

Eine Technische Dokumentation beinhaltet unterschiedliche Abbildungen wie Fotografien von Bauteilen oder von Maschinen, aber auch 3D-Abbildungen oder Schemazeichnungen. Schnittansichten und Explosionsdarstellungen eignen sich für die Darstellung von komplexen Sachverhalten. Schemazeichnungen oder auch Strichzeichnungen bieten sich an, da diese Informationen einfacher darstellen können als reale Fotos. Eine Illustration lässt sich zudem leicht verändern, um bestimmte Details im Bild hervorzuheben.

Es ist nicht möglich, die Lieferung der Technischen Dokumentation zu einer Maschine oder einem anderen Erzeugnis vertraglich zu umgehen. Das Produktsicherheitsgesetz macht bezüglich der Betriebsanleitung genaue Angaben. Der Paragraf 3 listet unterschiedliche Anforderungen an die Bereitstellung von Produkten auf dem Markt auf. Unter anderem ist auch von einer Gebrauchs- und Bedienungsanleitung bzw. einer Anleitung für Zusammenbau, Installation, Wartung und Gebrauchsdauer die Rede. Die Anleitung ist als Teil des Produktes anzusehen und deswegen ist auch ein vertraglicher Ausschluss nicht möglich.

Möchte man eine Technische Dokumentation erstellen, stellt sich die Frage mit welcher Software man diese erstellen soll. Ein offensichtlicher Vorteil für Word als Programm zur Erstellung einer Betriebsanleitung ist die Bekanntheit und die große Verbreitung dieses Programmes. Es ist gut möglich, dass die Software bereits im Unternehmen zum Einsatz kommt und man diese nicht mehr anschaffen muss. Die Handhabung von Word ist einfach und das benötigte Wissen für den Umgang mit dem Programm ist schnell vermittelt. Die Funktionen von Word erlauben es zudem eine optisch ansprechende und benutzerfreundliche Betriebsanleitung zu erstellen. Muss man nicht häufig und viele Anleitungen erstellen, kann Word eine günstige und ausreichende Software-Lösung sein, um die Technische Dokumentation zu erstellen.

Da Microsoft Word nicht speziell für das Schreiben einer Technischen Dokumentation entwickelt ist, bietet diese Software auch entsprechende Nachteile.

Word hat im Gegensatz zu einem Redaktionssystem keine Funktion für die Archivierung und das Einfrieren von einzelnen Druckständen. Jeder Druckstand von einer Betriebsanleitung muss aufgrund der Produkthaftung für 10 Jahre vorgehalten werden. Eine mit Word erstellte Betriebsanleitung kann im Nachhinein nur schwer geändert werden. Änderungen an einer Stelle in der Anleitung haben Auswirkungen auf die Formatierung anderer Stellen, weswegen zusätzliche Arbeit für den Redakteur entsteht. Durch Speichern von überarbeiteten Dokumenten in Word wird entweder der alte Stand überschrieben oder die Übersichtlichkeit geht verloren, weil für jeden Stand eine neue Datei abgelegt werden muss.

Auch ist Word nicht für viele Bilder ausgelegt. Die Dateigröße eines Word Dokumentes kann bei vielen Abbildungen schnell ansteigen. Das führt unter Umständen dazu, dass Word öfters mal abstürzt und für Frustration beim Dokumentenersteller sorgt. Auch ist Word nicht als Programm für eine Technische Dokumentation sinnvoll, wenn die Produktpalette des Herstellers groß ist aber sich die Produkte sehr ähneln. Sind viele Teile in einer der Anleitung auch in den anderen Anleitungen verwendbar, lohnt sich der Einsatz von Word als Erstellungsprogramm nicht mehr. In diesem Fall ist ein Redaktionssystem sinnvoller, da diese extra dafür ausgelegt sind Texte als Bausteine wieder zu verwenden.

Ein Redaktionssystem in der Technischen Dokumentation bietet den Redakteuren mehrere Vorteile beim Erstellen einer Betriebsanleitung.

  • Das Nachvollziehen von einzelnen Ständen der Betriebsanleitung ist mit einem Redaktionssystem einfach möglich. Jeder Bearbeitungsstand ist im Nachhinein einsehbar. Dadurch ist einfach nachvollziehbar, was in der letzten Version geändert worden ist.
  • Übersichtlichkeit und Verwaltung von Inhalten ist mit einem Redaktionssystem einfacher als mit einem herkömmlichen Textprogramm.
  • Die Wiederverwendbarkeit erstellter Inhalte in anderen Anleitungen ist ein großer Vorteil eines Redaktionssystems. Ein einmal erstellter Textbaustein kann dann in mehreren Anleitungen zum Einsatz kommen. Dadurch sinken die Übersetzungskosten, da der Baustein nur ein einziges Mal übersetzt werden muss. Die Übersetzung kommt dann in allen anderen Anleitungen vor, in denen der Baustein verlinkt ist.
  • Sind Informationen innerhalb der Anleitung auszutauschen, erleichtert ein Redaktionssystem diesen Prozess. Es ist einfach ein Kapitel, Absatz oder Satz auszutauschen, zu verschieben oder zu verändern. Markierungen und Verweise in den nachfolgenden Absätzen bzw. Seiten aktualisieren sich zudem automatisch.

Der Einsatz eines Redaktionssystem in der Technischen Dokumentation ist kostspielig und die Einführung eines solchen Systems benötigt viel Zeit. Die Lizenzkosten für die Anschaffung eines Redaktionssystem unterschieden sich zudem von Anbieter zu Anbieter der Systeme. Häufig sind zusätzliche Funktionen über Plugins hinzubuchbar. Die Einarbeitung der Mitarbeiter in das neue Programm ist ebenfalls als ein Nachteil wertbar. Das Personal muss erst das erforderliche Wissen und Know-How im Umgang mit dem Redaktionssystem erlernen. Die Arbeitsweise der Technischen Redakteure muss sich an die neuen Strukturen und Arbeitsprozesse des Systems erst anpassen. Die bisherigen Dokumente müssen zudem in die neue Redaktionssoftware eingearbeitet werden.

Der Einsatz eines Redaktionsleitfaden in der Technischen Dokumentation ist dann sinnvoll, wenn mehrere Redakteure unterschiedliche Informationsprodukte erstellen. Die Zusammenarbeit von mehreren Redakteuren ist anders als bei einer „Ein-Mann-Redaktion“, da jeder Beteiligte seine eigene Schreibweise und Stil hat. Auch um unterschiedliche Arbeitsweisen und Methoden zu überdenken und zu vereinheitlichen, hilft ein Redaktionsleitfaden in der Technischen Dokumentation. Falls neue Werkzeuge zur Dokumentation in die Redaktion Einzug halten ist es sinnvoll, die Arbeitsabläufe durch einen Redaktionsleitfaden zu verbessern.

Sind sie auf der Suche nach einer Redaktionsleitfaden Vorlage? Dann finden Sie hier unseren Muster-Redaktionsleitfaden!

Von einem Redaktionsleitfaden in der Technischen Dokumentation können mehrere Beteiligten profitieren. Das können neben den Technischen Redakteuren auch Konstrukteure, Entwickler oder externe Dienstleister sein. Grafiker und Illustratoren, die neben den Redakteuren separat arbeiten, zählen ebenfalls dazu. Aber auch andere Abteilungen wie Marketing, technischer Kundendienst oder die Unternehmensleitung können von einem Redaktionsleitfaden in der Technischen Dokumentation profitieren. Neue Mitarbeiter in den Abteilungen profitieren von dem Redaktionsleitfaden als ein Hilfsmittel zur Einarbeitung in die organisatorischen und arbeitstechnischen Prozesse.

Sind sie auf der Suche nach einer Redaktionsleitfaden Vorlage? Dann finden Sie hier unseren Muster-Redaktionsleitfaden!

Ein Redaktionssystem erleichtert in der Technischen Dokumentation die Verwaltung von vielen Betriebsanleitungen und deren einzelnen Entwicklungsstände. Eine eingebaute Versionierungsfunktion im Redaktionssystem erlaubt die Änderungen in den einzelnen Ständen leicht nachzuvollziehen. Dies ist dann hilfreich, wenn eine Betriebsanleitung häufig zu überarbeiten ist. Zudem ist das Wiederverwenden von Textbausteinen in anderen Anleitungen durch ein Redaktionssystem erleichtert .

Um eine Maschine beim Transport sicher zu bewegen, muss in der Technischen Dokumentation auch Angaben zu dem Transport einer Maschine stehen. Dazu gehören Angaben zu den zulässigen Transportmitteln wie das die Maschine nur mit einem Gabelstapler zu bewegen ist. Die Betriebsanleitung muss auch nennen welche Hubkraft das benötigte Transportmittel vorweisen muss. Muss das zuständige Personal für den Transport besondere Vorkehrungen treffen, ist das ebenfalls in der Technischen Dokumentation mit anzugeben.

Die Technische Dokumentation muss auch Angaben zu der Verpackung einer Maschine enthalten. Dazu zählen beispielsweise die Angaben zum sicheren Auspacken der Maschine. Ebenso gilt es zu erläutern, wie die Maschine wieder zu verpacken ist. Sind mögliche (Rest-)Risiken beim Aus- bzw. Verpacken bekannt, müssen in der Betriebsanleitung auch entsprechende Warnhinweise vorkommen.

Die Technische Dokumentation von Zulieferer weißt mittels Sicherheitshinweise auf Gefahren hin. In wie weit es sinnig ist, in der eigenen Betriebsanleitung mit Sicherheitshinweise auf die Sicherheitshinweise der Zulieferer zu verweisen, hängt ganz von der Situation ab. Das Teil des Zulieferers wird in die eigene Maschine integriert. Wenn die Gefahr aus dem Teil des Zulieferers nun mit konstruktiven Mitteln sicher eingebaut wird, ist die daraus entstandene Maschine als sicher anzusehen. Eine erneute Warnung vor dem Teil des Zulieferers ist dann nicht mehr sinnvoll. Die Technische Dokumentation bläht sich sonst nur mit unnötigen Inhalten auf.

In der Praxis hat sich ein gewisses Schema für den Aufbau einer Software Dokumentation etabliert. Zuerst beschreibt man die Grundlagen der Software. Die Anleitung beschreibt hierbei zuerst was für eine Funktion die Software hat und wie das Programm funktioniert.

Danach geht man auf Datenstrukturen ein und was zu berücksichtigen ist, wie biespielsweise was alles beim Quellcode relevant ist. Oder welche Test die Software durchlaufen haben muss, um Ihre Funktionalität zu prüfen. Im Anschluss geht man darauf ein, welche Hardware und Software erfoderlich ist, um das Programm zu nutzen. Da eine Software häufig weiterentwickelt wird, sollten auch die Unterschiede der jeweiligen Versionen festgehalten werden. Hierfür sollte am Ende der Software Dokumentation noch Platz sein, um Ergänzungen einzutragen.

Eine Software Dokumentation soll grundsätzlich drei Fragen rund um ein Programm erläutern.

  1. Wie funktioniert das Programm?
  2. Wie wird das Programm bedient?
  3. Wie wurde die Software entwickelt?

Mit Beantwortung dieser Fragen deckt die Software Dokumentation auch alle unterschiedlichen Zielgruppen ab. Die Anleitung zu Software soll sowohl für den Einkäufer eines Unternehmens, wie auch für einen Programmierer eine Hilfe sein. Alle benötigten Informationen zur Nutzung der Software soll der User schnell und einfach innerhalb der Software Dokumentation finden können.

Das Schreiben einer Software Dokumentation unterscheidet sich von einer normalen Technischen Dokumentation. Wie die Anleitung für Software aufgebaut ist, hängt davon ab wie häufig man die Software verwendet.

Bei einmaliger Nutzung möchte der Anwender schnell und ohne seitenlanges Lesen handeln. Hier genügt eine Kurzanleitung oder Checkliste, welche die richtige Bedienung sicherstellt. Eine komplexe Software, die regelmäßig zum Einsatz kommt, hingegen, bedarf unterstützende Erläuterungen, die der Anwender in sich aufnehmen kann. Der Nutzer will nicht bei jeder Anwendung die Software Dokumentation zur Rate ziehen. Hier muss die Anleitung eine systematische Einarbeitung in die Grundlagen der Software bieten und Zusammenhänge verständlich erklären.

Um eine Technische Dokumentation zielgruppengerecht aufzubereiten, gilt es auch im Bereich der textlichen Gestaltung einiges zu beachten. So sollte der Satzaufbau der Betriebsanleitung einfach gehalten sein. Handlungen beschreibt man in kurzen und verständlichen Sätzen. Der Schreibstil der Betriebsanleitung sollte von der Verständlichkeit auf die jeweilige Benutzergruppe der Betriebsanleitung angepasst sein.

Die gewählten Schriftarten, Schriftgrößen und Abstände in der Betriebsanleitung sollen eine optimale Lesbarkeit der Anleitung garantieren. Die Technische Dokumentation soll bei einem regulären Leseabstand gut zu lesen sein, damit alle darin vorkommenden Informationen einfach aufzunehmen sind. Auch sollten wenige Fachbegriffe zum Einsatz kommen. Wenn nicht anders möglich, dann gilt es die vorkommenden Fachbegriffe in einem Glossar zu erläutern und ebenfalls kein unbekanntes Fachjargon ohne Erläuterung in der Betriebsanleitung zu verwenden. Am besten pflegt man eine Terminologiedatenbank, um die Vielzahl unterschiedlicher Benennungen von Fachbegriffen zu vereinheitlichen.

Die Technische Dokumentation enthält viele Informationen für den Benutzer einer Maschine. Dazu zählen auch Handlungsanweisungen für verschiedenen Bedienungsabläufe. Diese sollten klar und kurz formuliert sein. In jedem Satz sollte zudem nicht mehr als eine Handlung beschrieben sein, um die Informationsmenge für den Nutzer überschaubar zu halten. Auch sollte man den Leser in diesen Handlungsanweisungen aktiv anschreiben. Passive Formulierungen wie „Der Schalter ist zu drücken“ sind indirekt formuliert und sprechen den Benutzer nicht an. Die direkte Anrede mit Formulierungen wie „Drücken Sie den Schalter“ fordern den Nutzer dagegen aktiv zu einer Handlung auf.

Eine Technische Dokumentation enthält häufig Abbildungen auf verschiedenen Arten. Unter anderem Fotografien von Bauteilen, Werkzeugen oder der Maschine aber auch 3D-Abbildungen oder Schemazeichnungen. Doch wann sollte welche Art der Abbildung eingesetzt werden?

3D-Abbildungen können komplexe Sachverhalte darstellen und eigenen sich für Schnittansichten, Explosionsdarstellungen oder Übersichtdarstellungen einer Maschine. Zudem liegen 3D-Modelle schon früh im Produktentwicklungsprozess vor und können früher verwendet werden als reale Bilder.

Fotos die direkt am Objekt oder aus Marketingaufnahmen erstellt werden, schaffen räumliche Nähe und eine leichte Erfassbarkeit von Zusammenhängen. Die realen Aufnahmen eigenen sich für die Abbildung einzelner Teile bzw. Baugruppen. Vor allem als handlungsorientierte Abbildungen eigenen sich Fotos in der Betriebsanleitung. Technische Illustrationen wie Schemazeichnungen oder auch Strichzeichnungen bieten sich an, wenn reale Fotos den Zusammenhang nicht einfach darstellen können. Ebenfalls um auf bestimmte Details im Bild oder Zusammenhänge hinzuweisen, bieten sich Illustrationen an, da diese schnell änderbar sind.

Die interne Technische Dokumentation enthält alle notwendigen Unterlagen zur Entwicklung, Fertigung und Prüfungen der Eigenschaften des Produktes und verbleiben im Unternehmen des Herstellers. Hierzu zählen die Risikobeurteilung, technische Zeichnungen, Berechnungsunterlagen, Versuchsberichte, Pflichtenhefte und Nachweise hinsichtlich Qualitätssicherungsmaßnahmen. Nur in bestimmten Fällen wie zur Absicherung der Produkthaftung gilt es die interne Technische Dokumentation den Behörden vorzulegen. Damit weißt der Hersteller nach, dass er nicht gegen seine Pflichten bezüglich Konstruktion und Fabrikation verstoßen hat.

Normen, Richtlinien und Gesetze legen keine Vorschriften fest, die besagen dass eine Technische Dokumentation nur in Papierform vorliegen darf. Betriebsanleitungen in elektronischer Form müssen wie gedruckte Anleitungen leicht verständlich sein und den Anforderungen aus Normen, Richtlinien und Gesetzen entsprechen. Die gesetzliche Verpflichtung eine Technische Dokumentation 30 Jahren aufzubewahren, könnte sich bei einer ausschließlich elektronischen Form zudem als kompliziert erweisen. Falls die Dokumentation auf einer CD gespeichert ist, ist nicht gesichert, dass in 30 Jahren noch entsprechende Wiedergabegeräte verfügbar sind.

Die Technische Dokumentation einer Maschine oder auch die Bedienungsanleitung eines Produktes muss Angaben über eine mögliche vorhersehbare Fehlanwendung enthalten. Die Bereitstellung eines Produktes auf dem Markt darf nur erfolgen, wenn bei bestimmungsgemäßer oder vorhersehbarer Verwendung das Produkt sicher ist. Das heißt auch, dass bestimmte Arten von Fehlanwendungen, die sich aus einem absehbarem menschlichem Verhalten ergeben kann, nicht auszuschließen sind. Vor dieser vernünftigerweise vorhersehbaren Fehlanwendung gilt es in der Technischen Dokumentation zu warnen.

Ein Hersteller von einer Maschine erstellt die Technische Dokumentation. Das geistige Eigentum bzw. die Urheberrechte einer erstellten Betriebsanleitung bleiben beim Ersteller. Die DIN ISO 16016 legt Schutzvermerke fest, die eine missbräuchliche Anwendung von technischen Dokumenten verhindern soll. Mit Schutzvermerken in der Betriebsanleitung wie „Weitergabe sowie Vervielfältigung dieses Dokuments, Verwertung und Mitteilung seines Inhalts sind verboten, soweit nicht ausdrücklich gestattet.“ macht der Ersteller auf die Existenz eines Urheberrechts für die erstellte Technische Dokumentation aufmerksam.

Fehler: Kontaktformular wurde nicht gefunden.

Die Technische Dokumentation hilft dem Betreiber einer Maschine bei der regelmäßigen Prüfung einer Maschine auf Defekte oder Mängel. Wie oft eine Prüfung stattfinden muss und welche Sachen zu prüfen sind, steht nämlich in der Betriebsanleitung der Maschine. Angaben über die Art und Häufigkeit, das eingesetzte Material, Werkzeuge sowie detaillierte Beschreibungen zu den Tätigkeiten sind dort aufgeführt. Die Technische Dokumentation gibt zudem auch Auskunft darüber über welche Qualifikation das eingesetzte Personal für diese Tätigkeiten verfügen muss.

Es ist gut möglich, dass die Marktüberwachung die Technische Dokumentation für eine Maschine zur Einsicht einfordert. Kommt ein Mensch bei der Benutzung einer Maschine zu Schaden und meldet dies den Behörden, schaltet sich die Marktaufsicht ein. Die zuständige Marktaufsichtsbehörde untersucht dann die Betriebsanleitung nach gravierenden Mängeln. Findet die Marktüberwachung heraus, dass die Technische Dokumentation unzureichend ist, kann die Behörde mit dem unmittelbaren Rückruf aller sich am Markt befindlichen Geräten drohen, bis die Mängel in den Dokumenten behoben sind. Der Hersteller bekommt möglicherweise noch die Auflage allen Kunden, die das Produkt bereits gekauft haben, eine neue Dokumentation zu schicken. Weiterhin kann die Marktaufsicht vom Hersteller verlangen eine entsprechende Warnung vor Gebrauch des Produktes auf seiner Internetseite zu veröffentlichen.

Welche Angaben bezüglich der Wartung einer Maschine in der Technischen Dokumentation stehen müssen, dazu macht die Maschinenrichtlinie 2006/42/EG keine genauen Angaben.

Die Betriebsanleitung sollte Angaben dazu enthalten, welche Routinemaßnahmen der Kunde selbst gefahrlos durchführen kann. Wenn umfangreiche Kenntnisse eine Voraussetzung zur Wartung sind, kann der Hersteller auf seinen Service zur Wartung der Maschine verweisen. Der Hersteller sollte aber keine Informationen in der Technischen Dokumentation ohne sachliche Rechtfertigung vorenthalten. Falls Informationen ausschließlich aus ökonomische Gründen nicht in der Anleitung stehen, dann könnte diese Verhaltensweise als wettbewerbsrechtlich bedenklich gelten.

Ein Feuerlöscher benötigt eine Technische Dokumentation samt Betriebsanleitung, da ein Feuerlöscher unter die europäische Richtlinie 2014/68/EU über Druckgeräte fällt. Diese fordert, dass bei der Bereitstellung von Druckgeräten am Markt eine Betriebsanleitung vorliegen muss und Angaben enthalten soll zu: 

  • Montage
  • Inbetriebnahme
  • Benutzung
  • Wartung und Inspektion

Im Falle eines Feuerlöschers reicht der Platz auf dem Gerät nicht aus, um alle wichtigen Informationen bezüglich Montage, Gebrauch, Wartung, Sicherheitshinweise, usw. auf dem Gerät in einer bebilderten Kurzanleitung abzudrucken. Daher ist eine Technische Dokumentation für einen Feuerlöscher anzufertigen, die alle notwendigen Sicherheitshinweise enthält.

Die Farbgestaltung von Sicherheitszeichen in der Technischen Dokumentation unterteilen die jeweiligen Zeichen in Ihre Bedeutung. Blaue Kennzeichen repräsentieren Gebotszeichen, während rote Zeichen für Verbotsschilder stehen. Dann gibt es noch gelbe Warnschilder, die vor einer potenziellen Gefahrenquelle warnen. Ein bekanntes Beispiel in der Technischen Dokumentation ist beispielsweise das gelbe Warnschild mit einem schwarzen Blitz, der vor gefährlichen elektrischen Spannungen warnt.

Die Norm DIN EN ISO 13857 ist eine sicherheitsspezifische Norm und regelt hierzu Vorgaben über Sicherheitsabstände in der Technischen Dokumentation. Die Sicherheitsabstände sind geeignet für die Absicherung von Gefährdungsbereichen (z. B. Roboter, Stanzen, Pressen usw.) in öffentlichen und gewerblichen Bereichen. Die Norm enthält dazu Informationen über Abstände, die den freien Zugang durch die unteren Gliedmaßen verhindern sollen.

Für die Technische Dokumentation enthält die DIN EN ISO 13849 direkte Angaben über die Erstellung von Benutzerinformationen. Die Norm ist daher auf die Sicherheit von Maschinen und den sicherheitsbezogenen Teilen von Steuerungen einer Maschine ausgelegt. Die Norm weist zudem auch auf die wichtige Relevanz der Anforderungen aus der Sicherheitsgrundnorm DIN EN ISO 12100 hin. Für die Technische Dokumentation sind dazu unter anderem folgende wichtige Punkte aufgeführt, die man beachten sollte:

  • Information zur Erklärung der Einsatzmöglichkeiten
  • Mittel zur leichten und sicheren Fehlersuche
  • Instandhaltung sowie Checklisten für die Instandhaltung
  • Auswirkungen von Abweichungen von der bestimmten Leistung für die Sicherheitsfunktion
  • Begreifliche Schilderung der Schutzeinrichtungen
  • Informationen zu Betriebsarten, Anzeigen und Alarmsignale

Die Technische Dokumentation einer Maschine weist neben der bestimmungsgemäßen Verwendung auch auf eine Anwendung hin, die nicht beabsichtigt ist. Der Fehlgebrauch der Maschine ergibt sich meistens aus dem menschlichen Verhalten. Ist mit einem Missbrauch des Produktes zu rechnen, so muss dazu die technische Dokumentation auf diesen vorhersehbaren Fehlgebrauch hinweisen. Die völlige Zweckentfremdung der Maschine soll dabei keine Betrachtung finden, nur die vom Hersteller vorhersehbare Fehlanwendung gilt es zu betrachten.

In Hinsicht auf die Technische Dokumentation regelt die Verordnung 2016/425 die Angaben für die persönliche Schutzausrüstung. Eine vollständige Beschreibung der Schutzausrüstung sowie ihrer bestimmungsgemäßen Verwendung muss laut der Verordnung in den Technischen Unterlagen des Produktes stehen. Weiterhin gehört eine Beurteilung von Risiken zu den Unterlagen der Technischen Dokumentation. Darin ist festgehalten, vor welchen Risiken die persönliche Schutzausrüstung schützen soll. Berichte über durchgeführte Prüfungen zur Ermittlung der Schutzklasse müssen ebenfalls in den Unterlagen vorhanden sein. Die Fundstellen der harmonisierten Normen, die bei Entwurf und Herstellung der Schutzausrüstung Anwendung fanden, sind auch ein Teil der Unterlagen.

Ja, es ist durchaus sinnvoll in der Technischen Dokumentation die Einnahme von leistungssteigernden Drogen, Medikamente oder Alkohol zu verbieten. Vor allem im amerikanischen Markt nehmen viele Arbeitnehmer am Arbeitsplatz Mittel zur Leistungssteigerung ein. Alkohol spielt zudem bei einer großen Prozentzahl der Arbeitsunfälle eine Rolle. Alkoholkranke sind dabei häufiger in Unfälle verwickelt als gesunde Personen. Deshalb sollten auch im Umgang mit Maschinen eindeutige Regeln und Konsequenzen zum Umgang mit Alkohol, Drogen oder leistungssteigernde Medikamente bekannt sein.

Die Technische Dokumentation muss vor schadhaften Materialen warnen, wenn die verwendeten Materialien einer Maschine für den Benutzer schadhaft sind. Ebenso muss die Technische Dokumentation Angaben enthalten, welche Materialien wie beispielsweise Metalle, Kunststoffe, Textilien oder Lacke für die Maschine in Betracht kommen. Soweit noch Risiken für den Benutzer verbleiben, müssen geeignete Schutzmaßnahmen den Benutzer vor diesen Gefährdungen schützen. Falls erforderlich sind zudem entsprechende Warnhinweise an der Maschine angebracht und in die Technische Dokumentation abgedruckt.

In der Technischen Dokumentation müssen Angaben dazu stehen, was nach dem Betätigen der Not-Halt-Bedienung zu machen ist, um die Maschine wieder betriebsbereit zu machen. Die Betriebsanleitung soll den Vorgang, um die Not-Halt-Bedienung wieder zu entriegeln und die Maschine wieder in Gang zu bringen beschreiben.

In der Technischen Dokumentation befasst sich die Norm DIN EN ISO 13850 „Sicherheit von Maschinen – Not-Halt-Funktion – Gestaltungsleitsätze“ mit den Not-Halt-Vorrichtungen von Maschinen. Dabei unterteilen sich die Funktionen der Not-Halt Vorrichtungen in unterschiedliche Kategorien je nach technischen Bedingungen.

Kategorie 0:

Sofortige Trennung der Energiezufuhr von der Maschine. Dies nur wählen, wenn das plötzliche Abschalten der Energie keine Gefährdung verursacht.

Kategorie 1:

Versetzung der Maschine in einen sicheren Zustand durch gesteuertes Stillsetzen. Trennung von der Energiezufuhr erst nach Stillsetzen, da Energien für Bremsungen oder ähnliches noch benötigt wird.

Kategorie 2:

In dieser Kategorie ist die Maschine in einen sicheren Zustand versetzt, die Energie verbleibt jedoch in der Maschine. Nur anzuwenden wenn keine technische Möglichkeit besteht die Energie gefahrlos zu trennen. Eine Maschine mit einem Greifer, der eine Last mittels einem Magneten anhebt, wäre dazu ein Beispiel für diese Kategorie. Das Abschalten der Energie führt dann zum Abstürzen der Last vom Greifer.

Die Technische Dokumentation von Maschinen hat im deutschen Sprachgebrauch für die Notfallfunktionen an einer Maschine die Begriffe Not-Aus und Not-Halt. Not-Aus stand für die Funktion der Unterbrechung der Energiezufuhr (=Abschalten) zu einer Maschine, während Not-Halt für das Stillsetzten von beweglichen Maschinenteilen (=Anhalten) Verwendung fand.  Der Begriff Not-Aus schaffte es aber hauptsächlich wegen einem Übersetzungsfehler in die Technische Dokumentation. Der englische Begriff „emergency stop“ wurde fälschlicherweise mit Not-Aus übersetzt. In aktuellen Fassungen von einigen Normen wie beispielsweise DIN EN ISO 13850 findet man aber nur noch den Begriff Not-Halt. Zudem verwendet die aktuelle Fassung der Maschinenrichtlinie 2006/42/EG nur noch den Begriff Not-Halt.

Dem Aufbau einer technischen Dokumentation nach der Druckgeräterichtlinie 2014/68/EU sind Informationen beizufügen, die dem Benutzer alle erforderlichen Angaben bereithält für eine sichere Nutzung des Druckgerätes. Dazu gehören Informationen zur Montage einschließlich der Verbindung verschiedener Druckgeräte, die Inbetriebnahme, die Benutzung und die Wartung einschließlich Inspektion durch den Benutzer. Ebenfalls ist eventuell auf Entwurfsmerkmale hinzuweisen, die für die Lebensdauer des Gerätes von Belang sind. Das können beispielsweise die Auslegungslebensdauer in Stunden bei spezifizierten Temperaturen sein oder die Anzahl von Auslegungszyklen bei spezifizierten Spannungswerten bevor das Geräte möglicherweise ermüden könnte.

Die Technische Dokumentation muss Angaben dazu enthalten, was bezüglich der Wiederinbetriebnahme nach Betätigen der Not-Aus-Vorrichtung zu beachten ist. Es muss beschrieben sein, wie die Maschine nach Stillsetzen der Energiezufuhr durch die Not-Aus-Vorrichtung wieder in Gang zu setzen ist. Dazu gehört wie eine mögliche Verriegelung der Not-Aus-Vorrichtung aufzuheben ist und welche Schritte für die Wiederinbetriebnahme des Arbeitsprozesses einzuleiten sind.

Technische Dokumentation erstellen für eine Maschine oder Anlage heißt auch, sich mit den in der Anleitung vorkommenden Symbolen auseinanderzusetzten. Beispielsweise welches Symbol man für die Kennzeichnung von Bedienerinformationen verwendet.

Das allgemeine Gefahrenzeichen (Ausrufezeichen im gelben Warndreieck) dient zur Kennzeichnung von Sicherheits- oder Warnhinweise. Um andere wichtige Textstellen für den Bediener zu kennzeichnen, darf das allgemeine Gefahrenzeichen keine Anwendung finden. Zum einem wertet es das Gefahrenzeichen ab, da es in einer Anleitung dann viel häufiger vorkommt als es sollte. Zum anderen irritiert es den Leser, wenn das Symbol, welches für Warnungen vor Gefahren gedacht ist, anderweitig zum Einsatz kommt.

Für die Kennzeichnung von wichtigen Bedienerinformationen in der Technischen Dokumentation stehen andere Symbole wie beispielsweise ein blaues Informationszeichen zur Verfügung.

Die Betriebsanweisung einer Maschine soll dem Benutzer wichtige Verhaltensregeln im Umgang mit der Maschine vermitteln und benötigte Schutzvorkehrungen erläutern. Bei relevanten Änderung des Arbeitsmittels oder seiner Benutzung, wie durch Umbau der Maschine, muss der Betreiber seine technischen Unterlagen überarbeiten. Dazu zählen unter anderem die Pläne, Gefährdungsbeurteilung und auch die Betriebsanweisung einer Maschine.

Die für eine unvollständige Maschine notwendige Montageanleitung erstellen wir Ihnen gerne auf Wunsch. Dieses von der Maschinenrichtlinie geforderte Dokument, damit eine unvollständige Maschine überhaupt in Verkehr gehen darf, und auch weitere Dokumente im Bereich der Technischen Dokumentation gehören zu unserem Leistungsspektrum. Wir unterstützen Sie beispielsweise bei der Erstellung einer Risikobeurteilung, die ebenfalls für eine unvollständige Maschine gefordert ist.

Sie benötigen für Ihr Software Projekt Unterstützung um Ihr Handbuch erstellen zu können?

Eine komplizierte Software benötigt ebenfalls eine Dokumentation für den Endanwender. Solch eine Dokumentation ist ähnlich aufgebaut wie eine Betriebsanleitung für eine Maschine. Das Handbuch soll den Benutzer anleiten, wie die Software aufgebaut ist, was für den Betrieb erforderlich ist und wie sie zu benutzen ist.

In Bezug auf die Zielgruppe einer Maschine fordert die Maschinenrichtlinie, dass die Informationen für den Benutzer auch dem Kenntnisstand der jeweiligen Zielgruppen entsprechen müssen.

Diese Forderung der Maschinenrichtlinie unterstreicht die Wichtigkeit der Durchführung einer Zielgruppenanalyse. Unter den Anwendern einer Maschine befinden sich unterschiedliche Nutzer, die über unterschiedliche Wissensstände verfügen. Die Benutzerinformationen muss man den Anforderungen dieser unterschiedlichen Personengruppen entsprechend anpassen.

Im Januar 2018 veröffentlichten die Normengremien einen neuen Entwurf für eine Norm zur Technischen Dokumentation. Die Norm DIN EN ISO 20607 ergänzt die Norm zur Erstellung von Betriebsanleitungen DIN EN 82079 in Richtung der Maschinensicherheit. Der Entwurf stellt eine Typ-B-Norm dar und kann aufgrund des Status als Sicherheitsgrundnorm für die Konformitätserklärung herhalten. Damit kann ein Hersteller von Maschinen die Vermutung nahelegen, dass seine Maschine die Anforderungen im Rahmen der Maschinenrichtlinie erfüllt. Nähere Informationen zu der DIN EN ISO 20607 in der Technischen Dokumentation finden Sie auch in dieser Podcast Folge.

Eine Dokumentation schreiben bedeutet auch sich mit der Leserlichkeit seines Dokumentes auseinanderzusetzen. Hierfür gibt es drei verschiedenen Gestaltungsmöglichkeiten, um eine Dokumentation leserlich zu gestalten.

Zum einem die Schriftgröße. Wählt man beispielsweise für eine Betriebsanleitung eine Schriftgröße von nur 8 Punkten, ist diese nicht besonders gut lesbar. Möchte man das Dokument mit einem Meter Abstand lesen, empfiehlt es sich eine Schriftgröße von mindesten 14 Punkten zu verwenden.

Die zweite Möglichkeit ist der Helligkeitskontrast zwischen Schrift und Hintergrund. Ein gut lesbarer Text weißt einen hohen Kontrast auf wie es bei 100% schwarzer Schrift auf 100% weißem Hintergrund der Fall ist. Alle unter einem Kontrastwert von 70% ist nicht mehr gut lesbar.

Die letzte Möglichkeit ist die Gestaltung der Seite selbst und die Nutzung der freien Flächen auf einer Seite. Es empfiehlt sich etwa 25 % einer Seite als leere Flächen freizulassen, um eine Seite nicht mit Inhalten zu überladen. Dies hat den Vorteil, dass der Leser die Seite als angenehmer zu lesen empfindet.

Möchten Sie mehr über Gestaltungshinweise zum Dokumentation schreiben erfahren? Dann empfehlen wir Ihnen diese Folge unserer Podcast Reihe „Betriebsanleitung erstellen“ anzuhören.

Bei einer Dokumentation ist der Fachwortschatz oder auch Terminologie genannt für die Verständlichkeit und Eindeutigkeit der Anleitung sehr wichtig. Die Dokumentation muss über eine einheitliche Benennung von Fachausdrücken verfügen.

Die wichtigsten Faktoren bei der Terminologie sind das Festlegen auf eine vorrangige Benennung von einem Fachausdruck. Das ist die Basis für Wiederverwendung, Konsistenz und Verständlichkeit der Dokumentation. Festgelegt Fachausdrücke sind in einer Datenbank abzulegen und allen Beteiligten für die Dokumentation zugänglich zu machen. Dann gilt es Dubletten innerhalb des Dokumentes zu erkennen, das sind ähnliche Benennungen für die gleiche Sache und diese mit der korrekten Benennung auszutauschen. Auch „verbotene“ Synonyme kann man zudem mit in die Datenbank aufnehmen, damit die Benutzer auch die falschen Bezeichnungen für einen Fachausdruck kennen. Die frühzeitige Festlegung der Terminologie ist zudem eine wichtige Voraussetzung für die Übersetzbarkeit der Fachausdrücke.

Wenn an einer alten Maschine weitgehende Veränderungen vorgenommen werden, gilt es auch in der Technischen Dokumentation einiges zu beachten. Falls beispielsweise eine Maschine neue Schutzeinrichtungen erhält oder einen leistungsfähigeren Antrieb, muss man die Maschine nach seiner Veränderung wieder überprüfen. Ist die Veränderung ein wesentlicher Umbau im Sinne der Maschinenrichtlinie, kann es sich sogar um eine neue Maschine halten. Der Hersteller ist dann verpflichtet die Maschine erneut mittels einem Konformitätsbewertungsverfahren zu bewerten, seine Betriebsanleitung anzupassen und die CE-Kennzeichnung neu anzubringen. Jede Änderung an einer Maschine erfordert zudem eine neue Risikobeurteilung, um mögliche neue Gefahren zu identifizieren.

Der Aufbau einer Technischen Dokumentation gliedert sich in eine interne und eine externe Dokumentation. Die Interne Technische Dokumentation wie Risikobeurteilung, Prozessdokumentation, Konstruktionszeichnungen usw. verbleiben im Unternehmen des Herstellers.

Die Externe Technische Dokumentation ist dafür vorgesehen, an Dritte Personen zu gehen. Dazu zählen unter anderem Benutzerinformationen, Betriebsanleitung, Servicehandbuch und/oder Installationsanleitung.

Vorallem die externe Technische Dokumentation hat einen hohen Stellenwert. Fehlt ein Teil wie die Betriebsanleitung ist der Aufbau einer Technischen Dokumentation nicht vollständig und das Produkt gilt als mangelhaft.

Hier finden Sie ausführliche Informationen zur Technischen Dokumentation.

In der Technischen Dokumentation müssen Technische Redakteure die Anforderungen aus verschiedenen Normen beachten. Bei den Normen gibt es zudem Unterscheidungen in A-, B- und C-Normen. Die Abstufung reicht von allgemeinen Aspekten für alle Geräte und Maschinen bis zu produktspezifischen Anforderungen an einzelne Geräte- oder Maschinengruppen. Wenn Angaben in C-Normen von den Angaben in A- oder B-Normen abweicht, haben die Angaben in der C-Norm Vorrang.

Die Verordnung 2016/425 regelt unter anderem die Angaben in Hinsicht auf die Technische Dokumentation von Schutzausrüstungen. Die Verordnung legt fest, dass in den Technischen Unterlagen für die Persönliche Schutzausrüstung (PSA) eine vollständige Beschreibung dieser und ihrer bestimmungsgemäßen Verwendung stattfindet. Weiterhin soll eine Beurteilung von Risiken vorhanden sein, vor denen die PSA schützen soll. Auch müssen Berichte über durchgeführte Prüfungen zur Ermittlung der Schutzklasse vorhanden sein. Die Technische Dokumentation von Schutzausrüstungen muss ebenfalls Fundstellen der harmonisierten Normen enthalten, die bei Entwurf und Herstellung der Schutzausrüstung Anwendung fand.

Wir decken das komplette Leistungsspektrum im Bereich der Technischen Dokumentation ab. Wir beraten Sie gerne dazu, wenn es darum geht eine Betriebsanleitung erstellen zu lassen. Weiterhin übernehmen wir die Erstellung einer Risikobeurteilung, die Durchführung einer Normenrecherche für die CE-Kennzeichnung und die Lokalisierung Ihrer Technischen Dokumentation. Wir überprüfen auch gerne Ihre Betriebsanleitung nach Normen und Richtlinien, um zu sehen ob die Anleitung allen Produkthaftungskriterien entspricht. Nutzen Sie unser Kontaktformular falls Sie eine Beratung wünschen oder schicken uns eine Preisanfrage für ein unverbindliches und kostenfreies Angebot!

Technische Dokumentation ist Aufgabe von Fachleuten und erfordert spezielle Fähigkeiten und Kompetenzen. Nur ausreichend geschulte Personen sollten sich damit befassen, eine Betriebsanleitung zu erstellen und zu überprüfen. Die Personen sollten zudem über kommunikative Kompetenz, Sprachkompetenz, Schreiberfahrung und Methodenkompetenz verfügen. Ebenso sollte die Person mit dem Themenbereich der zu erstellenden Betriebsanleitung wie auch den relevanten Normen zur Erstellung vertraut sein.

Wir überprüfen Ihre Technische Dokumentation im Rahmen unseres Dokuchecks auf die Richtigkeit von Normen und Richtlinien. Sie erhalten in einem ausführlichen Bericht Informationen darüber, was wir in Ihrer Technischen Dokumentation an Unstimmigkeiten gefunden haben. Weiterhin fügen wir im Laufe des Dokuchecks Kommentare an kritischen Stellen in Ihren Dokumenten wie der Betriebsanleitung hinzu. Dadurch ist ein direktes Bearbeiten der Technischen Dokumentation anhand der Kommentare möglich.

Die Zielgruppen einer Technischen Dokumentation tragen gewisse Merkmale. Aus diesen Merkmalen kann man den Informationsbedarf, das Anwenderverhalten und die sprachlichen und gestalterischen Anforderungen an die Technische Dokumentation ableiten. Typische Merkmale von den Zielgruppen sind unter anderem Sozio-demographische Merkmale wie Geschlecht, Alter oder Bildung. Des weiteren gibt es noch verhaltensorientierte Merkmale wie die der Erstkäufer oder der Intensivnutzer. Zudem spielen auch die Psychologischen Merkmale (Motivation, Meinung, Wünsche) der Zielgruppe in der Technischen Dokumentation eine Rolle.

Die Zielgruppen in der Technischen Dokumentation sind vorwiegend die Anwender technischer Produkte. Aber auch die Servicetechniker oder Support-Mitarbeiter zählen zu der Zielgruppe der Technischen Dokumentation. Die Inhalte der Technischen Dokumentation müssen an die jeweiligen Zielgruppen und Ihre Bedürfnisse angepasst sein.

Die Unterschiede von einer internen und externen Technischen Dokumentation im Maschinenbau befassen sich mit der Herausgabe der Inhalte an Dritte. Die Interne Technische Dokumentation wie Risikobeurteilung, Konstruktionszeichnungen usw. verbleibt im Unternehmen. Externe Technische Dokumentation ist dafür vorgesehen, an Dritte Personen zu gehen. Dazu zählen unter anderem Schaltpläne oder die Betriebsanleitung.

Hier finden Sie ausführliche Informationen zur Technischen Dokumentation.

Fehler: Kontaktformular wurde nicht gefunden.

Vermeiden Sie in der Technischen Dokumentation die Verwendung von Begriffen mit absoluter Bedeutung. Diese Begriffe können den Benutzer irreführen und sind zudem vor Gericht juristisch nicht haltbar. Dazu hier einige Beispiele für Begriffe, die man nicht in der Technischen Dokumentation verwenden sollte:

  • Narrensicher
  • unfallsicher
  • betriebssicher
  • wartungsfrei
  • ungefährlich

Setzen Sie stattdessen auf den Einsatz von Gebots- und Warnhinweisen bzw. informative Hinweise in Ihrer Technischen Dokumentation.

Eine Explosionsdarstellung in der Technischen Dokumentation dient dazu, die Einzelteile eines Gerätes oder einer Baugruppe darzustellen. Eine Explosionsdarstellung kommt in Betriebsanleitungen, Wartungshandbüchern und Ersatzteilkatalogen vor, um einen komplexen Gegenstand in seine Einzelteile zu zerlegen. In der Technischen Dokumentation ist es dank umfangreicher Software-Tools einfach eine Explosionsdarstellung zu erstellen.

Der Begriff „starr“ findet Anwendung in der Maschinenrichtlinie im Abschnitt 4.1.2.8.1 des Anhangs I. Damit möchte der Gesetzgeber definieren, dass für Maschinen, die feste Ladestellen anfahren, starre Führungen nötig sind. Hierdurch soll eine sichere Bewegung des Lastträgers zu den Ladestellen und sicherer Zugang zum Lastträger an den Ladestellen möglich sein.

Nein, dies ist rechtlich nicht möglich. Die Maschinenrichtlinie fordert, dass die Betriebsanleitung in der Amtssprache des Landes verfasst ist, in der das Produkt in Verkehr ging. Zudem muss die Betriebsanleitung im Original vorliegen oder als Übersetzung gemeinsam mit dem Original. Beide müssen entsprechend gekennzeichnet sein.

Weiterhin fordert auch das Produktsicherheitsgesetzt nach §3 Absatz 4 folgendes:

„Sind bei der Verwendung, Ergänzung oder Instandhaltung eines Produkts bestimmte Regeln zu beachten, um den Schutz von Sicherheit und Gesundheit zu gewährleisten, ist bei der Bereitstellung auf dem Markt hierfür eine Gebrauchsanleitung in deutscher Sprache mitzuliefern, sofern in den Rechtsverordnungen nach § 8 keine anderen Regelungen vorgesehen sind.“

Eine Betriebsanleitung für eine Maschine darf im deutschen Markt also nicht nur in englischer Sprache vorliegen.

Alle wichtigen Angaben für den Notfall wie beispielsweise Feuerbekämpfungsmaßnahmen, Erste-Hilfe-Maßnahmen, Fluchtwege, usw. sollten in die Betriebsanleitung einfließen. Eine gesetzliche Verpflichtung für eine Angabe in der Betriebsanleitung existiert zwar nicht, doch sind diese Informationen für den Anwender hilfreich. Zudem fordern vereinzelte Normen die Angaben für bestimmte Situationen. So fordert die EN 12100 für die Betriebsanleitung zum Beispiel die Angaben zur Art der zu verwendenden Feuerlöschausrüstung im Notfall. Ebenso Warnhinweise über mögliche Emission oder Leckage von schädlichen Stoffen und, falls möglich, Angaben über Mittel zur Bekämpfung derer Wirkungen.

Eine Maschine dürfen nur entsprechend eingewiesene, geschulte und autorisierte Personen bedienen. Wenn Personen mit unzureichender Personalqualifikation die Maschine bedienen, bestehen akute Gefahren für Mensch und Maschine. In der Betriebsanleitung für eine solche Maschine müssen deswegen genauere Angaben über das Personal stehen, welches die Maschine bedient.

Es ist sinnvoll in der Betriebsanleitung alle Arbeitsbereiche an einer Maschine zu beschreiben. Dazu gehören alle Bedienplätzen, die das Personal an der Maschine besetzen kann. Auch sollten in der Betriebsanleitung die Bedienungseinrichtungen wie Terminals oder Bildschirme beschrieben sein, die ein Benutzer der Maschine betätigen kann.

Eine Maschine darf keine Betriebsarten enthalten, die nicht den grundlegenden Sicherheits- und Gesundheitsschutzanforderungen der Maschinenrichtlinie entsprechen. Sollte dies doch der Fall sein, so müssen diese Betriebsarten mit technischen Mitteln an allen Maschinen nicht benutzbar sein.

Ja; obwohl es für Aufzüge zugeschnittene Richtlinien wie bspw. die Aufzugsrichtlinie 2014/33/EU gibt, können Aufzüge unter die Maschinenrichtlinie fallen. Die Maschinenrichtlinie hat sich zudem mit der überarbeiteten Version 2006/42/EG vermehrt mit Aufzügen beschäftigt. Seither fallen laut Artikel 24 alle Aufzüge mit einer Fahrgeschwindigkeit von mehr als 0,15 m/s auch unter die Maschinenrichtlinie.

Die Hersteller sollten mit ihrer Technischen Dokumentation den erlaubten Verwendungszweck zuerst so eng wie möglich eingrenzen. Formulierungen in der Betriebsanleitung wie „ausschließlich“ oder „nur“ in der bestimmungsgemäßen Verwendung sollen eine missbräuchliche Verwendung im Voraus ausschließen. Zusätzlich sollte man vor bereits bekannten Fehlanwendungen in der Technischen Dokumentation warnen.

Der Inhalt der bestimmungsgemäßen Verwendung in der Technischen Dokumentation enthält mehrere Angaben. Zum einem sind Angaben über den vorgesehenen Verwendungszweck des Produktes anzugeben. Weiterhin müssen Angaben über die Grenzen der Verwendung mit in den Inhalt der Technischen Dokumentation. Dazu gehören zum Beispiel Belastbarkeit, max. Drehzahl rotierender Teile, usw. Ferner müssen Angaben über Einschränkungen der Verwendung, die aus Bezeichnung, Konstruktion und Funktion des Produktes nicht ersichtlich sind, enthalten sein. Dazu zählt unter anderem auch ein Verbot, das Produkt zu verändern, um andere Verwendungszwecke mit dem Produkt zu eröffnen. Vor einer vernünftigerweise vorhersehbaren Fehlanwendung muss man ebenfalls in der Technischen Dokumentation warnen, wenn diese gefährlich ist. Ein Hinweis ist ebenfalls anzugeben auf die Verpflichtung, die Angaben zu Betrieb, Wartung und Instandhaltung in der Betriebsanleitung zu beachten.

Der Abschnitt der bestimmungsgemäßen Verwendung in der Technischen Dokumentation sollte klare, eindeutige Aussagen enthalten. Im Maschinenbau sind die Produkte oft für nur eine sehr genau definierte Anwendung gedacht. Vermeiden Sie daher Formulierungen wie „sollte nicht“ oder „nicht zu empfehlen“ in der Technischen Dokumentation. Derartige Aussagen lassen zudem großen Interpretationsspielraum zu. Die Grenzen der Anwendung sollten durch die bestimmungsgemäße Verwendung in der Technischen Dokumentation so genau wie möglich festgelegt werden.

Ein Kranseil ist ein Lastaufnahmemittel und muss eine Betriebsanleitung enthalten. In der Maschinenrichtlinie (MRL) gibt es entsprechend für Lastaufnahmemittel eine Sonderregelung. Diese sind zwar keine Maschinen im Sinne der MRL, fallen aber gleichwohl unter den Anwendungsbereich der MRL. Lastaufnahmemittel müssen daher den grundlegenden Sicherheits- und Gesundheitsanforderungen entsprechen.

Für Lastaufnahmemittel wie bspw. ein Kranseil schreibt die MRL in Bezug auf eine Betriebsanleitung folgendes vor:

“4.4.1 Lastaufnahmemittel

Jedem Lastaufnahmemittel und jeder nur als Ganzes erhältlichen Gesamtheit von Lastaufnahmemitteln muss eine Betriebsanleitung beiliegen, die mindestens folgende Angaben enthält:
a) bestimmungsgemäße Verwendung;

b) Einsatzbeschränkungen (insbesondere bei Lastaufnahmemitteln wie Magnet- und Sauggreifern, die die Anforderungen der Nummer 4.1.2.6 Buchstabe e nicht vollständig erfüllen);

c) Montage-, Verwendungs- und Wartungshinweise;

d) für die statische Prüfung verwendeter Koeffizient.“

Das Sicherheitskapitel vieler Betriebsanleitungen ist überladen mit Sicherheitshinweisen. Ursachen sind dafür vorwiegend Angst vor rechtlichen Konsequenzen. Zudem die Folgen einer falschen bzw. missverstandenen Risikobeurteilung oder das Normen und Richtlinien nicht richtig bekannt sind.

Um in einer Betriebsanleitung richtig zu warnen, sollte zuerst die Zielgruppe genauesten bekannt sein. Wer liest die Betriebsanleitung und nutzt das Produkt?  Diese Nutzer gilt es richtig anzuleiten und zu informieren. Zudem sollte man in der Betriebsanleitung erst dann warnen, wenn konstruktiv die Fehler nicht behebbar sind und durch Schutzmaßnahmen die Benutzer nicht aus dem Gefahrenbereich ausgeschlossen werden.

Viele Warnhinweise in einer Betriebsanleitung können die Anleitung sehr unübersichtlich machen. Wenn viele Sicherheitshinweise hintereinander angeordnet sind, lösen diese in der psychologischen Wahrnehmung des Benutzers die falsche Reaktion aus. Viele Sicherheitshinweise führen dann dazu, dass der Benutzer diese schnell überfliegt und nicht beachtet.

Da ein mit Warnhinweisen überlaufenes Sicherheitskapitel zu sehr ablenkt, sollte man nur vor den nötigsten Dingen in der Betriebsanleitung warnen. Offensichtliche Gefahren (Bsp. Ein Messer ist scharf) bedürfen keine Warnhinweise. Vor unerwarteten oder unsichtbaren Gefahren muss man warnen. So ist bspw. vor der Gefahr eines Klebstoffes zu warnen, der bei Berührung mit der menschlichen Haut so stark klebt, dass er nur noch operativ entfernbar ist.

Unter den Zulieferdokumente in der Technischen Dokumentation versteht man zum Beispiel:

  • Konformitätserklärungen
  • Betriebsanleitungen,
  • Zulieferer-, Bauteil- und Ersatzteillisten,
  • Schaltpläne,
  • ebenso wie Prüfnachweise

Die Zuliefererdokumente einer Technischen Dokumentation sollte man zudem frühzeitig einfordern.

In ein Sicherheitskapitel für Betriebsanleitungen gehören zum Beispiel nachfolgende Punkte:

  • Beschreibung des bestimmungsgemäßen Gebrauchs der Maschine, Anlage oder Teilmaschine sowie des Gerätes
  • Warnhinweise in der Betriebsanleitung, Montageanleitung und Bedienungsanleitung bezüglich einer vernünftigerweise vorhersehbaren Fehlanwendung der Maschine
  • Beschreibung der Nutzer, Einschränkungen, Gefahren für bestimmte Personengruppen
  • Allgemeine Gefahren, Warnhinweise, mögliche gesundheitliche Schäden, Schutzmaßnahmen beim Betrieb und während aller Lebensphasen der Maschine, Anlage, Teilmaschine und des Gerätes (z.B. Bohrmaschine, Kreissäge, Akkuschrauber)
  • Erklärung der grafischen Symbole für sicherheitsbezogenen Informationen an der Maschine und in der  Betriebsanleitung, Montageanleitung und Bedienungsanleitung

Der Anwender eines Produktes könnte etwas naheliegendes (gefährliches) tun, obwohl Sie Ihn nicht dazu angeleitet haben. Solche Handlungen müssen verboten werden, wenn dadurch eine Gefahr entstehen kann.

Bsp. Trommel des Kopierers nicht berühren! (Beim Öffnen zur Beseitigung eines Papierstaus)

Betriebsanleitungen zählen als Bestandteil eines Produktes. Für sie gelten die gleichen Maßstäbe für die Fehlerbeurteilung wie die eines Produktes. Anleitungen müssen also ebenfalls dem jeweils herrschenden Stand der Technik genügen, um Nutzer des Produktes nicht unverhältnismäßig zu gefährden.

In der Technischen Dokumentation verwendet man ein Glossar, um Begriffe und Definitionen zu sammeln und darzustellen. Ähnlich einem Wörterbuch können diese Begriffe in der Betriebsanleitung entsprechend gesucht und nachgeschlagen werden.

Die Betriebsanleitung einer Maschine muss einen Hinweis enthalten, dass man diese sorgfältig lesen und für späteres Nachschlagen aufbewahren muss.

Der Hersteller hat mit der Auslieferung der Maschine und der Betriebsanleitung an seinen Kunden bereits seine Pflichten als Inverkehrbringer erfüllt. Wird die Maschine von seinem Kunden weiterverkauft, ist dieser im rechtlichen Sinne ein „Bereitsteller auf dem Markt“. Der Hersteller der Maschine muss an die dritte Partei keine Betriebsanleitung aushändigen, weil er kein „Bereitsteller“, sondern nur „Inverkehrbringer“ ist.

Nein, selbst wenn der Kunde eines Herstellers in Kenntnis möglicher Folgen ausdrücklich auf die Beifügung einer Betriebsanleitung verzichtet. Dies hat keine Bedeutung für das Inverkehrbringungsrecht. Dies gilt zudem in gleicher Weise für das Produkthaftungsrecht. Auch hier können die Sorgfaltspflichten nicht durch vertragliche Gestaltung aufgehoben werden.

Die Instruktionspflicht im Maschinenbau bezieht sich auf alle zur Verfügung gestellten Informationen in der Betriebsanleitung. Das können unter anderem Sicherheits- und Warnhinweise, Handlungsbeschreibungen, Technische Daten usw. sein. Die Anforderungen an die Instruktionspflicht sind deutlich herabgesetzt, wenn die Bedienung der Maschine nur durch Fachpersonal stattfindet. Hinweis- und Warnpflichten hören in aller Regel dort auf, wo die Verwendung des Erzeugnisses, die zum Schaden führen kann, mit dem Produktzweck überhaupt nichts mehr zu tun hat.

Der Instandhaltungsplan in der Technischen Dokumentation ist eine Antwort auf Fragen, wann und was für Wartungsarbeiten zu tun sind. Darin sind alle Aktionen systematisch vorbereitet und festgelegt, die dafür erforderlich sind, um die Funktionsfähigkeit einer Produktionsmaschine zu gewährleisten.

Schwer verständliche Texte in Betriebsanleitungen kosten Geld und Zeit. Lange aufgeblähte Sätze sind vor allem in der Übersetzung ein Kostentreiber. Wenn man den Inhalt der Betriebsanleitung nicht versteht, entstehen dadurch viele zeitraubende Rückfragen. Auch ein immaterieller Schaden ist möglich. Kunden, die mit der Betriebsanleitung unzufrieden sind, schließen mit einem unverständlichen Text auch meistens mit dem Unternehmen ab.

Eine gute visuelle Gestaltung  in der Betriebsanleitung verbessert nicht einen unlogischen, schlecht strukturierten Text. Eher verstärkt sich der negative Eindruck. Die Gestaltung könnte Ordnung vorgaukeln und entsprechend gewisse Erwartungen wecken. Diese werden vom Text aber nicht eingelöst.

Um einen Text in einer Betriebsanleitung verständlich zu halten, gibt es mehrere Möglichkeiten. Unter anderem kann man folgendes tun:

  • Unnötige Fremdwörter meiden (Bei geläufigen deutschen Begriffen lieber „beurteilen“ verwenden anstatt „evaluiren“)
  • Umgangssprachliche Firmenausdrücke ersetzen (Beispielsweise: Die „Dachbefestigungsschraube“ mit dem einfachen Begriff „Schraube“ ersetzen.)
  • Zusammengesetzte Hauptwörter sparen (Lange Zusammensetzungen wie bspw. Spritzgießprozessregelung vermeiden. Zusammensetzungen mit mehr als drei Gliedern mithilfe von Bindestrichen auftrennen. Zum Beispiel Spritzgießprozess-Regelung)

Der Hersteller der Maschine ist in der Regel nicht für die praktische Durchführung des Transports der Maschine verantwortlich. Dennoch muss er Sorge dafür tragen, dass die Maschine sicher transportierbar ist. Besondere Hinweise die beim Transport der Maschine zu beachten sind, müssen in der Betriebsanleitung angegeben werden.

Enthält die Betriebsanleitung Angaben zu der Verpackung einer Maschine, muss man diese Hinweise beachten. Das können Angaben zum sicheren Auspacken der Maschine sein. Ebenso kann erläutert sein, wie man die Maschine wieder verpacken muss.

Der Transport einer Maschine soll gefahrlos möglich sein. Daher muss sich der Hersteller während der Konstruktion bereits Gedanken machen, wie man die Maschine später transportiert. Auch in der Risikobeurteilung muss man diese Lebensphase betrachten. Alle Überlegungen und Ergebnisse sammelt man dann in der Betriebsanleitung und stellt diese so dem Leser zur Verfügung. Beispielsweise sollten in der Anleitung Angaben zum Schwerpunkt der Maschine oder besondere Angaben für den Transport mit einem Gabelstapler enthalten sein.

Nein, das Urheberrecht der Betriebsanleitung liegt beim Hersteller der Maschine. Dadurch darf der Betreiber einer Maschine die Betriebsanleitung des Herstellers nicht ohne seine Zustimmung überarbeiten, vervielfältigen oder übersetzen.

Für elektrische Baugruppen können wir eine Bedienungsanleitung, Gebrauchsanleitung oder Montageanleitung erstellen. Dies ist jedoch abhängig von Ihrem Produkt. Unser Schwerpunkt liegt im erstellen von Gebrauchsanleitungen, Bedienungsanleitungen und Montageanleitungen für Maschinen- und Anlagenbauer.

Der Hersteller eines technischen Produktes hat eine Instruktionspflicht gegenüber dem Kunden, die er durch die Übergabe einer Gebrauchsanleitung erfüllt. Diese ist daher ein Bestandteil des Produkts (siehe Produktsicherheitsgesetz); Eine fehlerhafte, unvollständige oder unverständliche Gebrauchsanleitung ist ein Sachmangel. Diese kann, genauso wie ein Fehler am Produkt selbst, zu Nacherfüllung, Rücktritt vom Kaufvertrag oder Kaufpreisminderung führen. Im Rahmen der Produkthaftung kann eine fehlerhafte Gebrauchsanweisung bei Sach- oder Personenschäden zu einem erheblichen finanziellen Haftungsrisiko für den Inverkehrbringer des Produkts werden.

Das Fehlen der Anleitung stellt außerdem einen Verstoß gegen die CE-Kennzeichnung dar. Die CE-Kennzeichnung ist dadurch zu Unrecht erfolgt und kann zur Untersagung des weiteren Verkaufs des Produktes, Produktionsstillstand/Rückruf und Überprüfung aller Produkte durch die Marktüberwachung führen.

Meldet ein Wettbewerber der Marktaufsicht das Fehlen der Betriebsanleitung hat dies zudem schwere rechtliche Auswirkungen. Gerichtliche Verfahren wegen unlauterem Wettbewerb gegen den Produkthersteller sind dann möglich.

Die Maschinenrichtlinie 2006/42/EG besagt, dass eine Maschine bzw. Anlage nicht ohne Betriebsanleitung in Verkehr gebracht darf. Eine Nachreichung der Betriebsanleitung ist somit ausgeschlossen.

Hersteller müssen in der Betriebsanleitung laut Maschinenrichtlinie Angaben zu dem Geräuschemissionen ihrer Produkte machen. Dabei messt man die am Arbeitsplatz entstehenden Lärmpegel. Die Messung setzt sich aus verschiedenen Anteilen zusammen, die auf den unterschiedliche Tätigkeiten bzw. Einwirkungen an der Maschine zurückzuführen sind. Aus den dabei für die einzelnen Tätigkeiten gegebenen Lärmbelastungen und deren Höhe erstellt man dann die Angaben in der Betriebsanleitung.

Zum einem den Emissionsschalldruckpegel sofern dieser über 70 dB(A) am Arbeitsplatz liegt. Zweitens die Angabe des Schallleistungspegel wenn dieser am Arbeitsplatz über 80 dB(A) beträgt. Überdies muss ab einem Wert von 130 dB am Arbeitsplatz noch der Spitzenschalldruckpegel angegeben werden.

Für weitere Informationen über die Inhalte der Betriebsanleitung empfehlen wir Ihnen die Podcast-Folgen der Reihe Betriebsanleitung erstellen hier anzuhören. Benötigen Sie eine Vorlage für eine Betriebsanleitung? Dann laden Sie sich unsere kostenlose Musterbetriebsanleitung aus unserem Downloadbereich herunter.

Fehler: Kontaktformular wurde nicht gefunden.

Um die Möglichkeit von Unfällen zu vermindern und das Haftungsrisiko zu verringern. Die Veränderung, Umgehung oder Überbrückung von Schutzeinrichtungen findet sehr häufig statt. Durch die Dokumentation der Schutzeinrichtungen weiß der Leser, welche Schutzeinrichtungen wo verbaut und wie und wann diese auf Funktionalität zu überprüfen sind. Zudem macht eine Auflistung bzw. Darstellung der Schutzeinrichtungen eine Überprüfung erst möglich.

Der Hersteller muss aufgrund seiner Fabrikationspflicht den Nachweis erbringen, dass die Schutzeinrichtungen bei der Übergabe des Produktes in Ordnung waren. Dies wiederum wird durch Abnahmeprotokolle nach der Fertigung und bei der Aufstellung beim Kunden belegt. Ebenso beinhaltet eine lückenlose Dokumentation Checklisten oder Wartungsbücher mit den Terminen, wann die Einrichtungen durch wen zu prüfen sind.

Um die Details von Schaltplänen, etc. zu erkennen, sollten diese in den Anhängen der Betriebsanleitung abgebildet sein. Dort kann dann ggf. ein größeres Papierformat gewählt werden. Auf einem A4-Blatt kann unter Umstände nicht jedes Detail erkannt werden.

Zur Installationsqualifizierung (Englisch: Installation Qualification -IQ) gehört u.a. der Vergleich der tatsächlich installierten Komponenten in Maschinen mit den geforderten Anforderungen. Weiterhin die Überprüfung des vollständigen Aufbaus und der Zusammenstellung der Dokumentationen. Die IQ überprüft, dass die Komponenten der Anlage entsprechend den Designspezifikationen installiert und alle für sich betrachtet funktionieren. Direkt nach Lieferung, Aufbau und Inbetriebnahme einer Anlage wendet man dieses Verfahren an. Das Ergebnis der Prüfung ist zu dokumentieren.

Funktionsqualifizierung (Englisch: Operational Qualification – OQ) umfasst die dokumentierte Überprüfung aller Komponenten und Module eines installierten Systems. Eine komplexe Anlage wird in sinnvolle prüffähige funktionale Schritte oder Gruppen aufgeteilt und einzeln sowie zusammenhängend getestet. Im Rahmen der Funktionsqualifizierung erfolgt die Überprüfung der Funktion des Systems.

Leistungsqualifizierung (Englisch: Performance Qualification – PQ) findet nach IQ und OQ statt. Dieses Verfahren dokumentiert, dass Geräte und Systeme im gesamten vorgesehenen Arbeitsbereich innerhalb der vorgegebenen Grenzwerte reproduzierbar arbeiten. Damit erbringt man den Beleg für die dauerhaft erwartete Leistung des Systems. Die Komponenten eines Systems sind dabei nicht alleine zu betrachten, sondern immer nur als Teil des Gesamtprozesses bzw. eines Teilprozesses. Durch eine entsprechende Anzahl von Wiederholungen ist ein repräsentativer Beweis erbracht, dass die Geräteanforderungen erfüllt und im späteren realen Betrieb erfüllt sind.

Der Versand von Produkte in Drittländer, also Länder außerhalb der Europäischen Union, unterliegt aus zollrechtlicher Hinsicht einigen Feinheiten. Die Erstellung einer Ausfuhranmeldung ab einem Sendungswert von 1.000 Euro gehört dazu. Dabei zählt der statistische Wert des Produktes und nicht der Rechnungsbetrag. Diese Ausfuhranmeldung muss seit Juli 2009 im Rahmen des elektronischen Verfahrens ATLAS-Ausfuhr abgegeben werden.

Dies ist der Wert der Sendung „frei deutsche Grenze“, dies bedeutet, dass beispielsweise bei der Lieferbedingung „Ab Werk“ bzw. „EXW“ die Frachtkosten bis zur deutschen Grenze anteilig zum Rechnungsbetrag zu addieren sind, um den statistischen Wert zu erhalten. Weiterhin ist zu berücksichtigen, dass sich im Falle kostenloser Ersatzsendungen, der statistische Wert an dem realen Wert der Sendung orientiert. So kann beispielsweise für die Lieferung eines kostenfreien Motors im Rahmen eines Garantiefalls eine Ausfuhranmeldung notwendig sein. Nämlich dann, wenn der statistische Wert bei über 1.000 Euro liegt (Wert des Motors zuzüglich der anteiligen Frachtkosten zur deutschen Grenze).

Das ATLAS Verfahren ist das IT-System des deutschen Zolls und bildet folglich die Abkürzung für den Ausdruck „Automatisiertes Tarif- und Lokales Zoll-Abwicklungs-System“.

Die ATLAS-Ausfuhranmeldung kann aus Sicht des ausführenden Unternehmens auf unterschiedliche Weise erstellt sein:

  • Im Rahmen einer vom Zoll zertifizierten, mit ATLAS verbundenen Software (zumeist kostenpflichtig) durch Mitarbeiter des Unternehmens.
  • In dem vom Zoll (kostenfrei und online) angebotenen Programm „Internetausfuhranmeldung Plus“ (IAA Plus) durch Mitarbeiter des Unternehmens
  • Durch einen Dienstleister (z.B. einen Spediteur oder eine Zollagentur)

Komplexe Maschinen sind so detailreich, dass Beschreibungen in Textform in der Betriebsanleitung sehr umfangreich und schwer verständlich ausfallen. Mithilfe von Abbildungen in Betriebsanleitungen reduziert sich der Informationsgehalt auf das Wesentliche. Abbildungen betonen überdies wichtige Inhalte und unterstützen den geschriebenen Text. Ein Bild vermittelt Informationen sprachneutral und ist international verständlich. Die Kosten für eine Übersetzung werden durch eine Abbildung ohne Text eingespart.

Der Nutzer muss durch die Beschreibung eines Produktes in der Lage sein, das Produkt entsprechend zu identifizieren. Dies ist möglich durch Angaben wie zum Beispiel:

  • Seriennummer, Modell, Produktkennzeichnungsnummer
  • Name zur Identifizierung des Anbieters
  • Name sowie Anschrift von Lieferanten
  • Abmessungen, Leistung, Energieverbrauch
  • Spannungen, Geräuschpegel, Elektromagnetische Verträglichkeit
  • Hinweise zum bestimmungsgemäßen Verbrauch

Ist eine Modifikation des Produktes nicht erlaubt, muss dies eindeutig in der Betriebsanleitung angegeben sein. Bei erlaubter Modifikation muss die Anleitung die erlaubten Modifikationen beschreiben. Ein sicherer Gebrauch muss weiterhin gewährleistet sein.

Betriebsanleitungen in elektronischer Form müssen wie gedruckte Anleitungen leicht verständlich sein und den Anforderungen aller Normen folgen. Wenn Gebrauchsanleitungen nur elektronisch zur Verfügung stehen, muss dies deutlich am Verkaufsort und auf der Verpackung angegeben werden. Herunterladbare Gebrauchsanleitungen müssen ohne Änderung der verwendeten Betriebssysteme lesbar sein. Genauso muss die notwendige Software zur Verfügung gestellt sein.

Die Technische Dokumentation einer Maschine muss sowohl vor Gebrauch als auch danach zugänglich sein. Daher muss auf die Bedeutung der Aufbewahrung einer Betriebsanleitung hingewiesen werden durch Aussagen wie z. B.:

WICHTIG!

VOR GEBRAUCH SORGFÄLTIG LESEN

BETRIEBSANLEITUNG FÜR SPÄTERES NACHSCHLAGEN AUFBEWAHREN!

Die Dokumentationsüberprüfung dient dazu zu überprüfen, ob die eigene Gebrauchsanleitung den üblichen Normen und Regeln unterliegt. Zum Beispiel ob die Betriebsanleitung der DIN EN 82079-1 oder für den amerikanischen Sektor der ANSI-Normen unterliegt. Ebenso überprüft unser Dokucheck,  ob das Dokument alle nötigen Produkthaftungskriterien erfüllt.

Die Betriebsanleitung muss laut der Maschinenrichtlinie in Ihrer Amtssprache verfasst sein. Verkauft man die Maschine ins europäische Ausland, muss die Betriebsanleitung entsprechend in der Amtssprache des Landes verfügbar sein.

 

Aus haftungsrechtlicher Sicht müssen Betriebsanleitungen verständlich geschrieben sein. Um die Anleitung verständlich schreiben zu können, sollte man dann auch die Personen kennen, welche das Produkt schlussendlich nutzen. Daher gibt es in Betriebsanleitungen also auch die Analyse der Zielgruppe des Produktes.

In der Betriebsanleitung müssen Angaben über Leistung und Verbrauch der Maschine wie Fassungsvermögen, Masse des Produktes, Nennleistung, etc. angegeben werden. Diese sollten dann übersichtlich dargestellt werden und sollten korrekt sein, um keine Probleme mit der Produkthaftung zu bekommen.

In der Betriebsanleitung werden Angaben über die Art und Häufigkeit von Instandhaltungs- und Reinigungsarbeiten, Material und Werkzeuge gemacht. Außerdem auch genügend detaillierte Beschreibungen zu den Tätigkeiten für die Instandhaltung und Reinigung des Produktes. Genauso zu beachten ist auch die Qualifikation des eingesetzten Personales. Informationen für geschultes und nicht geschultes Personal ist separat bereitzustellen. Die lokale Gesetzgebung und der lokale Arbeitsschutz wirken sich auch auf die jeweiligen Angaben aus.

Bei den Angaben zur Demontage ist darauf zu achten, dass diese nur erlaubt ist, wenn dies keine Gefährdung für Personen darstellt. Eine schlichte Angabe von „Demontieren Sie das Produkt in umgekehrter Weise, wie Sie es montiert haben“ ist nicht angemessen. Die EN 82079-1 fordert genaue Informationen und Warnhinweise über die Demontage eines Produktes.

Informationen in Hinsicht auf Recycling oder Entsorgung eines Produktes müssen auch in einer Betriebsanleitung wiedergegeben werden. Angaben zu einer sicheren und umweltgerechten Behandlung der Abfallprodukte sind ebenfalls zu machen.

Jedes Produkt ist für einen bestimmten Verwendungszweck geplant und hergestellt. Obwohl dieser Einsatzzweck logisch ersichtlich sein kann, ist jeder Produkthersteller verpflichtet den Käufer des Produktes von seiner bestimmungsgemäßen Verwendung zu informieren. Ebenso über möglichen Fehlgebrauch oder sogar Missbrauch ist in der Betriebsanleitung zu informieren. Diese Darstellung muss grundsätzlich vorhanden sein, damit die Produkthaftung erreicht ist und Gewährleistungs- oder Garantieansprüche greifen.

Die Maschinenrichtlinie besagt, dass bei wesentlichen Veränderungen auch alte Maschinen als neu betrachten zu sind. Durch Umbauten an einer Maschine durch eine Unternehmen wird die ursprüngliche Leistung, der Verwendungszweck oder die Bauart der Maschine wesentlich verändert. Dadurch ist die Maschine laut Maschinenrichtlinie als neu anzusehen. Die Maschine ist qausi erneut in Verkehr gebracht. Der aktuelle Betreiber erbt demzufolge auch allen einen Maschinen-Hersteller betreffenden Pflichten. Er muss eine EU-Konformitätserklärung erstellen, die CE-Kennzeichnung muss anbringen und er muss sicherstellen, dass eine Technische Dokumentation vorhanden ist.

Ja, inhaltlich gibt es mehrerer Punkte, die in einer Gebrauchsanleitung entsprechend aufgeführt sein sollten:

  • Bestimmungsgemäße Verwendung
  • Angaben zur gefahrlosen Durchführung von Transport, Installation, Inbetriebnahme und Verwendung sowie Rüsten, Instandhaltung, Montage und Demontage
  • Vom Bedienpersonal einzunehmende Arbeitsplätze
  • Erforderliche Einarbeitungshinweise
  • Angaben zu technischen Daten und Emissionen

Der Zeitpunkt des Inverkehrbringens eines Produktes spielt in der Produkthaftung eine große Rolle. Deswegen muss eine Gebrauchsanleitung mittels einer Gültigkeitsidentifikation gekennzeichnet sein. Ein Ausgabedatum, Revisionsindex oder sonstiger Code, der nachweist, wann die Gebrauchsanleitung ausgestellt ist.

Wenn die Software Teil einer Maschine bzw. Produktes ist, unterliegt diese rechtlich dem Produktsicherheitsrecht und muss in diesem Fall neben der Betriebsanleitung ebenfalls übersetzt werden.

Bei feuchten Umgebungseinflüssen kann Papier schnell Schaden nehmen oder die Schrift verläuft möglicherweise. Das Material der gedruckten Betriebsanleitung muss den Umgebungseinflüssen angepasst sein.

Aus der Zielgruppenanalyse ergibt sich, ob die Nutzer der Betriebsanleitung Kenntnisse von den eingesetzten Fachbegriffen haben. Besitzt diese keinerlei Wissen, so sind diese beim ersten Gebrauch und ggf. an weiteren Stellen ausführlich zu erklären. Ein Glossar am Ende des Betriebsanleitung, welches die Fachbegriffe enthält, ist ebenfalls sinnvoll.

Die Zielgruppe der privaten Endbenutzer an sich erfordern besondere Darstellungsweisen. Der Hersteller eines Produktes muss daher mit der Nutzung durch gefährdete Zielgruppe wie Kinder oder ältere Menschen rechnen. Über Risiken ist umfassend zu informieren und eine optimale Verständlichkeit der Anleitung ist für die Verringerung des Haftungsrisikos erforderlich.

Zuerst notiert man die Handlungsanweisungen stichwortartig und formuliert diese dann aus. Warnhinweise für Handlungsanweisungen sind vor der Handlung zu platzieren.

Handlungsanweisungen fordern den Benutzer zu einer Handlung auf und sind daher aktiv zu formulieren. Sie dienen dazu:

  • die Ausgangssituation einer Handlung zu schildern
  • das Ziel der Handlung nennen
  • falls notwendig einen konkreten Warnhinweis zu enthalten
  • in überschaubaren Schritten die auszuführende Handlung zu beschreiben
  • das Resultat der Handlung angeben

Um eine Betriebsanleitung übersichtlich zu gestalten, ist der Inhalt  durch Überschriften in verschiedenen Hierarchien zu wählen. Die Untergliederung dieser sollte jedoch maximal bis zur 3. Stufe reichen, um die Übersichtlichkeit zu wahren.

Einzelne wichtige Absätze können mithilfe einer Marginalienspalte hervorgehoben werden. Am Ende eines Kapitels kann eine Zusammenfassung für den Leser hilfreich sein.

Verzeichnisse für Inhalt, Fachwörter und Abkürzungen sind ebenfalls gute Orientierungshilfen.

Im Sinne des Produktsicherheitsrechts kann jede hergestellte fertige oder auch unfertige Sache zunächst ein Produkt am Markt sein. Ein Produkt am Markt ist, wenn Menschen diese in irgendeiner Art und Weise verwenden. Dazu zählen:

  • Gegenstände für den privaten Gebrauch
  • Technische Arbeitsmittel
  • Nahrungsmittel für Menschen und Tiere
  • Stoffe und sonstige Materialien

Ebenso spricht man im rechtlichen Sinne von der Erzeugung eines neuen Produktes, wenn verschiedene fertige und/oder unfertige Produkte zu einem neuen zusammengefügt oder ein bestehendes wesentlich verändert sein sollte.

Das kann durchaus sinnvoll sein. Mehrere Länder haben mehr als eine Amtssprache. Die Vereinigten Staaten benutzen zwar vorwiegend Englische Dokumente, haben aber keine einheitlich festgelegte Amtssprache. Bundesstaaten mit einem hohen lateinamerikanischen Bevölkerungsanteil verwenden zunehmend auch Spanisch als Amtssprache. Abhängig von der Branche kann auch eine andere Sprache zwingend vorgeschrieben werden. In New York müssen für die Baubranche die Betriebsanleitungen zwingend auf Spanisch ausgestellt sein, da überwiegend spanisch sprechende Personen im Baugewerbe tätig sind.

In den verschiedenen Teilen der USA herrschen starke Klimaschwankungen. Deshalb sind extrem heiße und kalte Temperaturen bei der Konstruktion zu berücksichtigen. So könnte beispielsweise durch Hitzeeinwirkung das Plastik von Elektroteilen schmelzen, die in Containern im Hafen von Texas lagern.

Der sogenannte „Stand der Technik“ ist einer der wichtigsten Technikklauseln für Maschinensicherheit, Produktsicherheit und Arbeitssicherheit. Der Begriff ist ein unbestimmter Rechtsbegriff, der in verschiedenen Rechtsgebieten Verwendung findet und auf die Entwicklung von Wissenschaft und Technik Bezug nimmt.

Der Stand der Technik umfasst das, was technisch möglich ist. Möglich bedeutet nicht nur technisch machbar, sondern bezieht auch die Aspekte der Wirtschaftlichkeit und realistisch möglichen Umsetzbarkeit ein. Der Stand der Technik verändert sich zudem ständig und ist kein statisches Gebilde. Produkte sind an den Stand der Technik angepasst und Lösungen für Schutz und Sicherheit ständig weiterentwickelt. Das gilt ebenso für Maschinen, Anlagen, ihre Steuerungen und deren Betriebsanleitungen.

Das Produkthaftungsgesetz besagt, dass ein Produkt einen Fehler aufweist, wenn es nicht die Sicherheit bietet, die unter Berücksichtigung aller Umstände zu erwarten ist. Zu den Umständen zählen insbesondere:

  • seiner Darbietung
  • des Gebrauchs, mit dem billigerweise zu rechnen ist
  • des Zeitpunkts des Inverkehrbringens

Einem Produkt kann nicht einfach einen Fehler vorgeworfen werden, weil später ein verbessertes Produkt herauskam.

Die Abgabe eines Produktes im Rahmen einer Geschäftstätigkeit wird zunächst als „Bereitstellung auf dem Markt“ betrachtet. Ungeachtet davon, ob das Produkt verkauft, vermietet, verpachtet oder gar verschenkt ist. Das Produktsicherheitsrecht sieht vor, dass zum Zeitpunkt der Bereitstellung alle gesetzlichen Anforderungen an das Produkt erfüllt sein müssen.

Vorrangig jeder Hersteller, der ein Produkt selbst entwirft und fertigt. Aber auch jede natürliche oder juristische Person, die ein Produkt auf dem Markt bereitstellt, ist ein Bereitsteller. Als Hersteller sind auch solche eingestuft, die ein Produkt wesentlich verändern. Genauso diejenigen, welche mehrere Produkte zu einer neuen Gesamtheit zusammenfügen oder seinen Namen auf einem fremden Produkt anbringen.

Als Arbeitsschutz versteht man die Maßnahmen, die dazu dienen die Beschäftigten eines Unternehmens vor arbeitsbedingten Sicherheits- und Gesundheitsgefährdungen zu schützen. Das Ziel des Arbeitsschutzes ist die Vermeidung von Arbeitsunfällen und der Schutz der Gesundheit der Beschäftigten.

Jeder Arbeitgeber ist verpflichtet, seine Beschäftigten nach dem aktuellen Stand der Technik zu schützen. Das bezieht sich auf die Sicherheit von Maschinen, das Funktionieren von Schutzeinrichtungen, den Umgang mit Gefahrstoffen sowie auch die Qualität von Arbeitskleidung oder der Komponenten der persönlichen Schutzausrüstung.

Redaktionelles Arbeiten (1)

Was versteht man unter technischem Lektorat?

Im Rahmen des Lektorats geht es um die Überprüfung von Texten hinsichtlich der Einhaltung grammatikalischer, rechtschreiblicher und stilistischer Kriterien. Diese Prüfung wird gemeinhin für alle Texte unabhängig von ihrem Inhalt durchgeführt.

Kommen noch fachlich-inhaltliche Prüfkriterien hinzu, spricht man in der technischen Dokumentation vom technischen Lektorat. So wird hier geprüft, ob alle für das jeweilige Informationsprodukt gültigen Normen und Richtlinien eingehalten werden. Hierzu gehören beispielsweise die Prüfung auf Vollständigkeit, Plausibilität und Auszeichnung von Sicherheits- und Warnhinweisen, die Prüfung auf zielgruppengerechte Verständlichkeit, Dokumentenstruktur und einsatzbezogene Medienverwendung oder auf die Berücksichtigung von Besonderheiten für bestimmte Zielländer hinsichtlich der bildlichen Darstellung, Verständlichkeit, Farben oder allgemeinen Übersetzungskriterien (Lokalisierung).

Im Rahmen der Plausibilitätskontrolle (auch Plausibilitätsprüfung genannt) wird geprüft ob die technische Dokumentation grundsätzlich nachvollziehbar und damit für die Zielgruppe ausreichend verständlich ist. Dabei ist zu beachten, dass bei dieser Prüfung der rein technische Bereich im technischen Lektorat meist nicht berücksichtigt werden kann und die Prüfung in dieser Hinsicht dann nur geringe oder keine Aussagekraft besitzt.

An den Anfang scrollen