BA #028 Herausforderungen beim Aufteilen einer Dokumentation

Betriebsanleitung, Wartungsanleitung, Montageanleitung und dann noch Lieferantendokumentationen. Eine Technische Dokumentation kann mit vielen verschiedenen Dokumentenarten ankommen. Der Benutzer steht dann vor der Herausforderung die Übersichtlichkeit zu behalten, damit er unter den vielen Dokumenten auch seine gewünschten Informationen findet. Nicht immer ist das Aufteilen einer Technische Dokumentation sinnvoll.

Die Betriebsanleitung einer Maschine liefert dem Anwender wichtige Informationen, welche für den Betrieb der Maschine notwendig sind. Ebenfalls können in einer Betriebsanleitung auch Informationen für die anderen Lebensphase der Maschine wie Transport, Montage, Reinigung, Wartung und Entsorgung vorkommen. Alle erforderlichen Informationen, welche in der Betriebsanleitung stehen müssen, sind in der europäischen Maschinenrichtlinie festgelegt.

Diese erforderlichen Informationen müssen dabei nicht aus einem einzigen Dokument bestehen. Es kann durchaus vorkommen, dass der Maschine mehrere Dokumente beiliegen, welche dem Nutzer Informationen zu den einzelnen Lebensphasen geben. Diese unterschiedlichen Dokumente sind zusammengefasst dann die Technische Dokumentation einer Maschine.

Aber wann ist nun eine Aufteilung der Technischen Dokumentation sinnvoll? Dies hängt wie oft mit unserer Zielgruppe ab. Wenn unterschiedliche Zielgruppen spezifische Informationen benötigen, macht es durchaus Sinn die Technische Dokumentation in einzelne Dokumente aufzuteilen.

Nehmen wir an wir haben drei verschiedenen Zielgruppen mit verschiedenen Aufgabenbereichen:

• Eine Gruppe, die für den Einbau einer Maschine verantwortlich ist.
• Eine Gruppe, welche die Maschine bedient.
• Eine Gruppe welche die Maschine wartet und repariert.

Da jede dieser Gruppen andere Tätigkeiten verrichtet und über unterschiedliche Qualifikationen verfügt, haben wir auch für jede dieser Gruppen einen unterschiedlichen Informationsbedarf, was die Nutzungsinformationen betrifft.

Aus Gründen der Benutzerfreundlichkeit ist es natürlich besser, die jeweiligen Zielgruppen nur die Informationen zur Verfügung zu stellen, welche diese Gruppe auch benötigt. Wie die Maschine zu warten bzw. zu reparieren ist, interessiert das Montagepersonal erst mal nicht. Und das Bedienpersonal ist vielleicht sogar nicht mal berechtigt irgendwelche Wartungen durchzuführen. Für die Wartung muss das Personal sehr wahrscheinlich nämlich über besondere Qualifikationen verfügen, welche das Bedienungspersonal vermutlich nicht hat. Erfordert die Montage besondere Fähigkeiten, müssen die Nutzungsinformationen entsprechend darauf hinweisen. Beispielsweise durch Warnungen wie „Montage nur durch einen qualifizierten Elektriker durchführen lassen“ in den Nutzungsinformationen.

Wie sollte nun eine Aufteilung der Technischen Dokumentation aussehen? Und was für Dokumente gibt es üblicherweise? Die Teile der Dokumentation müssen von der Zielgruppe im Hinblick auf ihre erwarteten Aufgaben und Ziele nutzbar und relevant sein. Dies ist auch eine Forderung aus der Norm DIN EN IEC/IEEE 82079-1 in Abschnitt 5.2.3 sich am Zielpublikum zu orientieren.

Sollte also eine Aufteilung der Technischen Dokumentation erfolgen, kann es dafür mehrere Dokumentenarten geben:

• Transportanleitung

Diese Anleitung enthält Beschreibungen für Handhabung, Transport und Lagerung der Maschine und die jeweils dazugehörigen Komponenten. Auch mögliche Sicherheitsvorkehrungen und ggf. Warnhinweise vor Gefahren sind darin enthalten, die während des Transportes entstehen können.

• Montageanleitung

Dieses Dokument enthält Beschreibungen für die Montage des Produktes und dazugehörige Komponenten. Die zu montierenden Komponenten und sonstige benötigte Objekte wie Werkzeuge müssen beschrieben sein. Auch muss die Ausrichtung und Positionierung der zu montierenden Komponenten erläutert sein. Die Handlungsanweisungen sollen als Schritt-für-Schritt-Anleitung aufgeführt sein. Mögliche Sicherheitsvorkehrungen und ggf. Warnhinweise sind aufzuführen, um die Sicherheit der Benutzergruppe der Montageanleitung zu gewährleisten. Mögliche vorhersehbare und vermeidbare Fehler sind in den Nutzungsinformationen zu beschreiben.

