Technische Dokumentation – Fragen und Antworten zur Technischen Dokumentation

Ja, wenn das Produkt personenbezogene Daten verarbeitet (z. B. Smart Devices, Überwachungskameras und Software oder Cloud-Dienste), gehört ein Hinweis zur DSGVO-konformen Nutzung in die Dokumentation.

Ja, wenn das Produkt personenbezogene Daten verarbeitet (z. B. Smart Devices, Überwachungskameras und Software oder Cloud-Dienste), gehört ein Hinweis zur DSGVO-konformen Nutzung in die Dokumentation.

Primär der Hersteller bzw. Verantwortliche. Die technische Redaktion trägt jedoch Mitverantwortung für DSGVO-konforme Inhalte in der Dokumentation.

Ja, wenn das Produkt personenbezogene Daten verarbeitet (z. B. Smart Devices, Überwachungskameras und Software oder Cloud-Dienste), gehört ein Hinweis zur DSGVO-konformen Nutzung in die Dokumentation.

Nur wenn dies notwendig und rechtlich zulässig ist. Protokolle, Fehlermeldungen und Nutzeranalysen dürfen nicht dauerhaft mit Personenbezug gespeichert werden – nur anonymisiert oder pseudonymisiert.

• Keine personenbezogenen Daten ohne Rechtsgrundlage dokumentieren
• Anonymisierung, wenn möglich
• Datenschutz durch Technikgestaltung („Privacy by Design“) berücksichtigen
• Nur notwendige Daten erfassen („Datenminimierung“)

Personenbezogene Daten sind alle Informationen, die sich auf eine identifizierbare Person beziehen: Name, E-Mail-Adresse, IP-Adresse, Benutzerverhalten, Systemnutzungsdaten, Video- und Bildaufnahmen usw.

Der IEC/IEEE/82079-1 folgend können diese Angaben bei gedruckten Ausgaben im Deckblatt / Titelblatt, in Kolumnentiteln oder Kopf-/bzw. Fußzeilen eingesetzt werden.
Bei digitalen Informationsprodukten ist es darüber hinaus sinnvoll, diese Angaben auch im Dateinamen und den dokumentbezogenen Metadaten vorzusehen

Die ISO 639-2 dient der Unterstützung bibliothekarischer Nutzung und damit einer weltweit geeigneten Auszeichnung literarischer Werke. Im Gegensatz zur ISO 3166-1 sind hier die verwendeten Sprachen die Grundlage. Als nachteilig im Verhältnis zur ISO 3166-1 ist möglicherweise die für die Benutzer weitgehend unbekannte Codierung der Sprachfassungen.

Bei der DIN EN ISO 3166-1 handelt es sich um eine Norm zur Standardisierung von Ländercodes. Grundlage ist die geografische bzw. geopolitische Definition einzelner Staaten und den ggfs. von ihnen abhängigen Gebieten.  Sie ist überall dort wo eine Darstellung codierter Ländernamen erforderlich ist, verwendbar. So auch beispielsweise zur Kennzeichnung der sprachlichen Fassung von Informationsprodukten.
Ihr Vorteil gegenüber der ISO 639-2 liegt in der für die Nutzer eines Informationsproduktes allgemein leichter zuordenbaren Sprachfassung, da die Codierung teilweise den Kfz-Nationalitätskennzeichen ähnelt.

Ja, die IEC/IEEE/82079-1 verlangt in Kapitel 7.2.1, dass „das Informationsprodukt eindeutig identifizierbar ist“. Als Beispiel ist auch die „Kennzeichnung“ der verwendeten Sprache aufgeführt.
Die Norm schreibt hier zwar nicht vor wie dies zu erfolgen hat, führt jedoch die ISO 639-2 als mögliche Quelle für die zu verwendenden Ländercodes auf. Eine weitere, hier nicht genannte Quelle ist die DIN EN ISO 3166-1  

Auch in China gibt es Gesetze, welche den Hersteller auffordern eine Betriebsanleitung zu erstellen. Ein solches Gesetz aus dem Jahr 1993 heißt im Englischen „Law of the People’s Republic of China on Product Quality“. Dieses Gesetz fordert von Herstellern, die Bereitstellung von Informationen zum sicheren Umgang mit dem Produkt für die Benutzer.

Beim Betriebsanleitung erstellen ist darauf zu achten, dass Handlungsanweisungen neben Schritt-für-Schritt-Anweisungen auch zusätzliche relevante Warnungen und Hinweise enthalten. So sind Vorabinformationen nützlich, die einen Überblick über die Handlung geben und evtl. Voraussetzungen nennen.

Ebenso Warnhinweise, die den Benutzer vor möglichen Gefahren in dieser Handlungsabfolge warnt. Es genügt nicht, diese Warnhinweise nur im Sicherheitskapitel aufzuführen.

Solche eine einleitende Information fordert auch die IEC/IEEE 82079-1 von Nutzungsinformationen. Vom Leser, welcher ein spezielles Kapitel in der Anleitung sucht, darf der Ersteller nicht annehmen, dass der Leser jedes Mal das Sicherheitskapitel aufschlägt und sich die Warnhinweise durchliest.

Es ist nicht erlaubt beim Betriebsanleitung erstellen allgemeine Informationen durch die Verwendung der gängigen Signalwörter (Gefahr, Warnung, Vorsicht, Hinweis) hervorzuheben.

Die Doku-Normen DIN EN ISO 20607 und die IEC/IEEEE 82079-1 machen Vorgaben hinsichtlich der Verwendung der Signalwörter in Anlehnung an die DIN ISO 3864-2 sowie die amerikanische Norm ANSI Z535.

In den Normen ist festgelegt, wann welches Signalwort zu verwenden ist. Abhängig von der Schwere eines Personenschadens sind die Signalwörter Gefahr, Warnung oder Vorsicht zu verwenden. Bei einem möglichen Sachschaden durch Fehlbenutzung ist das Signalwort Hinweis zu verwenden. Die Signalwörter dürfen nur im Zusammenhang mit sicherheitsbezogenen Informationen zum Einsatz kommen, um vor einer möglichen Gefährdung zu warnen.

Das Hervorheben von sicherheitsbezogenen Informationen ist beim Betriebsanleitung erstellen ein wichtiger Punkt. Informationen, welche die Sicherheit des Benutzers betreffen, müssen sich vom anderen Text hervorheben. Entweder durch grafische Symbole, Sicherheitszeichen oder andere Gestaltungselemente. Auch größere oder andere Schrifttypen sind denkbar. Der Einsatz von Signalwörter (Gefahr, Warnung, Hinweis) verdeutlicht mögliche Gefährdungen, falls die sicherheitsbezogenen Informationen keine Beachtung finden.

Die Norm DIN EN IEC IEEE 82079-1 zum Betriebsanleitungen erstellen umfasst 78 Seiten. Auf diesen Seiten geht es um alle Informationen, die während des Produktlebenszyklus und für die verschiedenen Zielgruppen wichtig sind. Die Norm 20607 umfasst lediglich 38 Seiten, da sich diese nur mit Anleitungen für den Maschinen- und Anlagenbau beschäftigt.

Die bekanntesten Normen, um eine Betriebsanleitung zu erstellen sind:

• DIN EN ISO 20607:2019 „Sicherheit von Maschinen – Betriebsanleitungen – Allgemeine Grundsätze“
• DIN EN IEC IEEE 82079-1:2021-9 „Erstellung von Nutzungsinformationen (Gebrauchsanleitungen) für Produkte – Teil 1: Grundsätze und allgemeine Anforderungen“

Abseits von diesen beiden Hauptnormen gibt es einige Produktnormen, welche vereinzelte Vorgaben zu den Inhalten für die Betriebsanleitungen aufstellt.

Die Betriebsanleitung ist in der jeweiligen Landessprache zu erstellen. Diese Vorgabe ist öfters zu vernehmen. Diese Vorgabe entspringt nicht der Vorstellung des Kunden oder des Nutzers des Produktes. Es gibt rechtliche Vorgaben diesbezüglich. Sowohl auf nationaler Ebene durch die jeweiligen Gesetze, wie auf der europäischen Ebene durch Richtlinien und Verordnungen. Für die Produktgattung Maschinen ist das beispielsweise die europäische Maschinenrichtlinie, welche eine Übersetzung der Betriebsanleitung in die jeweilige Landessprache verlangt. Die jeweiligen Mitgliedsstaaten der EU setzen diese Vorgaben dann mit ihrer jeweiligen nationalen Umsetzung der Richtlinie in geltendes Recht um.

Projektmanagement spielt eine wichtige Rolle beim Erstellen einer Betriebsanleitung. Moderne Produkte werden immer komplexer. Selbst einfache Produkte wie beispielsweise eine Kaffeemaschine können sehr komplex und umfangreich sein. Beispielsweise indem Softwarekomponenten auch mit in diese Maschinen verbaut werden. Die Kaffeemaschine kann sich dann mit dem Internet verbinden oder mit dem Smartphone gesteuert werden. Durch die steigende Komplexität von Produkten und durch besondere Kundenanforderungen müssen Technische Redakteure die Betriebsanleitung im Projektverlauf öfters anpassen. Die Verwaltung solcher Änderungen bzw. Anpassungen durch ein entsprechendes Projektmanagement ist daher wichtig. Fehlen am Ende die Übersetzungen dieser Anpassungen ist der Schlamassel groß. Nun muss eine Übersetzung her und zwar in Windeseile. Die Folge sind natürlich sehr hohe Kosten für den Hersteller. Die Anleitung muss aufgrund des Zeitmangels dann von mehreren Übersetzern bearbeitet werden. Mit einer entsprechenden Planung wären diese Kosten nicht entstanden.

Konsistente Nutzungsinformationen zu erstellen ist nicht leicht. Gerade im Hinblick auf Serien- oder Massenprodukte mit einer Vielzahl an Zubehör und Individualisierungsmöglichkeiten. Ein großes Augenmerk ist auf Inhalt, Darstellung und die Form zu richten. Mit Form ist die Art und Weise, wie die Informationen zur Verfügung gestellt werden.

