STD #002 Anlagendokumentation – Ratschläge beim Erstellen

Eine Anlagendokumentation ist weit komplexer wie eine normale Dokumentation für eine Maschine. Der Technische Redakteur muss sich beim Verfassen Gedanken machen, wie er die Struktur für die Betriebsanleitung aufbaut.

Wie gliedert man am besten die Dokumentation, wenn diese mehrere tausend Seiten umfasst? Falls die Anleitung dann noch auf Papier ausgedruckt werden soll, wie legt man diese organisatorisch am besten ab?

Sehr schnell umfasst die Dokumentation stapelweise Ordner voll mit Zeichnungen, Beschreibungen und Pläne.

Das ganze hört sich sehr zeit- und kostenintensiv an, um eine Anlagendokumentation zu erstellen. Natürlich benötigt eine gut ausgearbeitet Dokumentation eine Menge Zeit und auch Kosten. Schließlich soll die Anlage auch sicher betrieben werden können. Der Nutzer benötigt schließlich die Informationen zum Produkt und dessen Verwendung. Informationen sollen vom Leser schnell und sicher gefunden werden. Auch die Anlagendokumentation soll nach diesem Gesichtspunkt aufgebaut sein.

Die Tiefe der bereitgestellten Informationen entscheidet auch immer über Qualität und Kostenfaktor der Anlagendokumentation. Welches Fachwissen besitzt die Zielgruppe? Was ist bezüglich Terminologie, Abkürzungen und Fachbegriffe in der Dokumentation zu beachten? Welche Besonderheiten sind am Zielort des Produktes zu beachten? Beim Zielort kann vor allem der Bereich Ausbildung der Nutzer sehr unterschiedlich ausfallen. Hier in Deutschland haben wir ein sehr hochwertiges System und man kann von den Nutzern viel Vorwissen erwarten, in anderen Ländern müssen Beschreibungen und Erläuterungen deutlich genauer ausformuliert werden.

Da aktuell immer noch die Maschinenrichtlinie aus dem Jahr 2006 gültig ist, muss die Bereitstellung der Anleitung zur Anlage immer noch in Papierform stattfinden. Neben der üblichen Papieranleitung gibt es in der heutigen digitalen Zeitalter aber auch mehrere andere Möglichkeiten, die benötigten Informationen optional bereitzustellen. Digitale Anleitungen für Endgeräte wie Handy oder Tablets in Form von PDF- oder HTML-Dateien sind heutzutage öfters anzutreffen. Nicht jedes Unternehmen ist natürlich bereit diesen Mehraufwand für digitale Anleitungen zu tragen.

Da aber eine Anleitung in Papierform immer noch Pflicht ist, sollte man sich überlegen wie man bei einer komplexen Anlage, die Anleitung dem Benutzer übergibt. Die Struktur und Organisation der Anleitung ist ein wichtiges Thema bei einer Anlagendokumentation. Nehmen wir beispielsweise die Dokumentation eines Kraftwerkes als Beispiel. So ein Kraftwerk kann als Anlage bezeichnet werden, da dort viele Maschinen zusammenarbeiten. Allein schon die Wartung für ein Kraftwerk benötigt ordnerweise an Anleitungen und Handlungen für das Wartungspersonal.

Um sich zu überlegen, wie man eine komplexe Anlagendokumentation also gut organisatorisch aufbaut, ist die Charakteristik der Benutzergruppen zu betrachten. Verschiedene Personen mit unterschiedlichem Fachwissen benutzen die Anlage. Von der Planung bis zum eigentlichen Betrieb der Anlage arbeiten unterschiedliche Berufsgruppen mit der Dokumentation der Anlage. Es ist also nicht verkehrt, das Benutzerverhalten der jeweiligen Gruppen zu untersuchen.

Welche Teile der Dokumentation benötigt der Logistiker, der die Anlage transportiert? Welche Teile die Mechaniker oder Elektriker, welche die Anlage aufbauen und in Betrieb nehmen? Was muss das Schichtpersonal oder der Sicherheitsverantwortliche für den Betrieb der Anlage an Informationen erhalten? Manche dieser Teile umfassen je nach Anlage schon so viel Inhalt, dass diese einen Ordner oder mehrere füllen.

Dies kann man nutzen, um seine Dokumentationsteile entsprechend zu gliedern. Informationen, die beispielsweise für die Instandhaltung oder Störungsbehebung benötigt werden, kann in einem separaten Dokument gesammelt werden. Das Personal für die Instandhaltung bzw. Störungsbehebung benötigt dann nur dieses Dokument und nicht alle Dokumente. Das minimiert den Stapel an Papier und die Anzahl der benötigten Ordnern für das zuständige Personal.

Wir haben nun die Informationen für die Anlagendokumentation auf einzelnen Nutzergruppen reduziert. Diese können sowohl digital wie auch in Papierform entsprechend verwaltet werden.

