Kapitelvorschläge für Technische Dokumentation

Teile diesen Beitrag

Die Technische Dokumentation (auch: “Produktdokumentation”) umfasst alle Informationen und Hilfen, die eine Anlage, Maschine, ein Gerät, eine Software oder andere technische Erzeugnisse beschreiben und zu deren Nutzung, Wartung oder Reparatur anleiten. Dazu gehören in der Regel auch Compliance-Dokumente wie die für das CE-Zeichen wichtige Maschinenrichtlinie 2006/42/EG.

Kapitelvorschläge für Technische Dokumentation

Texten für die Technik: Leitfaden für Praxis und Studium*

ANZEIGE

Jeder Hersteller ist gesetzlich dazu verpflichtet, seinen Produkten eine Betriebsanleitung beizulegen. Viele Normen, Gesetze und Richtlinien bezeichnen diese auch als Bedienungsanleitung, Gebrauchsanleitung, Gebrauchsanweisung oder Benutzerinformation.

Diese Kapitelvorschläge für Technische Dokumentation soll Ihnen beim Verfassen solch einer Betriebsanleitung behilflich sein.

Dabei ist er als Empfehlung zu verstehen und beinhaltet nicht alle rechtlichen Verordnungen. Spezielle produkt- und länderbezogene Vorgaben muss jeder Hersteller vorrangig behandeln.
Dazu müssen seine Kenntnisse stets auf dem aktuellen Stand sein.

INFO

Schwerpunktmäßig beziehen sich diese Kapitelvorschläge für Technische Dokumentation auf die EG-Richtlinie 2006/42/EG Maschinenrichtlinie sowie auf die Normen EN 82079-1 und EN ISO 12100.

Die nachfolgende Struktur gibt einen Vorschlag für die meisten technischen Dokumentationen.

Texten für die Technik: Leitfaden für Praxis und Studium*

ANZEIGE

Titelseite

  • Produktbezeichnung / Bild Logo des Herstellers

Identifikation

  • Produktidentifikation( Modell, Serie, Herstelldatum)
  • Herstellerangaben, Kundendienstangaben
  • Dokumenten Nr.. Mit Gültigkeitsangaben
  • Inhalts und Vollständigkeitskontrolle

Wichtige Hinweise zur Betriebsanleitung

  • Zweck des Dokumentes
  • Zielgruppe
  • Aufbau der Dokumentation, Verweis auf ergänzende Dokumente
  • Einführung Überblick
  • Darstellungskonventionen erklären
  • Aufbewahrung der Betriebsanleitung
  • Urheberrechts-Vermerk

Verzeichnisse

  • Inhaltsverzeichnis
  • Abbildungsverzeichnis
  • Stichwortverzeichnis (Index)
  • Fachwortverzeichnis (Glossar)

Kapitel 1: Gerätebeschreibung

Wichtige Hinweise zum Produkt

  • Gesamtansicht
  • Verwendungszweck
  • Vorsichtsmaßnahmen
  • Arbeitsplätze
  • Gefahrenbereich
  • Konformität (Sicherheit, Gesetze, Normen…)
  • Kennzeichnung des Produktes

Produktdaten

  • Leistungsmerkmale
  • Maße und Gewicht
  • Versorgung
  • Schnittstellen
  • Anschlüsse
  • Umgebungsanforderungen (Temperatur, Feuchte,…)
  • Emissionen

Ausstattung

  • Ausführungsvarianten (Basis… jeweils mit Einsatzunterscheidung)
  • Zubehör
  • Auslieferungszustand (vormontiert, gesichert)
  • Sonderzubehör

Beladeplan (Verstauplan)

  • Wo ist was verstaut?

Kapitel 2 Sicherheitshinweise

Darstellungen(Warnhinweise, Piktogramm)

  • Produktsicherheit

Verwendungszweck (wofür, wofür nicht)

Gefahrenbereiche

  • Arbeitsplätze
  • Gefahrenbereiche
  • Sicherheits- und Überwachungseinrichtungen
  • Warnsignale

Organisatorisches, Personelles (Umgang mit Meldungen, Fehler, Qualifikation…)

Produktspezifische Gefahren

Zusätzliche Gefahren

Angaben für den Notfall

Kapitel 3 Aufbau und Funktion

  • Einleitung
  • Grundlagen des Verfahrens

Aufbau

  • Mechanischer Aufbau
  • Aufgliederungsplan

Funktionsbeschreibung

  • Gliederung nach Funktionen

Sicherheits- und Überwachungseinrichtungen

Baugruppenbeschreibung( der Sicherheits und Überwachungseinrichtungen)

  • Mechanischer Aufbau
  • Funktionsbeschreibung

Kapitel 4 Bedienungs- und Anzeigeelemente, Betriebsarten

Einleitung

Warnsignale

Bedienungs- und Anzeigeelemente

Störungsanzeigen

Betriebsarten

Kapitel 5 Inbetriebnahme

Einleitung

  • Sicherheitshinweise
  • Technische Unterlagen( benötigte Zeichnungen..)

Aufstellung

  • Voraussetzungen
  • Transport
  • Einsatzort
  • Handhabung, Auspacken und Reinigung
  • Transportsicherungen
  • Aufstellung
  • Befestigung