Die Bereitstellung der Nutzungsinformationen soll konsistent erfolgen. Falls beispielsweise eine digitale Version verfügbar ist, sollte diese auch alle Informationen der Papierform enthalten. Sonst muss der Benutzer zwischen mehreren Versionen wechseln. Ein Beispiel: Ein Kunde möchte sein Produkt warten. Er liest das Sicherheitskapitel in den gedruckten Nutzungsinformationen. Diese rät die Wartung mit einer App durchzuführen. Er lädt die App herunter und sucht dort nach den Informationen zur Wartung. Die App wiederum verweist auf ein Video, aber der dazugehörige Link fehlt. Er sucht das Video also auf Youtube und findet es. Das Videos weist immer wieder auf spezielle Hinweise hin, die der Benutzer einhalten soll. Diese seien in der gedruckten Dokumentation vorhanden. Also muss er dort wieder nachlesen. Und so springt er mehrfach zwischen allen Medien hin und her, bis er die Wartung durchgeführt hat.

Text spielt beim Betriebsanleitung erstellen eine tragende Rolle- Damit die Informationen, welche der Text vermitteln soll, auch verständlich sind, gilt es einige Regeln beim Planen von Texten zu beachten.

Zuerst sollte der Autor sich überlegen für wen er schreibt. Die Zielgruppe legt fest, wie der Text zu schreiben ist. Welche Erfahrungen haben die Zielgruppe? Was kann der Autor als verständlich erachten? Was gilt es im Gegenzug zu erläutern?

Danach ist das Ziel des Textes festzulegen. Was möchten wir mit dem Text beschreiben bzw. darstellen?

Sind diese beiden Punkte beantwortet, kann der Autor die Informationen festlegen, welche der Text beinhaltet muss. Im Anschluss können die benötigten Informationen in eine sinnvolle Reihenfolge festgelegt werden, damit diese inhaltlich einen Sinn geben. Abschließend plant der Ersteller die Gestaltung des Textes. Enthält der Text nur Fließtext, gibt es Aufzählungen oder Listen? Ist der Text in Passiv oder Aktiv geschrieben? Gibt es neben einem beschreibenden Text noch eine Abbildung?

Wann eine Betriebsanleitung als vollständig angesehen werden kann, hängt vom betreffenden Produkt ab. Je nach Produkt sind unterschiedliche Lebensphasen zu beschreiben. Einfache Produkte benötigen hauptsächlich Informationen zur Lagerung, Verwendung und am Schluss zur Entsorgung. Bei einer Maschine hingegen kommt es auf weitere Faktoren wie beispielsweise den Verwendungszweck und die Größe an. Eine Küchenmaschine kann mit Transport, Lagerung und Inbetriebnahme beginnen. Bei einer Industrieanlage fallen diese Themen vermutlich bereits weg, da diese nicht andauernd abzubauen und zu transportieren ist. Das Auseinandersetzen mit dem Produkt und der betreffenden Zielgruppe für das Produkt ist daher entscheidend. Nur so ist zu bestimmen, wann eine Betriebsanleitung genügend Informationen beinhaltet und als vollständig zu betrachten ist.

Das Produktsicherheitsgesetz fordert von Produkten eine Bedienungsanleitung, wenn bei der Verwendung bestimmte Regeln zu beachten sind. Falls Zubehör zu einem Produkt separat erhältlich ist, muss diesem Zubehör die zur Verwendung notwendige Nutzungsinformation ebenfalls vorliegen. Das Zubehör gilt dann nämlich als eigenständiges Produkt, welchem bei der Bereitstellung auf dem Markt eine Bedienungsanleitung in deutscher Sprache mitzuliefern ist.

Daher genügt es nicht nur eine Bedienungsanleitung für das (Haupt-)Produkt zu erstellen, welche Informationen zum separat erhältlichen Zubehör beinhaltet.

Auch aus Sicht des Minimalismus-Prinzips der IEC/IEEE 82079-1 sollten Informationen zum Zubehör in einer separaten Anleitung aufgeführt sein. Kauft der Benutzer das separate Zubehör nicht, benötigt er auch keine Informationen dazu. Die Anleitung enthält somit jede Menge überflüssige Informationen zum Zubehör.

In einer Betriebsanleitung kommen verschiedenen Bildtypen zum Einsatz. In einer Anleitung kommen unter anderem folgende Typen zum Einsatz:

• Fotos
• Pixelbilder
• Illustrationen
• Vektorgrafiken
•  3D-Modelle

An Speicherformaten für Bilder in Betriebsanleitungen gibt es viele. Hier die wichtigsten mit Vor- und Nachteilen:

JPEG

• Vorteil: Wenig Speicherverbrauch für Jpeg-Dateien
• Vorteil: Geeignet für realistische Bilder mit Farb- und Kontrastübergängen
• Nachteil: Bildkomprimierung verschlechtert die Qualität
• Nachteil: Keine Unterstützung von Transparenz

TIFF

• Vorteil: Verlustfreie Komprimierung
• Vorteil: Speichert Informationen für die nachträgliche Bildbearbeitung
• Nachteil: Tif-Dateien nehmen viel Speicherplatz in Anspruch
• Nachteil: Wird möglicherweise nicht von allen Programmen unterstützt

PNG

• Vorteil: Darstellung von Transparenzen
• Vorteil: Unterstütz von vielen Programmen
• Nachteil: Kann nicht mehrere Bilder in einer Datei speichern

Für die Bearbeitung von Grafiken und Bildern in Betriebsanleitungen stehen eine Vielzahl von Softwareprogrammen zur Verfügung. Eines der bekanntesten Programme ist sicher Adobe Photoshop. Dieses bietet die meisten Einstellungsmöglichkeiten. Dadurch ist die Bedienung des Programmes auch nicht so einfach und die Anschaffungskosten für eine Lizenz sind hoch. Es gibt am Markt aber auch günstigere Alternativen oder sogar Freeware. Die Bildbearbeitungssoftware GIMP oder Photopea sind beispielsweise kostenlos.

Für das Anlegen von Tabellen beim Betriebsanleitung erstellen, sollte man folgende Dinge beachten:

• Tabellen besitzen eine Tabellenüber- bzw. Tabellenunterschrift. In dieser sind die Tabellen durchnummeriert. Zudem bekommt die Tabelle eine Bezeichnung
• Der Tabellenkopf dient als Bezeichner für die jeweiligen Spalte, damit der Benutzer weiß welche Inhalte in den Zeilen und Zellen vorkommen.
• Der Tabellenrumpf bildet die Anzahl an Zeilen unterhalb des Tabellenkopfes und gibt die Inhalte der Tabelle wieder.

Beim Betriebsanleitung erstellen klärt man auch die Frage nach dem richtigen Layout der Anleitung. An Layoutvarianten gibt es:

• Ein normales einspaltig Layout (Text läuft vom linken Rand zum rechten)
• Zwei- oder Mehrspaltiges Layout (Spalten zum Aufteilen von Text und Bildern)
• Layout mit Marginalien
• Querformat
• Hochformat
• Wechselseitig

Größtenteils beziehen sich die Informationen in der Betriebsanleitung hauptsächlich auf den Produktlebenszyklus Produktanwendung. Aber auch in der Phase der Entsorgung bzw. Wiederverwertung eines Produktes sind die Informationen aus der Betriebsanleitung notwendig. Auch tangiert die Betriebsanleitung die Phase der Produktion eines Produktes. Informationen zur Installation und Montage sind hierbei ebenfalls in der Betriebsanleitung zu finden.

Für eine bessere Verständlichkeit einer Betriebsanleitung sollten keine doppelten Verneinungen im Dokument vorkommen.

Ein Beispiel für eine doppelte Verneinung ist:

Stellen Sie sicher, dass nicht zugelassene Geräte nicht in Betrieb gesetzt werden.

Die doppelte Verneinung im Satz verschlechtert die Verständlichkeit der Aussage.

Eine bessere Formulierung wäre in diesem Fall: Stellen Sie sicher, dass nur zugelassene Geräte in Betrieb gesetzt werden

Unter dem Begriff Funktionsverbgefüge sind Verbkonstruktionen gemeint, die eine semantische Einheit darstellen und ein Prädikat bilden. Solch ein Gefüge besteht meist aus einem Funktionsverb und einem Präpositionalobjekt. Solche Funktionsverbgefüge sind eher „gehobenes Beamtendeutsch“ und sollte in der Technischen Dokumentation keine Anwendung finden.

Beispiele für Funktionsverbgefüge und bessere Alternativen:

• In Augenschein nehmen (Alternative: ansehen)
• Eine Einstellung vornehmen (Alternative: prüfen)
• Eine Entscheidung treffen (Alternativ: entscheiden)

Beim Schreiben einer Technischen Dokumentation kommen sowohl bestimmte wie auch unbestimmte Artikel zum Einsatz. Ein unbestimmter Artikel kommt dann zum Einsatz, wenn nichts genaueres über die Person oder die Sache bekannt ist. Ansonsten ist ein bestimmter Artikel zu verwenden. Bekannte Vertreter von bestimmten Artikeln sind „der“, „die“ und „das“. Bei den unbestimmten sind „ein“ oder „eine“ sehr geläufig. 

Beispiele für den Einsatz in der Technischen Dokumentation:

Bestimmter Artikel: Die Schleifmaschine ist zur Behandlung von verschiedenen Werkstoffen geeignet. Unbestimmter Artikel: Eine Maschine verfügt über einen Antrieb.

Bei der Substantivierung in der Technischen Dokumentation spricht man von der Bildung eines Substantivs aus einer anderen Wortart. Beispielsweise durch die Änderung eines Verbs in ein Substantiv.

Beispiel für Substantivierung (aus Verb):

