RA #005 Aufbau und Aufteilung einer Technischen Dokumentation

Eine Technische Dokumentation von einer Anlage kann schnell mal mehrere hundert Seiten umfassen. Möchte der Benutzer nur bestimmte Informationen in der Dokumentation finden, nimmt die Suche sehr viel Zeit in Anspruch. Ein sinnvoller Aufbau einer Technischen Dokumentation unterstützt den Benutzer, seine Informationen schnell zu finden. Worauf man alles bei der Strukturierung und einer möglichen Aufteilung der Dokumentation achten muss, möchte ich nachfolgend näher behandeln.

Beginnen wir mit der Struktur einer Technischen Dokumentation. Die vielen Informationen, die der Benutzer mit dem Produkt erhält, müssen irgendwie angeordnet werden.

Zuerst sollte der Benutzer über allgemeine Informationen zur Dokumentation selber informiert werden. Wie ist das Dokument aufgebaut und welche Gestaltungsmerkmale weißt das Dokument auf. Den Aufbau erläutert das Inhaltsverzeichnis mit seiner Kapitelübersicht. Ein darauf folgendes Kapitel erläutert mit welchen gestalterischen Merkmalen wie Aufzählungen, Symbole und Hinweise das Dokument versehen ist.

In einem weiteren Kapitel sollte dann das Produkt selber erläutert werden. Eine Produktbeschreibung mit den wichtigsten Informationen zu dem Produkt ist hier angebracht.

Ebenfalls sollte ein Kapitel Sicherheit vorkommen, welches sich mit möglichen Restrisiken des Produktes beschäftigt. Dieses Kapitel behandelt dann auch die Schutzvorrichtungen für das Produkt und welche Schutzvorkehrungen der Benutzer treffen muss.

Anschließend kommen Informationen zu den jeweiligen Lebensphasen des Produktes. Im Falle einer Maschine bzw. Anlage haben wir die üblichen Lebensphasen Transport, Montage, Installation, Einrichtung, Bedienung, Wartung und Instandhaltung sowie Entsorgung. Auf die Inhalte dieser einzelnen Punkte möchte ich hier nicht eingehen. Diese wurde bereits ausführlich von meinem Kollegen in der Reihe „Betriebsanleitung erstellen“ behandelt.

In diesen Lebensphasen arbeiten unterschiedliche Personen mit dem Produkt, erfüllen Ihre jeweiligen unterschiedlichen Tätigkeiten am Produkt und benötigen unterschiedliche Informationen.

Abschließend sind noch weiterführende Dokumente im Anhang der Technischen Dokumentation aufgeführt. Das können Schaltpläne und technische Zeichnungen sein oder auch die Anleitungen von Zulieferteilen.

Dies kann schon aus dem einfachen Grund nötig sein, das ein einzelnes Dokument zu umfangreich ist. Eine komplexe Anlagendokumentation in Papierform umfasst mehrere hundert Seiten und passt schon gar nicht mehr in einen üblichen Ordner.

Auch arbeiten unterschiedliche Zielgruppen mit dem Produkt und hierbei ist es gar nicht sinnvoll die komplette Dokumentation den einzelnen Zielgruppen zur Verfügung zu stellen. Ein einfacher Anlagenbediener beispielsweise interessiert sich nicht für die Informationen zur Installation oder der Wartung der Anlage. Der Bediener möchte nur die Informationen, die für Ihn relevant sind. Diese umfassen die Lebensphase Bedienung der Anlage mit die für den Bediener relevanten Handlungen und die hierfür benötigten Sicherheitsinformationen.

Falls man sich dazu entscheidet, die Dokumentation aufzuteilen, müssen die einzelnen Teile in Relation zu den anderen Teilen gekennzeichnet sein. Sprich man muss am Anfang des Teiles erkennen, um welchen Teil es sich handelt und wie viele Teile es gibt. Eine eigene Titelseite für jeden Teil kann eine Lösung darstellen.