• Bedienungsanleitung bzw. Betriebsanleitung

Alle für den Betrieb notwendigen Informationen sind in diesem Teil enthalten. Dazu gehören die bestimmungsgemäße Verwendung des Produktes und mögliche Fehlanwendungen. Ebenfalls kommen in diesem Dokument Beschreibungen von Vorgängen wie das Ein- und Ausschalten des Produktes, die jeweiligen Betriebsarten, der Ablauf oder die Reihenfolge von Vorgängen mit dem Produkt vor. Erläuterungen und Warnhinweise zum Thema Sicherheit, welche für die Bedienung bzw. für den Betrieb des Produktes wichtig sind, sind ebenfalls in diesem Dokument enthalten.

• Wartungsanleitung

Die Wartungsanleitung verfügt über allgemeine Informationen zur Fehlersuche bzw. Störungsbeseitigung. Die notwendige Vorgehensweise für die Instandhaltung sowie das Reinigen und/oder Desinfizieren des Produktes ist ebenfalls in diesem Dokument beschrieben. Wie in den anderen Dokumentenarten müssen auch hier Informationen über Sicherheitsvorkehrungen und mögliche Warnhinweise enthalten sein, falls dies für die Sicherheit der betroffenen Zielgruppe relevant ist.

• Ersatzteilliste

Ein Dokument, welches Informationen über Ersatz- und Verschleißteile enthält. Mithilfe von Abbildungen, Bezeichnungen und Namen von einzelnen Teilen können beschädigte Komponenten identifiziert werden und Ersatz beschafft werden. Das Dokument enthält häufig auch Angaben zu Bezugsquellen für Ersatzteile sowie einer empfohlenen Anzahl von vorrätig zu haltenden Teilen und Kontaktinformationen für technische Hilfestellungen in Bezug zu den Ersatzteilen.

• Dokument mit Allgemeinen Sicherheitshinweisen

Gibt es Restrisiken, welche erläutert werden müssen, oder andere sicherheitsrelevante Informationen, welche mehrere bzw. alle Lebensphasen des Produktes betreffen, kann es auch ein Dokument mit Allgemeinen Sicherheitshinweisen geben. Dieses Dokument gibt allgemeine Sicherheitsvorkehrungen wieder und enthält Sicherheit- und Warnhinweise, welche über alle Lebensphasen des Produktes zu beachten sind.

• Die Anleitung zur Anleitung

Wenn die Dokumentation sehr umfangreich ausfällt, kann ein solches Dokument als Leitfaden für den Leser dienen, um den Aufbau der Technischen Dokumentation zu verstehen. Das Dokument dient dann als Navigationshilfe, um benötigte Informationen einfacher durch alle weiteren Dokumententeile auffinden zu können.

Das Aufteilen von Dokumenten kann bei komplexen Maschinen und Anlagen sinnvoll erscheinen. Bestimmte Personengruppen benötigen nicht alle Informationen und somit auch nicht die komplette Technische Dokumentation. So wird verhindert, dass der Monteur einen riesigen „Berg an Papieren“ mit sich führen muss, was sehr unpraktisch wäre. Jedoch bedeutet das Aufteilen auch immer einige Herausforderungen, auf welche ich nun eingehen möchte.

Das Aufteilen von „zielgruppengerechten“ Informationen ist nicht immer einfach. Klar, ein Montagehandbuch beschäftigt sich nur mit den Inhalten der Montage, das Wartungshandbuch nur mit den Inhalten zur Wartung und Instandhaltung. Häufig benötigen aber gleich mehrere Zielgruppen die gleichen Informationen.

Beispielsweise das Trennen bzw. Wiederherstellen der Energieversorgung für eine Maschine. Im Zuge der Montage bzw. Installation muss die Energieversorgung hergestellt werden. Während Wartungsarbeiten ist diese abzuschalten, muss aber nach den Arbeiten wieder hergestellt werden. Also benötigen beide Zielgruppen die gleichen Informationen. Und in welchem Teil führt man diese dann nun auf? Oder listet man die Inhalte einfach doppelt auf?

