Integration von Zulieferdokumenten
Möglichkeiten zur Einbettung von Zulieferdokumenten in der Anlagendokumentation (Druck- und Online-Lösungen) des Kunden
Ausgangssituation
Der Anteil von Zulieferdokumentationen (Fremddokumentationen) am Gesamtumfang einer Anlagendokumentation ist sehr oft nicht unbeträchtlich und kann durchaus nahe der 100%- Marke liegen.
Laut Doku-Norm EN 82079-1:2012 fällt die Bereitstellung von Fremddokumenten in den Bereich des Anlagenlieferanten und muss daher von diesem verpflichtend, und zwar in der jeweiligen Sprache des Betreiberlandes, in die Gesamtdokumentation integriert werden. Damit diese an sich umständliche und zeitraubende Arbeit rasch und strukturiert ablaufen kann, werden bei der DOGREL AG verschiedene Tools und Methoden angewandt, welche nachfolgend kurz beschrieben werden.
Aufgabenstellung und Zielsetzung
Alle Fremddokumente sollen in eine Gesamtdokumentation integriert und in einem sowohl für den Druck als auch für die Online-Bereitstellung geeignetem Format ausgegeben werden. Dabei sollen folgende Vorteile generiert werden:
• Doku aus einem Guss
• Automatisch generierbares Inhaltsverzeichnis
• Verlinkungen zwischen Dokuteilen
• Durchgehende Seitennummerierung
Die Form der Bereitstellung der Gesamtdokumentation hängt von den Kundenanforderungen in Bezug auf die Inhaltspflege, die Gewährleistung der Aktualität der Dokumentation und der notwendigen Verfügbarkeit von Versionsständen ab. In Abhängigkeit von diesen Anforderungen wird entweder eine Druckdokumentation, die zusätzlich als PDF elektronisch verfügbar ist, oder eine Online-Variante erstellt.
Lösung für gedruckte Dokumentationen
Für die Integration von Zulieferdokumentationen in eine PDF-Gesamtdokumentation wenden wir einen mehrstufigen Arbeitsprozess an.
Zunächst wird in FrameMaker das strukturierte Basisdokument mit den entsprechenden Kapitelüberschriften erstellt. Dann werden die vorliegenden Fremddokumente in das PDF-Format umgewandelt, sofern sie nicht schon in diesem vorliegen.
- Screenshot einer Online-Dokumentation inkl. Einbindung aller Fremddokumente.
Im nächsten Schritt werden die Zulieferdokumente Kapitel für Kapitel mithilfe von vollautomatischen Tools in das FrameMaker-Basisdokument importiert. Dabei werden PDF-Dokumente automatisch auf FrameMaker-Seiten platziert und skaliert.
Nach dem Import aller Fremddokumente werden Inhaltsverzeichnis und Seitennummerierung automatisch erstellt. Nun muss nur noch ein PDF für die Druckausgabe generiert werden.
Lösung für Online-Dokumentationen
“Offline verfügbar, online updatebar” lautet das Konzept. Zur Realisierung gibt es eine Vielzahl an Möglichkeiten, bei der Auswahl der richtigen Methode müssen zahlreiche Kriterien berücksichtigt werden, die wichtigsten sind:
• Rechtliche und normative Vorgaben
• Zugriff auf die Dokumente
• Lese- und Schreibrechte
• Versionsstände vorhanden und klar voneinander unterscheidbar
• Frage der Zuständigkeit für die Inhaltspflege klären (Obliegenheit des Kunden oder des Dienstleisters?)
• Verlinkungen zwischen den Basisdokumenten ermöglichen
Folgende Vorteile können genutzt werden:
• Online- Editierbarkeit
• Zusätzliche Offline- Verfügbarkeit
• Intelligente Suchfunktion
• Intelligente Filterfunktion
• Verlinkung mit Ersatzteilkatalog
• Verlinkung mit Wartungshandbuch
• Möglichkeit zur Einbindung von Videos
etc.
Basisvoraussetzungen:
• Standardisierte Ablage der Zulieferdoku
inkl. standardisierter Namensgebung
• Sprachabhängige Dateiablage
• Exakte anlagenspezifische Zuordnung der
Zulieferdokumente
Fazit
Die Umsetzung der Gesamtdokumentation in Form eines PDFs für den Druck ist in jedem Fall mit weniger Aufwand verbunden, als die Bereitstellung einer Online-Dokumentation. Dafür sind einige der Vorteile aus der Liste oben nicht nutzbar, z. B. die Live-Editierbarkeit. Online-Dokumentationen erfordern bezüglich Aktualisierung und Verfügbarkeit von Dokumentversionen und Dokumentsprachen entsprechenden Pflegeaufwand, sowie die Versiertheit des Dokubeauftragten im Umgang mit einem CMS bzw. mit Datenbanken. Nutzen Sie deshalb die Kompetenzen der DOGREL AG und profitieren Sie von Vorteilen, wie der professionellen Unterstützung beim Einbinden von Zulieferdokumentationen bezüglich rechtlicher und normativer Aspekte und sparen Sie somit Zeit und Personalressourcen ein.
Kontakt & Information:
Michael Payr
Technischer Redaktor
+41 71 727 98 84
m.payr@dogrel.com
Themen Infotrend Herbst 2015