Diese Titelseite gibt den Inhalt des Teils wieder und vermittelt auch relevante Sachverhalte. Darin kann man dann unter anderem erkennen, um welchen Teil es sich handelt. Beispielweise Teil 4 (Inbetriebnahme) von insgesamt 8 Teilen. Weiterhin kann man angeben, welche Zielgruppe mit diesem Teil angesprochen wird. Im Falle der Inbetriebnahme können dann Elektriker oder das Montagepersonal gemeint sein. Falls relevant enthält dieser Teil auch Informationen zu benötigten Fähigkeiten und Kenntnisse der Zielgruppe.

Auch ein Leitfaden muss am Anfang des jeweiligen Teiles abgebildet werden. Dieser veranschaulicht dem Leser die Kennzeichnungskonventionen und den Aufbau des jeweiligen Teiles. Ein kleines Inhaltsverzeichnis für den jeweiligen Teil gibt so dem Lesenden gleich einen Überblick. Diese dient als Navigationshilfe, um zu zeigen was in dem Teil der Dokumentation alles enthalten ist und auf welcher Seite der Leser welche Informationen findet.  Eine Forderung der DIN EN ISO 20607 ist beispielsweise, dass eine Betriebsanleitung, die mehr als 12 Seiten umfasst, eine Inhaltsverzeichnis enthalten muss.

Falls die Dokumentation aus mehrere Teilen besteht, empfiehlt es sich auch ein gesamtes Inhaltsverzeichnis für alle Teile zu erstellen.

Dieses enthält mindestens Informationen über die erste Gliederungsebene der kompletten Dokumentation mit Angaben zu dem jeweiligen Kapitel bzw. Teil, wo dieses zu finden ist. Also eine Art vereinfachtes Inhaltsverzeichnis mit Angaben zu allen Teilen.

Es kann auch ein vollständiges Inhaltsverzeichnis über die weiteren Gliederungsebenen mit Angaben der Seitenzahlen in den jeweiligen Teilen enthalten sein.

Wie verhält es sich mit den Sicherheitsinformationen für die jeweiligen Benutzergruppen? Können diese ebenfalls aufgeteilt werden oder müssen alle Teile entsprechende Informationen hinsichtlich der Sicherheit beinhalten?

Ein Forderung der Norm DIN EN ISO 20607 ist, dass allgemeine Sicherheitsanforderungen, welche nicht auf bestimmte Aufgaben beschränkt sind, in einem bestimmten Teil der Dokumentation zu finden sein muss. Hier bietet sich daher ein Abschnitt „Sicherheit“ an, der ein eigener Teil der Dokumentation sein kann. In diesem Teil werden alle Sicherheitsinformationen inklusive Sicherheitshinweise aufgeführt, die alle Benutzergruppen betreffen.

Das können beispielsweise Gefährdungen sein, die durch eine vernünftigerweise vorhersehbare Fehlanwendung des Produktes auftreten können. Oder wenn der Betrieb des Produktes Auswirkungen auf bestimmte elektrische Geräte wie Herzschrittmacher haben könnte. Dann müssen diese Informationen in einem allgemeinen Teil bekannt sein.

Anders verhält es sich mit spezifischen Sicherheitsinformationen. Betreffen die Informationen nur bestimmte Aufgaben, kann man diese auch in dem jeweiligen Teil der Dokumentation aufführen. Benötigen beispielsweise nur die Elektriker oder das Montagepersonal bei der Inbetriebnahme eine spezielle persönliche Schutzausrüstung, genügt es diese Informationen nur in dem betreffenden Teil der Dokumentation aufzuführen.

Ein Sicherheitshinweis, der die Gefahr vor schwebenden Lasten während des Transportes des Produktes verdeutlicht, benötigt der Leser auch nur in der Lebensphase Transport. Dieser Sicherheitshinweis kann dann am Anfang des Dokumentationsteiles Transport separat dargestellt sein. Andere Zielgruppen wie die Maschinenbediener haben mit dem Transport der Maschine nichts zu tun und benötigen diese Sicherheitshinweise auch nicht.