Montage

  • Ein und Anbau
  • Energieversorgung, Betriebsstoffe
  • Entsorgungsmaßnahmen, Schutzvorrichtungen

Erste Inbetriebnahme

  • Maßnahmen von der ersten Inbetriebnahme
  • Erste Inbetriebnahme
  • Testprozeduren

Abnahme

  • Abnahmekriterien
  • Durchführung

Kapitel 6 Bedienung

  • Einleitung
  • Sicherheitshinweise
  • Einarbeitungshinweise

Betrieb des Produktes

  • Einrichten
  • Dateneingabe
  • Programmierung
  • Prüfen vor dem Einschalten
  • Einschalten
  • Überwachung Kontrolle
  • Ausschalten
  • Wartung durch das Personal
  • Umstellen, Umrüsten

Störung

Kapitel 7 Wartung

Einleitung

  • Sicherheitshinweise
  • Aufbau des Wartungsplanes
  • Folgen bei Nichtbeachtung

Wartungsplan

Betriebsstoffe und Hilfsmittel

  • Schmiermitteltabelle
  • Reinigungsmittel
  • Mess und Prüfmittel
  • Sonderwerkzeuge

Wartungsarbeiten

  • Sicherheitstechnische Prüfung
  • Schmier-, Pflege- und Reinigungsarbeiten
  • Inspektions-, Kontroll- und Justierarbeiten
  • Kontrolle und Auswechseln von Unterbaugruppen und Einzelteilen
  • Funktionskontrolle

Wartungsnachweis

Kundendienst-Informationen

Kapitel 8 Instandsetzung

Einleitung

  • Sicherheitshinweise
  • Instandhaltungskonzept (wer darf was machen)

Allgemeine Angaben

  • Sonderwerkzeug Mess- und Prüfgeräte
  • Werk-, Verbrauchsmaterial und Reparatursätze

Störungssuche und Störungsbeseitigung

  • Gliederung gemäß den Funktionsabläufen

Reparatur

  • Gliederung anlagen und baugruppenbezogen, in der Reihenfolge des Aufgliederungsplanes

Schaltpläne, Zeichnungen

  • Gliederung getrennt nach Fachbereich, weitere Gliederung gemäß dem Aufgliederungsplan

Informationen über Instandsetzungsdienste

Kapitel 9 Außerbetriebnahme, Lagerung und Wiederinbetriebnahme

Einleitung

  • Sicherheitshinweise
  • Lagerbedingungen
  • Art der Lagerung
  • Lagerdauer
  • Raumbedarf
  • Physikalische Bedingungen
  • Vorschriften/Normen
  • Gefahrenhinweise

Außerbetriebnahme

  • Stilllegung
  • Reinigung
  • Konservierung
  • Anbringen der Transportsicherung
  • Verpacken
  • Kennzeichnen

Wartung während der Lagerung

  • Wartungplan
  • Wartungsarbeiten

Wiederinbetriebnahme

  • Entfernen der Verpackung/Transportsicherung
  • Entfernung der Konservierung
  • Inbetriebnahme nach Lagerung

Kapitel 10 Verpacken, Transport

Einleitung

  • Sicherheitshinweise
  • Verpackung
  • Vorbereitende Maßnahmen
  • Wahl der Verpackung
  • Beschriften der Verpackung
  • Vorgehen beim Einpacken

Transport

  • Daten des Transportgutes
  • Transportart
  • Verladen, Umladen, Entladen

Kapitel 11 Entsorgung

  • Einleitung
  • Sicherheitshinweise

Entsorgung

  • Verpackung
  • Betriebsmittel
  • Grundeinheit

Entsorgungskonforme Baugruppen

  • Materialgruppen
  • Gefahrenhinweise
  • Demontage
  • Zwischenlagerung von noch zu verwendenden Baugruppen

Entsorgungsstellen, Ämter

  • Rücklieferung an Hersteller
  • Meldung an Ämter und Hersteller

Kapitel 12 Ersatzteilliste

  • Einleitung
  • Kennung der Ersatzteilliste
  • Produktkennung
  • Erklärung von unterschiedlichen Varianten
  • Definition von Begriffen
  • Definition von Abkürzungen
  • Gebrauchsanleitung zur Ersatzteilliste

Produktaufgliederungsplan

Bildtafeln

  • Übersichtsbildtafeln
  • Bildtafeln

Teilenummerverzeichnis

  • Geordnet nach Teilenummer mit Querverweis auf Bildtafel

Alphabetisches Teileverzeichnis

Referenzliste

Texten für die Technik: Leitfaden für Praxis und Studium*

ANZEIGE
Teile diesen Beitrag

Mustafa Acar

Mustafa Acar ist Business Architect aus Stuttgart und befasst sich gerne mit Themen rund um Mixed Reality, Technische Dokumention, Content Development und der dazugehörigen technischen Umsetzung. Als studierter Kommunikation und Medienmanager hat er zudem eine große Sympathie für benutzerspezifische produktorientierte Informationsaufbereitung.

Das könnte dich auch interessieren …