Inhalt von technischer Dokumentation

Bei der Frage, welche Inhalte oder Themen technische Dokumentation enthalten soll, sind je nach Branche und Produkttyp eine Reihe von Vorschriften und Normen zu berücksichtigen. Es gehört zu den Aufgaben eines Technischen Redakteurs, die relevanten Vorgaben zu recherchieren.

Nachfolgend ist technische Dokumentation im engeren Sinne der externen technischen Dokumentation gemeint. Dazu gehören Gebrauchsanleitungen, Bedienungsanleitungen usw. Siehe auch die Seite "Was ist technische Dokumentation", Abschnitt "Definition technische Dokumentation".

Allgemeine Vorgaben durch Normen und Gesetze

Technische Dokumentation Gesetze

Bei der Frage, welche Inhalte oder Themen technische Dokumentation enthalten soll, sind je nach Branche und Produkttyp eine Reihe von Vorschriften und Normen zu berücksichtigen. Es gehört zu den Aufgaben eines Technischen Redakteurs, die relevanten Vorgaben zu recherchieren.

Allgemeine Vorgaben zum Inhalt macht beispielsweise das Produktsicherheitsgesetz, § 6, Absatz 1:

„Der Hersteller [hat] bei der Bereitstellung eines Verbraucherprodukts auf dem Markt ...

1. sicherzustellen, dass der Verwender die Informationen erhält, die er benötigt, um die Risiken, die mit dem Verbraucherprodukt […] verbunden sind […] beurteilen und sich gegen sie schützen zu können […]“

(Gesetze-im-internet.de 2015)

Daraus lässt sich ableiten, dass Sicherheitshinweise und Warnhinweise sehr wichtig sind. Aber auch korrekte Handlungsanleitungen und – je nach Zielgruppe – Hintergrundwissen, zum Beispiel die Beschreibung von Funktionsprinzipien.

Einige EU-Richtlinien bzw. die entsprechenden nationalen Gesetze enthalten ebenfalls Vorschriften für den Inhalt von technischer Dokumentation. Die Maschinenrichtlinie (in Form der 9. ProdSV, siehe Seite "Gesetzliche Grundlagen der technischen Dokumentation", ab Abschnitt "Produktsicherheitsgesetz") ist diesbezüglich eine der umfangreichsten Richtlinien. Sie enthält in Anhang 1 viele, zum Teil sehr detaillierte Vorschriften zum Inhalt von technischer Dokumentation. Ein Auszug:

„Jede Betriebsanleitung muss erforderlichenfalls folgende Mindestangaben enthalten:

- Firmenname und vollständige Anschrift des Herstellers und seines Bevollmächtigten; […]
- die für Verwendung, Wartung und Instandsetzung der Maschine und zur Überprüfung ihres ordnungsgemäßen Funktionierens erforderlichen Zeichnungen, Schaltpläne, Beschreibungen und Erläuterungen; […]
- eine Beschreibung der bestimmungsgemäßen Verwendung der Maschine; […]“

(Europäische Union 2006)

Auch in einigen Normen finden sich Vorgaben, welche Informationen in technischer Dokumentation enthalten sein sollten. Allen voran ist hier die DIN EN 82079-1 zu nennen, die sich in Kapitel 5 „Inhalt von Gebrauchsanleitungen“ relativ ausführlich, aber natürlich allgemein gehalten, mit dem Inhalt von technischer Dokumentation befasst. In Kapitel 5.1 fordert die Norm beispielsweise:

„Die Funktionalität der Produkte muss beschrieben werden und Fragen der Nutzer zum WO? WER? WAS? WANN? WIE? WARUM? sollten vorweggenommen und passende Antworten gegeben werden.“

„Die Informationstiefe hängt von der (den) Zielgruppe(n) ab und den beabsichtigten oder erlaubten Aufgaben, die im Laufe des Produktlebens ausgeführt werden.“

(Beuth 2013, 20)

Und in Kapitel 5.8.2 „Installation“:

„Bei Produkten, die eine Installation erfordern, muss die Gebrauchsanleitung, soweit zutreffend, enthalten:

- Vorgehensweise zur Entfernung von Transport- undVerpackungssicherungen […]
- Checkliste der Dinge, die in der Packung enthalten sind […]
- Anschlussplan und/oder -tabelle
- Bedingungen für Zusammenbau und Montage […]“

(Beuth 2013, 20)

Fallbeispiel Kreissäge

Nachfolgend wird am Beispiel einer Kreissäge demonstriert, wie Schritt für Schritt eine Inhaltsstruktur, unter anderem auf Basis von Vorschriften aufgebaut werden kann. Begonnen wird mit den sehr allgemeinen Vorschriften, den Abschluss bilden sehr spezielle, produktspezifische Vorschriften und Themen.