Unternehmen setzten verstärkt auf die Bereitstellung von elektronischen Dokumentationen. Für Maschinen und Anlagen muss die Bereitstellung der Dokumentation aktuell immer noch in Papierform stattfinden, da immer noch die Maschinenrichtlinie aus dem Jahr 2006 gültig ist.

Jedoch kann neben der üblichen Papieranleitung auch die Dokumentation optional digital bereitgestellt werden. 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. Aber es lohnt sich durchaus sich über unterschiedliche Medienkonzepte Gedanken zu machen.

Eine elektronisch verfügbare Fassung ermöglicht eine zweite Kopie der Betriebsanleitung, falls das Papierexemplar verloren geht. Gegebenenfalls kann die elektronische Fassung auch die Aktualisierung der Betriebsanleitung vereinfachen.

Die DIN EN ISO 20607 zählt beispielsweise schon verschiedene Veröffentlichungsformen auf. Darunter sind auch elektronische Arten über Speichermedien, interne und externe Server aufgeführt.

Eine elektronische Dokumentation wäre auch weit ökologischer als eine Papierdokumentation. Die Herstellung von einer DIN A4 Seite nimmt 10 Liter Wasser in Anspruch. Bei einer Papieranleitung mit 500 Seiten im doppelseitigen Druck kommen dann schnell mal 2.500 Liter Wasser zusammen, was eine gigantische Wasserverschwendung gleich kommt. Und auch das Recycling dieses bedruckten Papiers verschwendet weitere Wasser. Hinzu kommen noch gefährliche Feinstaubpartikel aus den Druckertoner und Kosten für Verpackung und Logistik.

Eine Möglichkeit, um Papier zu sparen  wäre es eine relativ kurze Betriebsanleitung in Papierform zu liefern, die alle Sicherheitshinweise beinhaltet. Informationen, die für Sicherheit und Gesundheitsschutz relevant sind, müssen weiterhin in Papierform vorliegen. Eine weitere umfangreiche aufgabenbezogenen Betriebsanleitung ladet man hingegen dann elektronisch auf mobile Geräte herunter. Oder direkt über das Produkt mit einer entsprechenden Applikation mit zusätzlichen Navigationsfunktionen verfügbar machen.

Eine solche Vorgehensweise kann auch  Übersetzungskosten senken. Falls viele Sprachen benötigt werden, könnte es durchaus sinnvoll sein, die Anleitung in zwei Teile aufzuteilen. Ein Kurzanleitung, die alle Sicherheitsinformationen und die wichtigsten Arbeitsschritte enthält. Dies wird in alle Zielsprachen übersetzt und als Papierform beigefügt. Eine zweite elektronisch verfügbare Anleitung enthält den vollen Funktionsumfang und ist aber nur in den wenigen Hauptsprachen verfügbar. Die restlichen Sprachen übersetzt man bei Bedarf sukzessiv im nachhinein.

Solche Aufteilungen hinsichtlich der Veröffentlichungsart der Dokumentation sind aber nur möglich, wenn die richtigen Voraussetzungen zutreffen. Die Technischen Redakteure müssen sich daher über ein passendes Medienkonzept Gedanken machen. Hat man für seine Zielgruppe die richtigen Kanäle gewählt? Ist die Dokumentation überhaupt geeignet für eine elektronische Publikation? Was für Erwartungen haben die Zielgruppe überhaupt an die Bereitstellung der Dokumentation? Wie funktioniert die Aktualisierung und Archivierung der Technischen Dokumentation?

Mit der Überarbeitung der Maschinenrichtlinie wird auch hoffentlich die Art der der Veröffentlichung angepasst. Es wäre wünschenswert, dass nicht grundsätzlich eine Papierform der Anleitung  verlangt wird. In vielen Bereichen wird die Papieranleitung vermutlich weiterhin nicht wegzudenken sein, da es Einsatzgebiete gibt wo elektrische Geräte zum Abruf der Anleitung nicht ständig zur Verfügung stehen.