• Berührung (berühren)
• Quetschung (quetschen)
• Abschneiden (schneiden)
• Abstürzen (stürzen)

In den Gebrauchsanweisungen von wiederverwendbaren Medizinprodukten müssen Anweisungen zur sicheren und effektiven Aufbereitung vorliegen. Die Norm DIN EN ISO 17664 beschreibt welche Informationen Produkte zur mehrmaligen Verwendung beiliegen müssen. Die Norm beschreibt unter anderem Aufbereitungsverfahren, wie Medizinprodukte sicher zu reinigen, zu desinfizieren und/oder zu sterilisieren sind.

Die Beschreibung des Arbeitsplatzes an einer Maschine gilt es beim Bedienungsanleitung schreiben zu berücksichtigen. Häufig passieren Unfälle, weil Benutzer während des Betriebes auf eine Maschine steigen oder anderweitig in die Nähe gefährlicher Bereiche geraten. Die sicheren Bereiche für den Bediener vor, hinter oder auf einer Maschine sollten deswegen bekannt sein.

Ebenfalls sollte die Bedienungsanleitung enthalten bei welchen Betriebsarten der Maschine der Arbeitsplatz einzunehmen ist und bei welchen das optional ist. Die am Arbeitsplatz auszuführenden Tätigkeiten sollten ebenso beschrieben sein. Auch Gefahren, die an diesem Arbeitsplatz auftreten können, gilt es zu beschreiben.

Letztendlich dient die klare Definition von sicheren Arbeitsplätze beim Bedienungsanleitung schreiben zudem der Absicherung des Unternehmens im Schadensfall.

Bestimmte Maschinentypen erfordern auch bestimmte Angaben zum Brandschutz, die man beim Betriebsanleitung erstellen berücksichtigen muss. Füllt beispielsweise eine Maschine oder ein Maschinenkomplex eine ganze oder sogar mehrere Hallen, muss man sich Gedanken über Fluchtwege machen und wie man mögliche Feuer eindämmen kann. Eine solche Maschine, die entzündliche Werkstoffe wie Holz- oder Metallspäne beinhaltet, muss Möglichkeiten zur Brandeindämmung bieten. Dies könnte beispielsweise durch Brandschutztüren erfolgen, die ein mögliches Feuer in einen bestimmten Abschnitt eindämmen. Diese Sicherheitsmaßnahmen gilt es in der Betriebsanleitung zu beschreiben. Auch die Fluchtwege bei großen Anlagen, mit der man schnell aus der Gefahrenzone entkommen soll, gilt es in der Betriebsanleitung zu beschreiben.

Beim Betriebsanleitung erstellen ist es sinnvoll wichtige Informationen zum Brandschutz parat zu stellen. Dies kann beispielsweise die Standorte von Brandbekämpfungsmittel wie Feuerlöscher, Feuerleiter oder einem Löschschlauch sein. Die DIN EN ISO 7010 hat hierfür bestimmte Brandschutzzeichen herausgegeben. Diese bestehen aus einem roten Hintergrund mit einem weißen Rand, in dem sich ein weißes Piktogramm befindet. Das Brandschutzzeichen für einen Feuerlöscher nach der aktuellen und international gültigen Norm DIN EN ISO 7010 sieht folgendermaßen aus:

Der Umgang mit Schmiermitteln wie Öle und Fette und deren Entsorgung müssen beim Betriebsanleitung erstellen ebenfalls beschrieben sein. Durch Rückstände von Öle und Fette besteht eine Restgefahr für den Benutzer der Maschine. Dieser muss für den sicheren Umgang mit Schmiermitteln die für das Produkt geltenden Sicherheitsvorschriften beachten. Ebenfalls können für bestimmte Anwendungsgebiete wie für den Lebensmittelbereich besondere Vorschriften gelten, die der Anwender befolgen muss. Deswegen sind in der Betriebsanleitung auch entsprechende Angaben für den Umgang und die Entsorgung von Schmiermitteln anzugeben.

Sicherheitshinweise in einer Betriebsanleitung dienen dazu, den Leser inhaltliche Hinweise zur sicheren Benutzung der Maschine zu geben. Sie sind ähnlich aufgebaut wie Warnhinweise, die aber auch bei der jeweiligen Handlung bzw. Tätigkeit zu finden sind. Jedoch sind die Sicherheitshinweise nicht zeitlich an die entsprechenden Tätigkeiten gebunden. Stattdessen dienen Sicherheitshinweise dazu das sicherheitsgerechte Verhalten grundlegend zu stärken. Daher findet man sie meist in einem eigenen Kapitel in der Betriebsanleitung.

Es ist ratsam eine farbige Betriebsanleitung zu erstellen, damit Piktogramme, Warnhinweise und Bilder für den Leser einfacher zu erkennen sind. Die meisten Hersteller scheuen jedoch die höheren Druckkosten für eine farbige Anleitung. Häufig soll nur das Logo des Herstellers in Farbe gestaltet sein aber der Rest der Betriebsanleitung in Schwarz-Weiß. Meist sind die Druckkosten in dieser Variante jedoch dieselben, da die Seite aufgrund des Logos als farbig gilt und die Abrechnung entsprechend als Farbseite ausfällt. Die Druckkosten sind bei einem Farbdruck auch meistens nur minimal höher als im Schwarz Weiß Druck. Daher empfehlen wir Ihnen Ihre Betriebsanleitung farbig zu erstellen.

Sicherheitshinweise müssen beim Betriebsanleitung erstellen am Anfang der Anleitung in einem gesonderten Abschnitt oder Kapitel stehen. Durch eine Überschrift ist dieser eindeutig als Abschnitt für Sicherheitshinweise zu identifizieren. Beispiele für solche Überschriften in einer Betriebsanleitung können sein:

• Sicherheitshinweise
• Grundlegende Sicherheitshinweise
• Zu ihrer Sicherheit
• Sicherheit und Schutmaßnahmen
• Sicherheit und Verantwortung

Zur Strukturierung des Sicherheitskapitels beim Betriebsanleitung erstellen hat man verschiedene Möglichkeiten. Man kann die Informationen, die für einen sicheren Betrieb der Maschine notwendig sind, beispielsweise nach Lebensphasen des Produktes strukturieren. Ebenfalls eine Strukturmöglichkeit ist nach den Gefährdungsarten wie zum Beispiel elektrische Gefährdungen, heiße Oberflächen, usw. Eine Unterteilung in der Betriebsanleitung nach Baugruppen (Baugruppe 1, Baugruppe 2) ist ebenfalls denkbar.

Die Zielgruppen der Anwender haben gewisse Merkmale, die es beim Betriebsanleitung erstellen zu berücksichtigen gilt. Mittels dieser Merkmale kann man dann den Informationsbedarf ermitteln, die für die sprachliche und gestalterische Ausarbeitung der Betriebsanleitung notwendig sind. Typische Merkmale wie Alter, berufliche Bildung oder andere verhaltensorientierte Merkmale geben zudem Aufschluss darüber, wie eine Betriebsanleitung formuliert sein muss.

Eine Bedienungsanleitung für Produkte, welche auch Kinder benutzen, muss anders geschrieben sein wie eine Bedienungsanleitung, welche nur für Erwachsenen ist.

Die Beschreibung von beruflichen Qualifikationen, die das Bedienpersonal mitbringen muss, ist beim Betriebsanleitung erstellen zu berücksichtigen. Das Sicherheitskapitel in einer Betriebsanleitung kann Auskunft über die notwendige Qualifikation von eingesetztem Personal geben. Die Bedienung einer Maschine darf nur durch entsprechend eingewiesene, geschulte und autorisierte Personen erfolgen. Dürfen Handlungen in bestimmten Lebensphasen der Maschine nur durch speziell geschultes Personal erfolgen wie beispielsweise einem Elektriker, sind dies Vorgänge so zu kennzeichnen, dass ersichtlich ist, dass diese Handlung nur durch eine Fachkraft erfolgen darf. Wenn unzureichend geschulte oder eingewiesene  Personen die Maschine bedienen, bestehen akute Gefahren für Mensch und Maschine. In der Betriebsanleitung müssen deswegen genauere Angaben über die benötigten beruflichen Qualifikationen des Personals stehen, welches die Maschine bedient.

Beim Betriebsanleitung erstellen muss der Hersteller auch Angaben zu den Geräuschemissionen an der Maschine machen. Dafür gilt es, die am Arbeitsplatz entstehenden Lärmpegel zu messen. Aus den für die einzelnen Tätigkeiten festgestellten Lärmbelästigungen erstellt der Technische Redakteur dann die Angaben für die Betriebsanleitung. Diese gilt es dann als ausgehende Emissionswerte zu dokumentieren. Diese Angaben sind in der Betriebsanleitung meistens als Restgefährdungen unter dem Kapitel allgemeine Sicherheit hinterlegt oder stehen in den Technischen Daten des Produktes unter dem Kapitel Produktbeschreibung.

Es gibt keine Vorgaben, dass beim Betriebsanleitung erstellen die Signalworte in den Warnhinweisen farblich unterlegt sein müssen. Diese können sowohl schwarz-weiß gehalten sein wie auch farbig. Sollte eine farbliche Unterlegung bei der Gestaltung von Warnhinweisen zum Einsatz kommen, sind die Farben gemäß der entsprechenden Gefahrenstufe anzugeben. (Gefahr = rot, Warnung = orange, Vorsicht = gelb)

Das Land, in welches die Maschine samt Anleitung geht, spielt beim Betriebsanleitung erstellen ebenfalls eine Rolle. In den unterschiedlichen Regionen der Erde herrschen unterschiedliche kulturelle Sitten und Gegebenheiten. Dies gilt auch für Piktogramme in den Warnhinweisen einer Betriebsanleitung. Die Abbildung der Mimik oder Gestik von Personen oder Tieren auf Bildern kann im asiatischen Markt zu Problemen führen. Ähnliches gilt zudem für Körperteile oder religiöse Symbole. In den USA weichen die Piktogramme nach ANSI ebenfalls von denen der ISO ab. Diese stellen in der Regel eindeutiger und „brutaler“ die möglichen Folgen einer Gefahrenquelle dar.