Ausgangssituation

  • Produkt: Kreissäge (stationär, elektrisch betrieben)
  • Info vom Hersteller: Die Kreissäge wird fertig montiert zum Kunden geliefert.

Gebrauchsanleitung Maschine

(Abbildung 6: Kreissägemaschine Hammer B3 basic (Miller 2015))

Standardinhalte im Allgemeinen

Die DIN EN 82079-1 schreibt für Gebrauchsanleitungen folgende Standardinhalte vor, soweit sie für die Zielgruppe relevant sind:

  • Technische Daten
  • llgemeine Sicherheitshinweise
  • Transport und Lagerung
  • Inbetriebnahme
  • Betrieb
  • Instandhaltung
  • Entsorgung

(Beuth 2013, 20 ff.)

Standardinhalte für Maschinen

Zunächst ist zu prüfen, ob die Maschinenrichtlinie für Kreissägen gilt. Hierzu lesen wir die Artikel 1 „Anwendungsbereich“ und 2 „Begriffsbestimmung“ der Maschinenrichtlinie. Aus diesen Artikeln geht hervor, dass die Maschinenrichtlinie hier Anwendung findet.

Anschließend lesen wir Anhang 1 der Maschinenrichtlinie, Kapitel 1.7.4.2 „Inhalt der Betriebsanleitung“. Für unsere Kreissäge sind unter anderem die folgenden Inhalte relevant:

  • d) allgemeine Beschreibung der Maschine
  • g) Beschreibung der bestimmungsgemäßen Verwendung der Maschine
  • i) Anleitungen zur Montage, zum Aufbau und zum Anschluss der Maschine
  • l) Angaben zu Restrisiken […]
  • m) Anleitung für die vom Benutzer zu treffenden Schutzmaßnahmen […]

Standardinhalte für Holzbearbeitungsmaschinen

Mit Hilfe des tekom-Normenkommentars (www.tekom.de/dienste/normenkommentar.html) recherchieren wir nach speziellen Vorschriften für die echnische Dokumentation von Kreissägen. Die Suche ist zwar zunächst erfolglos, doch eine Verallgemeinerung auf „Holzbearbeitungsmaschinen“ führt zu einem Treffer, nämlich zur Norm EN 859 „Sicherheit von Holzbearbeitungsmaschinen“.

Die Norm EN 859 schreibt zusätzlich zu den bisherigen Standardinhalten folgende Inhalte vor:

  • „a) eine Wiederholung der […] Kennzeichnungen, Piktogramme und der anderen Hinweise an der Maschine, und sofern erforderlich, Information zu ihrer Bedeutung“
  • „c) einen Warnhinweis über Restrisiken: Staub, Lärm, […]Rückschlag“
  • „f) wenn notwendig bei stationären Maschinen die Forderung, wiedie Maschine am Fußboden befestigt werden muss“

(tekom 2015b)

Bisherige Standardinhalte

Aus den bisher berücksichtigten Normen und Richtlinien ergibt sich bereits folgende Inhaltsstruktur für die Gebrauchsanleitung der Kreissäge:

1 Sicherheit
  1.1 Erklärung der Gefahrenzeichen
  1.2 Allgemeine Sicherheitshinweise
  1.3 Bestimmungsgemäße Verwendung
  1.4 Schutzmaßnahmen
  1.5 Restrisiken
2 Transport und Lagerung
3 Aufbau
4 Aufstellung und Inbetriebnahme
  4.1 Kreissäge aufstellen
  4.2 Kreissäge an elektrischen Strom anschließen
5 Betrieb
6 Instandhaltung
7 Entsorgung
8 Technische Daten

Weitere Vorschriften bestehen für die Kapitelinhalten, insbesondere gemäß der Norm EN 859. Beispielsweise müssen Warnhinweise zu Staub und Rückschlag enthalten sein.

Produktspezifische Inhalte

Über die bisherigen Vorschriften hinaus sind auch produktspezifische Inhalte notwendig, vor allem hinsichtlich der Bedienung und des Betriebs der Kreissäge:

5 Betrieb
  5.1 Schiebetisch einstellen
  5.2 Leisten schneiden
  5.3 Nuten fräsen
  ...

Konstruktion vor Instruktion

Technische Dokumentation kann nicht und darf nicht dazu dienen, sicherheitstechnische Mängel eines Produktes auszugleichen!

Produkte müssen so weit wie möglich von vornherein sicher konstruiert und gegebenenfalls mit Schutzmaßnahmen versehen werden. Hierfür sind vom Hersteller entsprechende Risikobeurteilungen durchzuführen. Nur unvermeidliche Restrisiken müssen letztendlich in der technischen Dokumentation beschrieben werden.

Dieser Artikel ist ein Auszug aus dem kostenfreien E-Book "Grundlagen der technischen Dokumentation - Motivationen, Methoden und Zusammenhänge".