top of page

Technische Dokumentation am Beispiel erklärt

In der Welt der Technik und Innovation spielt die Technische Dokumentation eine entscheidende Rolle. Sie fungiert als unverzichtbare Brücke zwischen komplexen technischen Prozessen und dem Anwender. Ein gutes Beispiel für eine effektive Technische Dokumentation findet sich in gesetzeskonformen Anleitungen für Maschinen und Produkte.

Technische Dokumentation Beispiel - Ingenieurbüro für Technische Dokumentation - Karla Fle

01

Arten Technischer Dokumentation

Es gibt unterschiedliche Anleitungsarten:

  • Bedienungsanleitungen bzw. Betriebsanleitungen

  • Montageanleitungen bzw. Einbauanleitungen

  • Wartungsanleitungen

  • Instandsetzungsanleitungen

  • Ersatzteilkataloge

  • Softwareanleitungen

  • Produktdatenblätter /Sicherheitsdatenblätter

​alle haben Sie ihre Berechtigung, da die Inhalte und der Aufbau der einzelnen Anleitungen unterschiedlich ist. Eine Bedienungsanleitung oder auch Betriebsanleitung genannt, hat einen kompletten anderen Inhalt als z. B. eine Instandsetzungsanleitung.

Das macht Sinn und ist in der Maschinenrichtlinie und der neuen VERORDNUNG (EU) 2023/1230 festgelegt. Hier werden Vorgaben für die Maschine und die unvollständige Maschine (Maschinenteil oder Baugruppe) gemacht. Die neue VERORDNUNG (EU) 2023/123 schließt nun auch Produkte und digitale Produkte mit ein. Die Norm DIN EN IEC IEEE 82079-1 spezifiziert die Inhalte genauer und benutzt neuerdings den allgemeinen Begriff Gebrauchsanleitungen.

Da das Erstellen von Anleitungen also Technischen Dokumentationen sehr komplex ist und gesetzlichen Anforderungen genügen muss, bedarf es einer Ausbildung und zwar die des Technischen Redakteurs der durch die tekom (Gesellschaft für Technische Kommunikation) geprüft wird. Die Berufsbezeichnung Technischer Redakteur wird mit einer schriftlichen Arbeit mit Reflexion und einer mündlichen Prüfung verteidigt.

02

Vorlagen für eine Technische Dokumentationen in Form einer Betriebs- bzw. Bedienungsanleitung

Was für eine Art von Anleitung vorliegt, hat vorne auf dem Deckblatt kenntlich gemacht zu werden.

Z. B. "Original-Betriebsanleitung Notstromgenerator"

Auch die Sprache in welcher eine Technische Dokumentation verfasst wird ist vorgeschrieben, wenn es sich um eine vollständige Maschine handelt. Bei unvollständigen Maschinen ist das Verhandlungssache zwischen dem Lieferanten und dem Kunden.

Wie gesagt ist der Inhalt einer Betriebsanleitung unterschiedlich zu dem einer Wartungs- oder Instandsetzungsanleitung. Auch kann der Wartungsanteil je nach Umfang mit in eine Betriebsanleitung integriert werden. Für drei Seiten Wartungshinweise lohnt kein extra Handbuch.

Eine Instandhaltungsanleitung sollte jedoch immer als separates Handbuch erstellt werden, da diese meist anderes Personal mit anderen Qualifikationen, zu denen des Bedieners anspricht. Ein Bediener darf nicht in die Lage versetzt werden, Arbeiten auszuführen zu denen er nicht berechtigt ist.

MS Word ist ein durchaus brauchbarer Editor, um Technische Dokumentationen zu erstellen. Gerade wenn viele unterschiedliche Anleitungen erstellt werden, lohnt sich ein Redaktionssystem nicht.

Eine Vorlage für eine Technische Dokumentation finden Sie hier. Sprechen Sie uns an!

Technische Dokumentation Vorlage - Ingenieurbüro für Technische Dokumentation Dienstleiste
Technische Dokumentation Inhalt

03

Inhalte einer Betriebsanleitung

  1. Deckblatt

  2. Impressum

  3. Inhaltsverzeichnis

  4. Allgemeines - Informationen zur Anleitung, Zielgruppe, Symbolerklärungen, Informationen zur Haftungsbeschränkung und Urheberschutz, mitgeltende Unterlagen nennen, also andere Anleitungen, auch von anderen Herstellern, Technische Zeichnungen, Schaltpläne etc.

  5. Sicherheit - Bestimmungsgemäßer Gebrauch, allgemeine Gefahrenquellen, Verantwortung des Betreibers, Qualifikation des Personals, Aussagen zur Schutzausrüstung, Bedeutung der Sicherheitshinweise, Verhalten im Gefahrenfall, Vorgehensweise gegen ungewolltes Wiedereinschalten.

  6. Technische Daten - Gewicht, Abmessungen, Drehzahl, Typen, Spannung, usw., möglichst in Tabellenform, Hinweis auf das Typenschild

  7. Aufbau und Funktion - Allgemeine Beschreibung und Funktionsweise des Produktes.

  8. Transport - Vorgehensweise

  9. Inbetriebnahme (Beschreibung der Erstinbetriebnahme)

  10. Bedienung - Schritt für Schrittbeschreibung aller Bedienprozesse, aktive Formulierung verwenden: z. B.  "Drücken Sie den Einschaltknopf.", Anbringung der Warnhinweise für Restrisiken nach dem SAFE-Prinzip. 

  11. Wartung - Art der Wartung mit Intervallen in Tabellenform, je nach Produkt kann dieses Kapitel auch ein separates Wartungshandbuch werden.

  12. Demontage und Entsorgung - Umweltschutz- und Entsorgungshinweise nach Demontage

  13. Anhang - Schaltpläne, Prüfbücher, Nennung von Anleitungen von Lieferanten, Konformitätserklärung des Herstellers

  14. Index/Glossar - optional

​

Wichtig ist zu beachten, dass keine Beschreibungen doppelt vorkommen, lieber ein extra Kapitel erstellen auf das dann, wenn die Informationen an anderer Stelle benötigt werden, verwiesen werden kann.

Eine Vorlage in MS Word können Sie hier erwerben. Sprechen Sie uns an!

Technische Dokumentation vom Experten

Habe Sie Fragen? Benötigen Sie eine Technische Dokumentation vom Experten, der Ihnen gesetzeskonforme Anleitungen nach dem Neuesten Stand der Technik verfasst? Machen Sie keine Kompromisse mehr. Eine Anleitung, die nicht den gesetzlichen Anforderungen entspricht, gefährdet die Konformitätserklärung.

Darum nehmen Sie Kontakt mit uns auf!

Dienstleister Technische Dokumentation - Ingenieurbüro für Technische Dokumentation - Karl
bottom of page