Beim Betriebsanleitung erstellen ist darauf zu achten, den Benutzer ausreichend im Sicherheitskapitel zu informieren. Das Sicherheitskapitel soll nämlich den Benutzer für den sicheren Gebrauch des Produktes anleiten. Ein bloßes Anreihen von Warnhinweisen in einem Stil wie die Warnschilder am Produkt ist dabei nicht zielführend.

Warnhinweise sind ein Teil der allgemeinen Gefahren in der Betriebsanleitung. Aber genauso gehören u.a eine Beschreibung der Benutzer des Produktes sowie Einschränkungen für bestimmte Nutzergruppen aufgrund ihrer fachlichen Qualifikation dazu. Ebenso eine Erklärung der grafischen Symbole für sicherheitsbezogenen Informationen an der Maschine und in der Betriebsanleitung.

Beim Betriebsanleitung erstellen müssen Angaben über die Art und Häufigkeit von Instandhaltungs- und Reinigungsarbeiten angegeben werden. Dazu gehört das Material und Werkzeuge sowie genügend detaillierte Beschreibungen zu den Tätigkeiten für die Instandhaltung und Reinigung des Produktes. Zu beachten ist zudem die Qualifikation des eingesetzten Personales. Informationen für geschultes und nicht geschultes Personal müssen separat in der Betriebsanleitung bereitstehen. Die lokale Gesetzgebung und der lokale Arbeitsschutz wirken sich auch auf die jeweiligen Angaben aus.

Eine Betriebsanleitung zu erstellen heißt auch diese verständlich für den Benutzer zu verfassen. Der Text sollte nach Möglichkeit unnötige Fremdwörter vermeiden und lange Zusammensetzungen von Hauptwörter ersparen. Falls für komplizierte Ausdrücke auch einfachere Begriffe vorhanden sind, sollte man diese in der Betriebsanleitung verwenden. Für einen Hohlraumdübel kann man in der Anleitung dafür auch den Begriff Dübel verwenden. Auch sollten keine Begriffe mit absoluter Bedeutung in der Betriebsanleitung stehen. Begriffe wie unfallsicher, wartungsfrei oder ungefährlich sind vor Gericht juristisch nicht haltbar.

Zubehör und Ausstattungsvarianten können beim Betriebsanleitung erstellen im zweiten Kapitel der Anleitung abgebildet sein. Dieses Kapitel beschäftigt sich mit der Beschreibung des Produktes. Dazu zählen auch weitere Zubehör- und Ausstattungsvarianten für das Produkt. Gibt es das Produkt in unterschiedlichen Varianten, dann kann der Benutzer in der Betriebsanleitung nachschauen, welche Teile seine Variante enthält.

Beim Betriebsanleitung erstellen muss eine ausreichende Schriftgröße für die angestrebte Zielgruppe ausgewählt sein. Ist die Zielgruppe auf ältere Menschen ausgelegt, muss die Betriebsanleitung entsprechend große Buchstaben enthalten. Auch sollte man ausgefallene Schriftarten oder Schriftstile vermeiden. Textauszeichnungen wie Fettdruck oder Kursivschrift sollte man ebenfalls nur mit Augenmaß einsetzen.

Kurze Sätze mit klaren Anweisungen sorgen beim Erstellen einer Betriebsanleitung für keine Unverständlichkeiten. Lange Sätze mit Einschübe, Relativsätze und Linkserweiterungen lassen Raum für Interpretationen. Ideal ist daher eine eindeutige Aussage pro Satz. Eine Anweisung wie zum Beispiel „Öffnen Sie die Abdeckung, nachdem Sie die Maschine ausgeschaltet haben.“ kann der Anwender falsch verstehen. Eine deutlichere Aussage erreicht man mit einer Reihenfolge von kurzen Sätzen in der Betriebsanleitung: „Schalten Sie die Maschine aus. Öffnen Sie die Abdeckung.“

Beim Betriebsanleitung erstellen ist darauf zu achten, dass ebenfalls ausreichend Information zum sicheren Transport einer Maschine vorhanden sind. Beim Transport besteht die Gefahr, dass eine Maschine durch Umfallen bzw. Herunterfallen eine Person verletzen kann. Um Risiken beim Transport zu minimieren, müssen Angaben zum Gewicht der Maschine und deren Abmessungen bekannt sein. Sind spezielle Handlungen für den sicheren Transport der Maschine vorzunehmen, müssen diese Informationen ebenfalls in der Betriebsanleitung beschrieben sein. Ist der Transport der Maschine nur durch den Hersteller vorgesehen, ist es trotzdem ratsam, alle nötigen Angaben zum sicheren Transport der Maschine in der Betriebsanleitung anzugeben.

Die Seitennummerierung sollte beim Erstellen einer Betriebsanleitung konsequent fortgeführt werden. Beginnen die Seitenzahlen immer wieder von vorne (bspw. bei einem Kapitelwechsel), verliert der Benutzer die Übersichtlichkeit bzw. Orientierung. Die Vollständigkeit einer Betriebsanleitung ist auf diese Weise zudem nicht garantiert, da die Seitenzahlen immer wieder von vorne beginnen.

Beim Betriebsanleitung erstellen kennzeichnet man die Restrisiken der Maschine mit entsprechenden Piktogrammen auf den Warnhinweisen. Diese sollten für ein besseres Verständnis der ISO 7010 Norm entsprechen. Die Symbole aus dieser Norm sind geläufig bekannt und sind daher für den Leser in der Betriebsanleitung einfacher zu erkennen. Falls in der Anleitung bekannte Symbole für einen anderen Zweck vorkommen, ordnet der Benutzer dessen Bedeutung falsch zu und unterschätzt dadurch die potenzielle Gefahr.

Beim Erstellen einer Betriebsanleitung ist die DIN EN 82079-1 eine gute Hilfe für sprachliche Regeln. Die Norm definiert, dass der Satzbau in einer Betriebsanleitung aus kurzen präzisen Sätzen (Subjekt, Prädikat, Objekt) bestehen soll. Weiterhin soll man geläufige Wörter verwenden, welche die jeweilige Zielgruppe der Betriebsanleitung auch verstehen. Nichtssagende Floskeln sollte man beim Betriebsanleitung erstellen vermeiden, genauso wie Konjunktiv- und Passiv-Konstruktionen. Wann immer es möglich ist, sollte man etwas positiv formulieren anstatt negativ.

Nachfolgend einige Beispiele für gute und schlechte Formulierungen für Handlungsaufforderungen in einer Betriebsanleitung:

+ Drücken Sie den Hauptschalter der Maschine

+ Den Hauptschalter der Maschine drücken

– Sie sollten den Hauptschalter der Maschine drücken

– Man drücke den Hauptschalter der Maschine

Bei Maschinen mit elektromagnetischen Feldern gibt es einige Besonderheiten, die es beim Betriebsanleitung erstellen zu beachten gilt. Beispielsweise dürfen Personen mit Herzschrittmachern und Defibrillatoren sich nicht in der Nähe dieser elektromagnetischen Feldern aufhalten. Dies könnte ansonsten die Funktionsfähigkeit dieser lebensnotwendigen Geräte beeinflussen. In der Betriebsanleitung ist beispielsweise mit einem Verbotszeichen hinzuweisen, dass der Zutritt zur Maschine auf bestimmte Personen beschränkt ist.

Falls bei Arbeiten an einer Maschine Gefahren für das menschliche Auge bestehen, muss man beim Betriebsanleitung erstellen darauf hinweisen. Hilfs- und Betriebsstoffe im Maschinenbau können nämlich für das menschliche Auge gefährlich sein. Deswegen ist bei Arbeiten an der Maschine ein entsprechender Schutz in Form von einer Schutzbrille zu tragen. In der Betriebsanleitung ist dann ebenfalls hinzuweisen, dass die Schutzbrille zur Bedienung der Maschine notwendig ist.  Mit einem entsprechenden Piktogramm an der Maschine und in der Betriebsanleitung kann der Unternehmer auf diese Pflicht hinweisen.

Wenn eine Maschine sehr laut ist, müssen beim Betriebsanleitung erstellen entsprechende Angaben zum den Schallemissionswerten stehen. Ist der Schalldruckpegel über 80 dB(A) sind von dem betreibenden Unternehmen entsprechende persönliche Gehörschutzmittel auszugeben. In der Betriebsanleitung kann mit einem entsprechenden Gebotssymbol auf die Notwendigkeit des Gehörschutzes an der Maschine hingewiesen werden.

Beim Erstellen einer Betriebsanleitung kann man auch Angaben zu dem Typenschild und dessen Anbringungsort an der Maschine machen. Die Angaben die auf dem Typenschild stehen wie Adresse und Namen des Hersteller, Bezeichnung der Maschine, Typen- oder Baureihenbezeichnung (ggf. Seriennummer), Baujahr und die CE-Kennzeichnung kann man in der Betriebsanleitung wiedergeben. Mithilfe der Betriebsanleitung und dem Typenschild am Produkt kann der Leser dann die Zuordnung von Anleitung und Produkt einfacher durchführen und so schneller wichtige Informationen bspw. in Servicefällen weitergeben.

In dem ersten Kapitel einer Betriebsanleitung sollte zur besseren Orientierung eine kurze Übersicht stehen, welchen Zweck die Anleitung erfüllen soll. Darin sollten eine Grobübersicht der Kapitel und eine Erläuterung der Zielgruppen dargestellt sein. Daneben kann man in diesem Kapitel auf die Bedeutung der Betriebsanleitung hinweisen und das diese ein Teil des Produktes ist. Weiterhin ist beim Betriebsanleitung erstellen eine Erläuterung zur Darstellung von Informationssymbolen und allgemeinen Symbolen in diesem Abschnitt sinnvoll.