Die Herausforderung besteht also darin, den jeweiligen Zielgruppen, genau diese Informationsmenge mitzuteilen, welche Sie benötigt. Und dies ohne zu viel doppelten Inhalt zu produzieren, das würde nämlich dem Minimalismus Prinzip der Norm DIN EN IEC/IEEE 82079-1 wiedersprechen. Eventuell muss dann ebenfalls auf andere Dokumente verwiesen werden. Der Verfasser muss also sicherstellen, dass es den Lesern klar ist, dass es mehrere Dokumente zu verschiedenen Themen gibt. Zum Beispiel durch ein Kapitel „mitgeltende Dokumente“.

Hier bildet sich dann schnell eine weitere Herausforderung. Nämlich die Nachverfolgung der gewünschten Informationen.

Wo finden sich die benötigten Informationen, wenn eine Technische Dokumentation in mehrere Dokumente aufgeteilt wurden?

Was ist, wenn der Mitarbeiter, welche mit Wartungsarbeiten beschäftigt ist, Schaltpläne oder andere Technische Zeichnungen benötigt? Und diese sind nicht direkt in der Wartungsanleitung abgebildet, da auch andere Zielgruppen diese Informationen benötigen.

Hier liegt dann auch wieder eine Herausforderung für den Nutzer. Woher weiß er, wo sich gewünschte Informationen befinden, wenn diese nicht in seinem Hauptdokument zu finden ist.

Ich kann Ihnen hierzu meine Podcast Episode „Aufbau und Aufteilung einer Technischen Dokumentation“ empfehlen, welche die Strukturierung thematisiert, wenn eine Technische Dokumentation aufgeteilt wird.

Eine weitere Herausforderung kann vorliegen, falls die Teile der Technischen Dokumentation übersetzt werden muss. Vorwiegend dann, wenn bestimmte Teile nur in einer Sprachfassung vorliegen und in den anderen Teilen wieder in einer anderen Sprache. Doch halt…jeder Teil muss doch in der Landessprache des Verwendungslandes übersetzt sein? Da gibt es doch keine Ausnahme? Fast, bei der Wartungsanleitung kann dies der Fall sein. Hier gibt es sogar in der Maschinenrichtlinie eine Sonderregelung. Im Abschnitt 1.7.4 findet sich der folgende Abschnitt:

Zitat:

Abweichend von den vorstehenden Bestimmungen kann die Wartungsanleitung, die zur Verwendung durch vom Hersteller oder von seinem Bevollmächtigten beauftragtes Fachpersonal bestimmt ist, in nur einer Sprache der Gemeinschaft abgefasst werden, die von diesem Fachpersonal verstanden wird.

So kann beispielsweise die Wartungsanleitung nur in englischer Sprache vorliegen, obwohl die anderen Teile der Anleitung der Maschine nur in italienischer Sprache vorliegt, weil die Maschine in Italien betrieben wird. Das Fachpersonal für die Wartung muss allerdings der englischen Sprache mächtig sein. Eine weitere Besonderheit ist, dass diese Sonderregelung nicht für Benutzer der Maschine oder vom Wartungspersonal des Betreibers gilt, sondern nur für das Wartungspersonal vom Hersteller oder dem vom Hersteller bevollmächtigten Personal.

Falls mehrere Dokumente die Technischen Dokumentation ausmachen soll, muss der Zusammenhang der einzelnen Dokumente klar erkennbar sein. Dies kann mithilfe von entsprechenden Verweisen und Verzeichnissen in allen Dokumenten sichergestellt werden. Dadurch ist ersichtlich, welches Dokument, welchen Zweck erfüllen soll und welche Inhalte darin vorkommen.

Ein Leitfaden zum Dokument kann dem Leser den Aufbau der Technischen Dokumentation erläutern. Dieser dient als Navigationshilfe, um zu zeigen was in welchem Teil der Dokumentation alles enthalten ist und auf welcher Seite der Leser welche Informationen findet.

Jeder Teil der Technischen Dokumentation enthält ein eigenes Inhaltsverzeichnis und am Anfang ein erläuterndes Kapitel, damit ersichtlich ist, welche Zielgruppe mit diesem Teil angesprochen wird. Falls relevant enthält dieser Teil auch Informationen zu den benötigten Qualifikationen und Wissen der Zielgruppe.

Sicherheitsinformationen, die nur bestimmte Aufgaben betreffen, können in dem jeweiligen Teil der Dokumentation vorkommen. Allgemeine Sicherheitsanforderungen, welche nicht auf bestimmte Aufgaben beschränkt sind, müssen in einem separaten Dokument behandelt werden. Dies ist auch eine Forderung der Norm DIN EN ISO 20607, das in einem solchen Fall einen Abschnitt bzw. ein Dokument „Sicherheit“ verlangt. In diesem Teil werden alle Sicherheitsinformationen inklusive Sicherheitshinweise aufgeführt, die alle Benutzergruppen betreffen.