Damit die jeweiligen Benutzer schnell ihre benötigten Informationen finden, ist ein gewisses Ordnungssystem nötig. Hier ist zudem ein Verzeichnis hilfreich, welches eine Übersicht über die jeweiligen Dokumente enthält. Darin steht, in welchem Ordner sich welche Informationen befinden. Ein übergreifendes Inhaltsverzeichnis fasst alle Teile der Anlagendokumentation zusammen. So kann der Elektriker erst mal zentral im Hauptverzeichnis nachschlagen, in welchen Teilen der Dokumentation die für ihn benötigten Pläne und Anweisungen stehen und nimmt sich dann nur den betreffenden Teil der Dokumentation heraus.

Ich fasse nun nachfolgend einige Tipps und Ratschläge zusammen, die hilfreich beim Erstellen einer Anlagendokumentation sind:

• Orientieren Sie sich beim Erstellen der Anlagendokumentation an Ihre Nutzergruppen.
• Schreiben Sie die Informationen für die jeweiligen Nutzergruppen verständlich zusammen.
• Alle Lebensphasen der Anlage beschreiben und in sinnvolle Teile aufgliedern bezogen auf die Nutzergruppen (Wer benötigt welche Informationen zu Transport, Auspacken, Installieren, Inbetriebnahme der Anlage, usw.)
• Zuliefererdokumente entsprechend den Nutzergruppen auch in die jeweiligen Abschnitte übersichtlich und leicht verständlich integrieren.
• Ein Kapitel einbauen, welches die Gliederung der Dokumente erläutert. Welche Teile der Dokumentation sind für die Nutzergruppen in welchen Dokumente zu finden.
• Wichtig sind auch die Verzeichnisse für die Dokumentation. Dabei sind nicht nur die Inhaltsverzeichnisse gemeint. Auch Tabellen- oder Abbildungsverzeichnisse, ein Index, Begriffs- und Abkürzungsverzeichnisse verbessern die Navigationsmöglichkeiten.
• Jeder Ordner sollte ein eigenes Inhaltsverzeichnis enthalten. Eine Zusammenfassung aller Inhaltsverzeichnisse kann in dem ersten Ordner abgelegt werden.
• Umfasst die Dokumentation der Anlage viele Ordner, ist es sinnvoll auch die Kennzeichnung der Ordnerrücken (Farbe, Merkmale der Beschriftung, usw.) zu erläutern. Dann weiß der Benutzer auch wie er in einer Vielzahl von Ordnern, schnell den richtigen Ordner finden kann.
• Vermeiden Sie Querverweise! Schreiben Sie Inhalte lieber doppelt. Das ist besser, als Verweise einzubauen, die auf andere Teile der Dokumentation in anderen Ordnern verweisen. Wenn das Wartungspersonal nur den Ordner für Wartung dabei hat und in diesem sich einen Verweis auf einen anderen Ordner beinhaltet, fehlt dem Wartungspersonal am Ende der andere Ordner.
• Auch sollte an Dritte gedacht werden, die mit der Anlage nicht direkt zu tun haben. Personen können beispielsweise die Halle, in der die Anlage läuft, nur durchqueren wollen. Oder Kuriere bzw. Paketzusteller, welche an eine Person etwas liefern. Für diese sollten entsprechende Verhaltensregeln bzw. Hinweise zur Sicherheit außerhalb des Anlagenkomplexes parat stehen.
• Sinnvoll sind auch Betriebsanweisungen dem Anlagenbetreiber bzw. –benutzer mitzugeben. Diese können an den einzelnen Stationen angebracht werden. Neben wichtigen Punkte die an dieser Station zu beachten sind, kann auch das Verhalten im Falle eines Notfalles erläutert werden.
• Optionale Möglichkeit der Informationsbereitstellung bedenken. Heutzutage ist es schon üblich, dass das Personal die Dokumentation der Anlage mittels Handy, Tablet oder Laptop aufruft. Beispielsweise können an Arbeitsstationen QR Codes zum Scannen bereitliegen, die dann auf dem elektronischen Endgerät dann die benötigten Informationen zu dieser Arbeitsstation bereitstellt. Ein Elektriker könnte so bequem einen Code am Schaltschrank der Anlage scannen und bekommt auf sein Handy bzw. Tablet alle benötigten Schaltpläne, Zeichnungen und Handlungsanweisungen für diesen Bereich angezeigt.

Ansonsten gelten auch die üblichen Regeln zum Erstellen einer normalen Technischen Dokumentation. Die Dokumentation muss den Benutzer sicher im Umgang mit dem Produkt anleiten.

Wie man sieht ist die Planung einer Anlagendokumentation eine andere Hausnummer wie die Planung einer Dokumentation einer einzelnen Maschine. Die Technische Redaktion muss die Fülle an Inhalte in eine sinnvolle Struktur und Ordnung bringen. In diesem Bereich ist zudem die Spanne zwischen Qualität und Kosten groß. Eine gut strukturierte Anlagendokumentation benötigt nun mal viel Zeit und kostet auch einiges. In der Realität wird häufig aber gerade bei der Technischen Dokumentation gespart.