Nach der Erstellung einer Betriebsanleitung ist das Titelblatt die erste Informationsquelle, die der Benutzer von der Anleitung zu sehen bekommt. In aller Kürze sollten dort die wichtigsten Informationen rund um das Produkt stehen. Dazu gehören beispielsweise die Produktbezeichnung, der Produkttyp und eine Abbildung des Produktes. Auch das Baujahr oder andere wichtige Identifikationsmerkmale für die Maschine wie Maschinennummer oder Artikelnummer kann dort aufgeführt sein. Weiterhin können auf dem Deckblatt Angaben zu der Betriebsanleitung selbst stehen in Form von einer Bezeichnung für die Dokumentenart wie Originalbetriebsanleitung bzw. Originalfassung der Betriebsanleitung. Ebenfalls eine Versionsnummer der Anleitung und das Druckdatum sind auf dem Titelblatt aufgeführt.

Die zweite Seite beim Betriebsanleitung erstellen beschäftigt sich mit den Angaben zum Autor und Rechteinhaber in Form eines Impressums. Ebenso dient dieses Impressum dazu, wichtige rechtliche Aussagen bezüglich der Anleitung zu hinterlegen. Das kann ein Copyright Vermerk sein und eine Ausschlussklausel bezüglich der Vervielfältigung der Betriebsanleitung ohne vorherige Abstimmung mit dem Hersteller. Auch Verweise, dass Bilder nur zur Veranschaulichung dienen und nicht unbedingt maßstabsgetreu dargestellt sind, können im Impressum hinterlegt sein.

Es ist ratsam die Handlungsanweisungen beim Betriebsanleitung erstellen im Aktiv zu verfassen, damit die Dringlichkeit der Anweisung erkennbar ist. Die Handlungsanweisung soll in überschaubaren Schritten die auszuführende Handlung beschreiben. Sind Handlungsanweisungen im Passiv formuliert, signalisiert das nicht die gegebene Dringlichkeit. Eine im Passiv formulierte Handlungsanweisung in der Betriebsanleitung versteht der Benutzer dann so, dass nicht (sofort) eine Handlung durchzuführen ist.

Die wichtigsten Angaben zum Verhalten im Falle eines Unfalles sollten beim Betriebsanleitung erstellen mit angegeben sein. Dazu zählen wichtigen Angaben für den Notfall wie beispielsweise:

• Handlungsaufforderungen (NOT-HALT betätigen, Hauptschalter ausschalten, Personen aus der Gefahrenzone bringen, usw.)
• Feuerbekämpfungsmaßnahmen (dafür zu verwendende Löschmittel bei speziellen Bränden)
• Erste-Hilfe-Maßnahmen (Notruf absetzen, Verantwortliche informieren, Zufahrtswege freimachen)
• Fluchtwege bei sehr großen Anlagen oder Maschinen (Wo sind Notausgänge, Rettungsleitern, usw.)
• Verhaltensweisen (Ruhe bewahren, sich nicht in Gefahr bringen)

Arbeitsplätze, die ein Anwender an der Maschine einnehmen kann, sollen beim Betriebsanleitung erstellen beschrieben sein. Dazu gehören alle Standorte an der Maschine, die durch Personal zu besetzen sind. Auch Bedienungseinrichtungen wie Bildschirme oder Terminals gilt es in der Betriebsanleitung zu beschreiben.

Um vor potentiellen Gefahrenstellen an einer Maschine zu warnen, muss man beim Betriebsanleitung erstellen auch die Gefahrenquellen genau beschreiben. Es gibt dazu unterschiedliche Arten, wie man die Restrisiken einer Maschine in den Warnhinweisen der Betriebsanleitung klassifiziert. Zu den Arten zählen unter anderem Mechanische, Elektrische, Thermische und Biologische Gefährdungen. Diese Arten unterteilen sich dann in eine Liste von weiteren Gefahrenarten. So gibt es beispielsweise im Bereich der Mechanischen Gefährdungen unter anderem:

• Rotierende Teile
• Bewegende Teile
• Herabfallende Teile
• Schneidende Teile
• Teile mit rauer oder rutschiger Oberfläche

Während man eine Betriebsanleitung erstellt, muss man sich auch mit der Formulierung von Warnhinweisen auseinandersetzen. Um Warnhinweise dahingegen verständlich und normengerecht zu formulieren, muss man das SAFE-Prinzip beachten.

1. S = Signalwort (Abhängig von der Schwere der Gefahrensituation)
2. A = Art und Quelle der Gefahr (Woher kommt die Gefahr / Was ist die Gefahrenquelle?)
3. F = Folgen bei Nichtbeachtung (Was passiert bei Nichtbeachtung des Hinweises)
4. E = Entkommen / Vermeiden (Wie kann die Gefahrensituation vermieden / gelöst werden?)

Nachfolgend ein beispielhafter Text für einen Warnhinweis nach dem SAFE-Prinzip, welcher vor Risiken aufgrund elektrischer Gefahren warnt.

(S) GEFAHR!

(A) Lebensgefahr durch elektrische Spannung.

(F) Bei Berührung spannungsführender Teile besteht unmittelbare Lebensgefahr.

(E) Keine spannungsführenden Teile im Betrieb berühren. Feuchtigkeit von spannungsführenden Teilen fernhalten. Die Sicherheitsregeln für die Durchführung von Arbeiten an elektrischen Anlagen und Betriebsmitteln befolgen.

Beim Betriebsanleitung erstellen bezeichnet man die Definition des bestimmungsgemäßen Gebrauches und dem vorhersehbaren Fehlgebrauch als Grenzen einer Maschine. Der bestimmungsgemäße Gebrauch beschreibt zudem für welchen Funktionszweck die Maschine dient. Darauf folgt eine Beschreibung der Umgebung, in der die Maschine zum Einsatz kommt. In den vorhersehbaren Fehlgebrauch beschreibt man in der Betriebsanleitung die absichtliche Fehlanwendung und auch die unabsichtliche Fehlanwendung der Maschine. Als Beispiel für den bestimmungsgemäßer Gebrauch kann man die Bearbeitung von Teilen nennen, die eine bestimmte Dicke und Gewicht aufweisen. Die Bearbeitung von Teilen, die über den definierten Werte liegen, zählen als hervorsehbare Fehlanwendung.

Beim Betriebsanleitung erstellen berücksichtigt ein Technischer Redakteur ebenfalls die Angaben zur Demontage einer Maschine. Vor Demontage einzelner Teile der Maschine oder der gesamte Maschine, müssen Informationen parat stehen, welche Vorbereitungen man treffen muss. Dazu zählen unter anderem in welcher Reihenfolge die Leitungen von Anschlüsse zu entlasten und freizuschalten sind. Ebenfalls eine Aufzählung in der Betriebsanleitung von möglichen Gefahren, die bei der Demontage einer Maschine auftreten kann. Auch über verbliebene Flüssigkeiten oder Stoffe in der Maschine, die speziell zu entfernen sind, müssen Informationen hinterlegt sein.

Im Zuge der Erstellung einer Betriebsanleitung muss der Redakteur sich auch Gedanken über die Aufstellung einer Maschine machen. Wie ist diese aufzustellen und wo darf die Maschine aufgestellt sein? Ein Aufstellplan oder ein Lageplan zum Aufstellen der Maschine ist dafür in der Betriebsanleitung hilfreich. Auch besondere Anforderungen an das Fundament sollten in der Betriebsanleitung beschrieben sein. Ebenfalls sollte in der Anleitung stehen, wer die Maschine überhaupt aufstellen darf. Ist es möglich diese in Eigenregie aufzustellen oder darf das nur der Hersteller machen?

Der Transport einer Maschine ist beim Betriebsanleitung erstellen ein wichtiges Kapitel in der Technischen Dokumentation. Beim Transport besteht die Gefahr, dass eine schwebende Maschine durch Herunterfallen einen Menschen verletzt und/oder auch die Maschine beschädigt. Deswegen müssen in der Betriebsanleitung auch Angaben zu den Tragkräften vorhanden sein, um eine Maschine sicher bewegen zu können. So muss beispielweise in der Betriebsanleitung stehen, wie stark die Leistung eines Gabelstaplers oder Kran sein muss, damit dieser die Maschine anheben kann.

Beim Betriebsanleitung erstellen sollten genaue Angaben zu den Lagerbedingungen für die Maschine bekannt sein. Eine Angabe, die bekannt sein muss, ist die Tragfestigkeit die der Untergrund aufweisen muss, auf dem die Maschine abgestellt ist. Auch andere Bedingungen wie die Luftfeuchtigkeit, die im Lagerort herrschen darf, müssen müssen in der Betriebsanleitung bekannt sein. Falls beispielsweise die  Maschine mithilfe einer ungeeigneten Abdeckplane im Freien lagert, kann die Maschine durch Feuchtigkeit Schaden nehmen. Oder falls beim Transport per Schiff durch einen undichten Container Meerwasser in den Container eindringt, korrodiert der Stahl an der Maschine aufgrund des Salzgehalts des Wassers.

Im Rahmen seiner Fabrikationspflicht muss der Hersteller beim Betriebsanleitung erstellen auf die Schutzeinrichtungen an einer Maschine hinweisen. Der Benutzer einer Maschine muss über alle Schutzeinrichtungen informiert sein, die an der Maschine verbaut sind. Durch die Angaben in der Betriebsanleitung ist zudem auch eine Überprüfung der Schutzeinrichtungen in Hinsicht auf ihre fehlerfreie Funktionalität möglich.

Die Art wie eine Betriebsanleitung aufzubewahren ist, spielt schon beim Betriebsanleitung erstellen eine Rolle. Die Maschinenrichtlinie 2006/42/EG fordert, dass die technischen Unterlagen einer Maschine für zehn Jahre lang nach dem Tag der Fertigstellung bereitzuhalten sind. Da sich eine Maschine über die Jahre verändern kann, verändert sich entsprechend auch die Betriebsanleitung. Der Hersteller ist weiterhin verpflichtet, die Anleitung für mindestens zehn Jahre bereitzuhalten. Ein Redaktionssystem kann daher sehr nützlich sein, wenn für eine Maschine mehrere Versionen der Betriebsanleitung vorliegen. Alte Versionsstände der Anleitung kann man so leicht auswählen und bei Bedarf vorlegen.

Ein Hersteller muss sich beim Betriebsanleitung erstellen ebenfalls mit dem möglichen vorhersehbaren Fehlgebrauch auseinander setzen. In der Anleitung ist auf eine Anwendung hinzuweisen, die nicht vom Hersteller beabsichtigt ist. Solch eine Anwendung ergibt sich meistens aus dem menschlichen Verhalten. Dabei ist die Wahrscheinlichkeit des Eintretens entscheidend. Ein Hersteller muss sich also fragen, ob der Benutzer das Produkt einfach manipulieren kann, um den Gebrauchszweck zu ändern? Ist mit einem Missbrauch des Produktes zu rechnen, so muss der Hersteller auf diesen vorhersehbaren Fehlgebrauch in der Betriebsanleitung hinweisen.

Ein nahe liegender Missbrauch bzw. Fehlgebrauch muss vom Hersteller einer Maschine beim Betriebsanleitung erstellen beschrieben sein. Als Vorhersehbarer Fehlgebrauch kann beispielsweise die Frage sein, was passiert, wenn andere Betriebsmittel oder Ersatzteile als vorgeschrieben zum Einsatz kommen. Die völlige Zweckentfremdung des Produktes soll bei der Beschreibung in der Betriebsanleitung aber keine Betrachtung finden. Beispiel für den vorhersehbaren Fehlgebrauch ist die Verwendung eines Schraubenziehers als Meißel.

Beim Betriebsanleitung erstellen ist es wichtig die Zielgruppe der Anwender zu betrachten. Die Anwender eines Produktes umfassen meist unterschiedliche Personengruppen. Auch muss der Hersteller eines Produktes damit rechnen, dass sein Produkte eine stärker gefährdete Zielgruppe verwenden wie Kinder oder ältere Menschen. Über Risiken muss der Hersteller anders informieren, um für die Verringerung des Haftungsrisikos zu sorgen. Die Betrachtung der Zielgruppe gibt zudem darüber Aufschluss, ob die Nutzer der Betriebsanleitung Kenntnisse von den eingesetzten Fachbegriffen haben. Falls diese nicht bekannt sind, so sind diese beim ersten Auftauchen in der Betriebsanleitung ausführlich zu erklären. Ein Glossar am Ende der Betriebsanleitung, welches die Fachbegriffe enthält, ist ebenfalls sinnvoll.

Sie benötigen eine kostenlose Vorlage um eine Betriebsanleitung erstellen zu können? Diese können wir Ihnen gerne anbieten, wir bieten Vorlagen für Musterbetriebsanleitungen, Beispiele für Sicherheitshinweise und nützliche Checklisten an. Für weitere Informationen stehen wir Ihnen dazu gerne zur Verfügung. Rufen Sie uns einfach an oder schreiben Sie uns eine E-Mail dazu.

Der redaktionelle Prozess um eine Betriebsanleitung zu erstellen, kann sehr kompliziert sein. Normen schreiben vor, wie die Betriebsanleitung auszusehen hat und welche Inhalte sie haben muss. Auch die Einhaltung einer Terminologie ist ohne Hilfsmittel nicht einfach. Daher ist es ratsam in der Technischen Dokumentation zur einheitlichen Formulierung von Fachbegriffen einen Redaktionsleitfaden zu benutzen. Auch die sprachlichen Regelungen, Layoutvorgaben und die Informationsverteilung in der Betriebsanleitung kann ein Redaktionsleitfaden regeln. Ein weiteres nützliches Hilfsmittel in der Technischen Dokumentation ist zudem der Einsatz eines Redaktionssystems.

Das Thema Entsorgung von Hilfsstoffen im Maschinenbau nimmt während der Betriebsanleitung erstellen einen wichtigen Stellewert ein. Für den Benutzer der Maschine muss nachvollziehbar sein, wie Rückstände von Hilfs- und Betriebsstoffe im Produkt zu entfernen sind. Auch Angaben wie solche Stoffe wie Schmieröle und –fette zu entsorgen sind, sind in der Betriebsanleitung mitanzugeben.

Beim Betriebsanleitung erstellen müssen für die Lagerung eines Produktes einige Informationen bekannt sein. Dazu zählen unter anderem Angaben, welche Umgebungsbedingungen für die Lagerung herrschen dürfen. Auch die Abmessungen und Gewichtsangaben können bei der Lagerung wichtig sein. Ein Verweis in der Betriebsanleitung bietet sich hier an. Besteht das Produkt aus mehreren Teilen sind Hinweise zum Lieferumfang beim Betriebsanleitung erstellen anzugeben. Auch Hinweise zum Auspacken und zum Wiederverpacken, wenn dies bei der Lagerung nötig ist, sind mitanzugeben.

Im Zuge der Installation einer Maschine sind beim Betriebsanleitung erstellen ebenfalls einige Details zu berücksichtigen. Neben Angaben wie die Verpackung zu entfernen ist und diese zu entsorgen sind, müssen auch die Bedingungen für den Zusammenbau der Maschine bekannt sein. So muss beschrieben sein, wie während der Installation alle Versorgungsanschlüsse (Elektrik, Wasser, Druckluft, Hydrauliköl, usw.) anzuschließen sind. Sollten für Entsorgungsleitungen (wie Abwasser oder Altöl) ebenfalls Anschlüsse vorhanden sein, ist deren Installation ebenfalls in der Betriebsanleitung zu beschreiben.

In der Betriebsanleitung sind alle Informationen zu nennen, die für die Inbetriebnahme notwendig sind. Hierzu gehören detaillierte Beschreibungen von Abnahme-, Inspektions- und Betriebstests sowie alle durchzuführende Prüfungen bevor das Produkt in Betrieb geht. Das kann unter anderem die Überprüfung aller Sicherheitseinrichtungen sein oder ob alle Anschlüsse angeschlossen sind. Die Angaben in der Betriebsanleitung zur ordnungsgemäßen Inbetriebnahme der Maschine ist eine Voraussetzung für den sicheren Betrieb der Maschine.

Ein Technischer Redakteur berücksichtigt beim Betriebsanleitung erstellen ebenfalls die Angaben zur Entsorgung eines Produktes. Benötigt man ein Produkt nicht mehr, ist dieses fachgerecht zu entsorgen. Dabei müssen Informationen hinsichtlich Außerbetriebnahme, Demontage, Recycling und Entsorgung des Produktes in der Betriebsanleitung stehen. Da sich die gesetzlichen Anforderungen an die Entsorgung bzw. Recycling über die Zeit ändern können, ist darauf in der Betriebsanleitung hinzuweisen. Ein Vermerk, dass der Betreiber bzw. Benutzer des Produktes sich über die geltenden Bestimmungen zu informieren hat, ist hierbei hilfreich.

Beim Erstellen einer Betriebsanleitung sind möglicherweise Informationen bereitzustellen über die Reparatur von Produkten und dem Austausch von Teilen. Dies ist abhängig von der Zielgruppe der Betriebsanleitung. Solche Informationen sollen nur geschulten Personen bereit stehen. Bekannt sein müssen zudem Bezugsquelle der Teile, Vorgehensweise bei Austausch, Reparatur sowie Prüfung nach Austausch oder Reparatur. Zudem sollten Informationen zum Kundendienst in der Betriebsanleitung abgebildet sein.

Im Prozess eine Betriebsanleitung zu erstellen, gehört die Beschreibung des Produktes zu einem der ersten Kapitel. Angaben, die helfen das Produkt zu identifizieren gehören in diesen Abschnitt der Betriebsanleitung. Darunter zählen Angaben wie die Seriennummer, das Modell sowie Angaben zum Hersteller. Weiterhin gehören Merkmale des Produktes wie Technische Daten ebenfalls dazu. Eine tabellarische Darstellung dieser Angaben erhöht die Leserlichkeit dieser Informationen. Die jeweiligen Produktnormen enthalten Angaben dazu, welche Informationen in dem Kapitel der Betriebsanleitung zur Identifikation des Produktes stehen müssen.

Nur ausreichend geschulte Personen sollten eine Betriebsanleitung erstellen und überprüfen. Neben kommunikativen Kompetenzen sollte die zuständige Personen über ausreichende Methodenkompetenz in Hinsicht auf Sprache und Schreibstil verfügen. Weiterhin sollten die Personen sich mit dem Themenbereich der zu erstellenden Betriebsanleitung wie auch den relevanten Normen zur Erstellung auskennen.

Die Art wie eine Betriebsanleitung verfügbar bleibt, spielt schon bei der Erstellung einer Betriebsanleitung eine Rolle. Während der gesamten Lebensdauer des Produktes muss die Betriebsanleitung leicht zugänglich sein. Dies gilt auch für papierlose Betriebsanleitungen auf Datenträgern.

Die Pflicht eine Betriebsanleitung zu erstellen ist durch Forderungen aus Gesetzen, Normen und Richtlinien hinterlegt. Die Betriebsanleitung ist Teil des Produktes und muss daher beim Bereitstellen des Produktes auf dem Markt vorliegen. Dies ist eine Vorgabe aus dem Produktsicherheitsgesetz. Auch diverse EU-Richtlinien fordern für ein Produkt eine Betriebsanleitung, damit man dieses sicher verwenden kann. Keine Betriebsanleitung zu erstellen gilt als Sachmangel am Produkt und führt zu Produktrückrufen bzw. Vertriebsverboten für die unsicheren Produkte.

Die Norm EN 82079 fordert für den Prozess der Betriebsanleitung erstellen einen Korrekturlesevorgang durch eine zweite Person mit technischen Hintergrundwissen. Die fertige Betriebsanleitung einer Maschine ist nach dem Erstellen durch eine zweite fachliche Person gegenzulesen und auf Verständnisprobleme zu prüfen. Dies können Personen sein, die dabei mit der Maschine arbeiten und über das technische Fachwissen verfügen.

Die Bedienplätze, die ein Anwender an der Maschine einnehmen kann, gilt es während man die Betriebsanleitung erstellt, zu berücksichtigen. Eine Übersicht aller Standorte von Bedienplätzen verdeutlicht dem Anwender, an welchen Standorten man die Maschine bedienen kann.

Um Ihnen eine Betriebsanleitung erstellen zu können, benötigen wir einige Daten von Ihnen. Die Risikobeurteilung, zutreffende Normen und Richtlinien, Angaben zur Zielgruppe, Vorgaben zur Gestaltung der Anleitung, Anleitungen von Zulieferer sind nur einige Punkte darunter. Weiterhin benötigen wir einen Ansprechpartner für Rückfragen, die während wir die Betriebsanleitung erstellen auftreten können. Der Schutz Ihrer personenbezogenen Daten nimmt bei uns entsprechend einen hohen Stellenwert ein. Sie können unsere aktualisierte Datenschutzhinweise hier nachlesen.

Die Struktur im Kapitel Transport in der Betriebsanleitung sollte sich dabei nach den zeitlichen Tätigkeiten in diesem Kapitel strukturieren. Um eine vernünftige Struktur in der Betriebsanleitung zu erstellen, sollte man sich zuerst einige Fragen stellen. Welche sicherheitstechnischen Informationen müssen für das Kapitel Transport bekannt sein? Wie ist das Produkt verpackt und womit kann man die Maschine transportieren? Wie stellt man das Produkt auf und wie lagert man es?

In der Betriebsanleitung müssen Bedienungselemente ausführlich beschrieben sein. Dazu gehört eine Übersicht und Position aller Anzeige- und Kontrollinstrumente. Auch die Anordnung und Benennung der Bedienungselemente muss mit Fotos, Skizzen oder Zeichnungen in der Betriebsanleitung erfolgen.

Ein logischer Aufbau von Handlungsanweisungen in der Technischen Dokumentation erleichtert dem Benutzer die Nachvollziehbarkeit der Handlung. Folgende Schritte sollte man demzufolge bei der Erstellung von Handlungsanweisungen befolgen:

1. Warum muss eine Handlung durchgeführt werden? (Bsp.: Ein verstopfter Filter beschädigt die Maschine)
2. Welche Voraussetzungen gibt es dafür? (Lampe leuchtet, wenn der Filter verstopft ist)
3. Wie geht man der Reihe nach vor? (1. Zuerst Deckel öffnen 2. Filtersicherung entriegeln 3. …)
4. Was ist das Ergebnis der Handlung? (Die Lampe an der Maschine erlischt)

Eine Betriebsanleitung erstellen bedeutet auch sich mit der logischen Abfolge der Kapitel innerhalb der Betriebsanleitung zu befassen. Die Abfolge der Kapitel sollte sich anhand der Lebensphasen des Produktes orientieren. Im Folgenden steht die logische Abfolge (nur die erste Hierarchieebene) der Kapitel einer allgemeinen Betriebsanleitung im Maschinenbau:

• Titelseite
• Impressum
• Inhaltsverzeichnis für die gesamte Betriebsanleitung
• Zweck dieser Betriebsanleitung
• Orientierung in der Betriebsanleitung
• Kapitel 1 Identifikation der Maschine
• Kapitel 2 Maschinenbeschreibung, Aufbau und Funktion
• Kapitel 3 Grundlegende Sicherheitshinweise
• Kapitel 4 Transport, Aufstellung und Lagerung
• Kapitel 5 Bedienungs- und Anzeigenelemente, Betriebsarten
• Kapitel 6 Montage und Inbetriebnahme
• Kapitel 7 Bedienung
• Kapitel 8 Einrichten
• Kapitel 9 Wartung und Instandhaltung
• Kapitel 10 Entsorgung
• Kapitel 11 Ersatzteilliste
• Kapitel 12 Anhang

Nach dem Erstellen einer Betriebsanleitung liegen die Urheber-/Nutzungsrechte immer beim Ersteller des Dokumentes. Wir als Dienstleister für Technische Dokumentation sind natürlich gerne dazu bereit, Ihnen die ausschließlichen Nutzungsrechte an einer von uns erstellten Betriebsanleitung zu überlassen. Benötigen Sie Unterstützung bei der Erstellung einer Betriebsanleitung? Wir machen Ihnen gerne für die Erstellung und Pflege aller Technischen Dokumentationen ein Angebot. Rufen Sie hierzu uns einfach an oder schreiben uns eine E-Mail.

Beim Erstellen einer Betriebsanleitung sollte man drauf achten, ein Abbildungsverzeichnis mit einzubauen. Ein Abbildungsverzeichnis verhilft den Benutzer dabei, die Übersichtlichkeit in der Betriebsanleitung nicht zu verlieren. Der Zugriff auf gesuchte Informationen ist dadurch erleichtert. Wenn zum Beispiel eine Betriebsanleitung viele Abbildungen enthält, verhilft dem Benutzer das Abbildungsverzeichnis eine speziell gesuchte Abbildung (wie das Übersichtsbild über alle Not-Aus-Vorrichtungen an der Maschine oder Anlage) schneller zu finden.

Sie möchten eine gute und verständliche Technische Dokumentation von einem Experten erstellen lassen? Dabei sind wir Ihnen gerne behilflich. Wir können die Erstellung einer Technischen Dokumentation für Sie übernehmen und unterbreiten Ihnen dazu gerne ein Angebot. Für eine Angebotserstellung benötigen wir unter anderem folgende Daten:

• CAD-Zeichnungen
• Bilder
• Technische Daten aus alten Anleitungen
• Frühere Versionen Ihrer Betriebsanleitung oder eines ähnlichen Produktes
• Weitere Dokumente wie zum Beispiel eine Risikobeurteilung

Bei der Erstellung einer Betriebsanleitung im Maschinenbau kann eine Checkliste an mehreren Stellen hilfreich sein. Beispielsweise bei der Erstellung eines guten Sicherheitskapitels. Dieses entsteht durch eine genaue Risikobeurteilung. Mit der Analyse von möglichen Gefahrenquellen kann man Risiken im Maschinenbau einschätzen und passende Gegenmaßnahmen treffen. Um mögliche Gefahren sinnvoll analysieren zu können, sollten alle relevanten Gesetzte und Normen bekannt sein. Alle relevanten Anforderungen trägt man in einer Checkliste zusammen, die dann zum Recherchieren und Kontrollieren der Risikobeurteilung verwendbar ist.

In einer Betriebsanleitung sollten pro Zeile zwischen 45 bis 65 Zeichen stehen. Bei einer Schriftgröße von 10 Punkten sollte der Zeilenabstand ungefähr 12 Punkte betragen. Wählt man eine größere Schriftgröße, so kann der Zeilenabstand dafür etwas geringer ausfallen. Bei langen Zeilen muss zudem der Zeilenabstand größer sein als bei kurzen Zeilen, damit der Text gut lesbar bleibt.

Die Kopf- und Fußzeile in der Betriebsanleitung können Sie nutzen, um dem Leser die Orientierung im Text zu erleichtern. In der Kopfzeile können zum Beispiel die Kapitelüberschriften stehen. Die Seitenzahlen stehen üblicherweise in der Fußzeile.

Bedrucken bzw. Nutzen sollte man in einer Bedienungsanleitung von jeder Seite nur ein bestimmter Teil. Die Fläche, die man auf einer Seite benutzt, bezeichnet man in der Typografie als Satzspiegel. Wie der Satzspiegel am Ende tatsächlich aussieht, hängt davon ab, ob es sich bei der Bedienungsanleitung um ein- oder doppelseitiges Format handelt. Bei einer einseitigen Anleitung haben die Größen der Stege, also die vier Seitenränder, ein anderes Verhältnis  zueinander, als bei einem doppelseitigen Format. Unabhängig davon werden nur ca. 2/3 der Seite tatsächlich bedruckt. Ungefähr 1/3 sollte frei bleiben.

Das wichtigste Kriterium beim Erstellen von Betriebsanleitungen, Gebrauchsanleitungen oder Montageanleitungen ist die Beschreibung der Funktionalität des Produktes. Einem Nutzer soll durch das Lesen der Betriebsanleitung, Gebrauchsanleitung oder Montageanleitung die wichtigen Fragen nach dem WO, WER, WAS, WANN, WIE und WARUM vorweggenommen werden.

Beim Erstellen von Betriebsanleitungen, Gebrauchsanleitung oder Montageanleitungen gilt es zudem einige Richtlinien und Normen zu beachten. Zu den wichtigsten Richtlinien der EU, denen man Beachtung schenken muss, gehören die Maschinenrichtlinie, die EMV-Richtlinie und die Niederspannungsrichtlinie. Daneben gibt es je nach Art des Produktes weitere Richtlinien und Normen. Außerdem muss man die Regelungen der Zielmärkte (EU, USA, Russland, etc.) beachten.

Für die Erstellung von Bedienungs- und Gebrauchsanleitungen benötigen wir mindestens eine Risikobeurteilung. Zudem benötigen wir wenn möglich, mehrere Termine vor Ort am Produkt oder Gesprächstermine mit einem Konstrukteur. Ältere, ähnliche Anleitungen oder grobe Funktionsbeschreibungen des Produktes vereinfachen die Erstellung und berücksichtigen wir ebenfalls. Je nach vorhandenen Unterlagen stimmen wir unsere Abläufe mit den Abläufen von Ihnen ab.

Die Umrechnung der Maß- und Temperatureinheiten in Bedienungsanleitung, Gebrauchsanleitung oder Montageanleitung sind für den amerikanischen Markt ein wichtiges Sicherheitskriterium. Viele Amerikaner können mit dem metrischen System nichts anfangen und durch bspw. falsch verstandene Abstände können gefährliche Situationen entstehen. Im Zuge der Anpassung der Bedienungsanleitung, Gebrauchsanleitung oder Montageanleitung und deren Übersetzung können wir die Umrechnung der Einheiten übernehmen.

Für das Erstellen einer Betriebsanleitung fallen neben den gesetzlichen Grundlagen auch eine Vielzahl an Normen und Richtlinien an. Entsprechend schreiben diese vor, was eine Betriebsanleitung alles enthalten soll. Um nicht den Überblick über alle Besonderheiten der Technischen Dokumentation zu verlieren, sollte man Hilfsmittel verwenden. Empfehlenswert ist dabei der Einsatz von Checklisten, Leitfäden und Redaktionssystemen.

Bei der Erstellung einer Betriebsanleitung kann eine Checkliste an mehreren Stellen hilfreich sein. Beispielsweise bei der Erstellung eines guten Sicherheitskapitels. Dieses entsteht durch eine genaue Gefahrenanalyse. Mit der Analyse von möglichen Gefahrenquellen kann man Risiken einschätzen und passende Gegenmaßnahmen treffen. Um mögliche Gefahren sinnvoll analysieren zu können, sollten alle relevanten Gesetzte und Normen bekannt sein. Alle relevanten Anforderungen können in einer Checkliste zusammengetragen werden, die man dann zum Recherchieren und Kontrollieren der Gefahrenanalyse verwendet.

Abbildungen in der Betriebsanleitung sollten einheitlich gestaltet und angeordnet sein, um den Leser der Technischen Dokumentation nicht zu verunsichern. Ein allgemein gehaltenes Layout der Abbildungen sorgt für einen besseren Lesefluss. Außerdem steigert es die Verständlichkeit einer Betriebsanleitung.

Eine gute Darstellung der Betriebsanleitung beinhalten verständliche Abbildungen sowie ein logisch aufgebauter Fließtext. Damit wird das Produkt und alle für den Umgang benötigten Sicherheitshinweise deutlich beschrieben und dies zeichnet eine gute Gebrauchsanleitung aus. Übrigens erhalten Sie hier weitere Informationen in unserem Fachbuch-Verlag:
www.gft-verlag.de/de/3-buecher

Grafische Darstellungen einschließlich Sicherheitszeichen müssen für Zielgruppen leicht erkennbar und verständlich sein. Falls diese nicht einfach verständlich oder eindeutig sind, müssen die grafischen Darstellungen in der Betriebsanleitung erläutert sein.

Die Struktur der Betriebsanleitung sollte in der Reihenfolge stehen, wie auch der Lebenszyklus eines Produktes entsprechend aussehen würde. Folglich sollten die Einzelschritte in der Reihenfolge vorkommen, wie der Anwender mit einem Produkt Aufgaben erledigen würde. Eine mögliche Struktur würde beispielsweise so aussehen:

• Transport, Montage und Installation eines Produktes
• Inbetriebnahme
• Betrieb
• Instandhaltung und Reinigung
• Außerbetriebnahme, Demontage, Entsorgung

Bei der Wahl des passenden Formats für die Betriebsanleitung kommt es vorrangig auf die Auslieferung des Produktes an. Für ein Mobiltelefon wird die Bedienungsanleitung vermutlich nicht im A4-Format erstellt sein, wenn Sie in die Verpackung passen soll. Hier ist eine Anleitung im Format A5 oder A6 sicher die bessere Wahl. Die Anleitung für eine Werkzeugmaschine hingegen, die man in der Werkstatt liest, ist im A4-Format für den Nutzer am hilfreichsten.

Abkürzungen oder Akronyme sollten vermieden werden. Sind diese oder andere Fachbegriffe unvermeidbar, müssen diese für die beabsichtige Zielgruppe dementsprechend verständlich aufgelistet und erklärt sein. Beim ersten Auftreten der Begriffe in der Betriebsanleitung sind diese zu erklären und/oder in einem Glossar zu verzeichnen.

Überschriften müssen leicht verständlich sein und sollten daher kurz und nummeriert sein. Sie dienen als Leitfaden, der den Nutzer der Betriebsanleitung durch das Dokument führt und ihm dabei hilft die erforderlichen Informationen zu finden. Empfehlenswert ist ebenfalls die Anwendung einer einheitlichen Strukturierungsmethode. Die Formulierungen und Struktur der Texte sollten die verschiedenen Textfunktionen unterstützen wie z.B.:

• Thema (Überschrift)
• Warnung
• Beispiel
• Beschreibung
• Voraussetzung
• Handlung
• Ergebnis
• Beschriftung einer Abbildung oder Tabelle

Bei der Formulierung einer Betriebsanleitung ist darauf zu achten, dass alle Informationen so einfach und kurz wie möglich gehalten sind. Sätze sollten eine einfache Satzstruktur vorweisen, kurz gehalten und grammatikalisch richtig sein. Querverweise sollten so wenig wie möglich vorkommen, damit das Dokument übersichtlich bleibt.

Es gibt drei grundsätzliche Layout-Typen, die für Betriebsanleitungen geeignet sind:

1. Ein zweispaltiges Layout mit Marginalienspalte. Die äußere bzw. linke Spalte enthält hierbei ausschließlich Stichwörter sowie die Überschriften. Der Text und die Bilder sind in der inneren bzw. rechten Spalte anzuordnen. Durch die Stichwörter ist der Text gut strukturiert und leicht selektiv lesbar.
2. Getrennte Spalten für Bilder und Text. Dieser Typ eignet sich, wenn viele Bilder verwendet werden (z. B. für Handlungsanleitungen, in denen die einzelnen Schritte genau beschrieben werden). Dabei werden die Bilder z. B. in der rechten Spalte untereinander angeordnet. In der linken Spalte steht neben jedem Bild ein möglichst kurzer erläuternder Text. Der Text wird dem Bild also auch optisch zugeordnet.
3. Das einspaltige Layout. Hierbei sind die Bilder in einer eigenen Zeile zentriert zwischen den Absätzen bzw. Textblöcken angeordnet. Diese Variante ist mit jedem Textverarbeitungsprogramm einfach zu erzeugen. Allerdings werden die Zeilen bei diesem Layout-Typ relativ lang und damit schlechter lesbar. Auch die Zuordnung zwischen Text und Bild ist nicht immer sofort erkennbar.

Die Auswahl an Schriftarten scheint fast unbegrenzt zu sein. Aber nicht jede Schrift ist für eine Betriebsanleitung geeignet. Gedruckte umfangreiche Texte sollten mit Serifenschriften (Schriften mit „Füßchen“) gedruckt sein, der Leser ermüdet bei dieser Schriftart nicht so schnell beim Lesen. Als gängige Serifenschrift ist hier die Schriftart „Times“ zu empfehlen. Liest man den Text hingegen mehr auf Bildschirmen, so sind serifenlose Schriften geeigneter. Eine serifenlose Schrift ist z.B. die „Arial“ Schriftart.

• Kursiv- oder Fettschrift sollte für Hervorhebungen nur sparsam eingesetzt werden. Doppelte Auszeichnungen (Kursiv und Fett) sollten in jedem Fall vermieden werden.
• Die Schriftgröße für den Fließtext in Betriebsanleitungen im A4-Format sollten 10 bis 12 Punkte betragen. Für Anleitungen im A5-Format werden daher 8,5 bis 10 Punkte als Schriftgröße empfohlen.
• Die Größe der Überschriften steigt mit jeder Hierarchieebene ab. Bei einer Schriftgröße von 10 Punkten sollte das Verhältnis der verschiedenen Überschriften 20:14:11 betragen. Auf die Verwendung von mehr als drei Hierarchieebenen sollte man ebenfalls nach Möglichkeit verzichten.
• Verzichten Sie auf optische Spielereien im Fließtext. In der Regel erschweren Sie dem Leser dadurch den Überblick.

Beim Schreiben von Betriebsanleitungen kommen in der Regel der linksbündige Flattersatz und der Blocksatz zur Anwendung. Beim Flattersatz sollten die Zeilen stets wechselnde und deutlich unterschiedliche Längen besitzen. Für die richtige Ausführung ist daher häufig eine manuelle Nachbearbeitung erforderlich. Blocksatz hingegen birgt die Gefahr, dass große Löcher im Text entstehen, an denen sich das Auge stört. Auch hier ist also ggf. eine manuelle Nachbearbeitung erforderlich, da der Wortzwischenraum ungefähr der Breite des Buchstaben „i“ entsprechen sollte.

Die Kopf- und Fußzeile können Sie nutzen, um dem Leser die Orientierung im Text zu erleichtern. In der Kopfzeile können z. B. die Kapitelüberschriften stehen. Die Seitenzahlen stehen üblicherweise in der Fußzeile.

Ja, wenn das Produkt personenbezogene Daten verarbeitet (z. B. Smart Devices, Überwachungskameras und Software oder Cloud-Dienste), gehört ein Hinweis zur DSGVO-konformen Nutzung in die Dokumentation.

Nur wenn dies notwendig und rechtlich zulässig ist. Protokolle, Fehlermeldungen und Nutzeranalysen dürfen nicht dauerhaft mit Personenbezug gespeichert werden – nur anonymisiert oder pseudonymisiert.

• Keine personenbezogenen Daten ohne Rechtsgrundlage dokumentieren
• Anonymisierung, wenn möglich
• Datenschutz durch Technikgestaltung („Privacy by Design“) berücksichtigen
• Nur notwendige Daten erfassen („Datenminimierung“)

Personenbezogene Daten sind alle Informationen, die sich auf eine identifizierbare Person beziehen: Name, E-Mail-Adresse, IP-Adresse, Benutzerverhalten, Systemnutzungsdaten, Video- und Bildaufnahmen usw.