Automatische Erzeugung von technischen Dokumentationen (Teil 2 von 3)

von  Dr. Uwe Wächter

Ein wichtiger Bestandteil jedes Kundenprojektes im Anlagen- und Sondermaschinenbau ist die Erstellung einer vollständigen und spezifischen Dokumentation der betreffenden Anlage. Abhängig von der Größe und Komplexität des Produktes umfasst die Dokumentation einige wenige oder mehrere hundert Aktenordner. Unterschiedliche Dokumentationen dienen der Beschreibung der Anlage, sowie deren Betrieb und Wartung oder der Instandhaltung und Reparatur. In dieser dreiteiligen Serie auf unserem Blog erklären wir Ihnen, wie Sie mit Hilfe von SEAL-Systems Lösungen solche Dokumentationen automatisiert erstellen. Heute: Teil 2, Die Lösung.

Technische Dokumentationen automatisiert erstellen – Die Lösung

Auslieferung auf Papier und elektronisch

Eine fertige Anlagendokumentation muss oft noch auf Papier in Ordnern geliefert werden; teilweise genügt aber auch bereits die Bereitstellung als strukturiertes PDF. Für die elektronische Langzeit-Archivierung wird ebenfalls ein dafür geeignetes PDF/A benötigt. Unsere Lösung erlaubt die automatische Zusammenstellung der Dokumentation bis zu vollständigen DVDs ebenso wie die Beschickung von Kundenportalen. Für spätere Recherchen kann die fertige Dokumentation vom Direct Publishing-Prozess automatisch an einer zentralen Stelle im PLM-System oder auf dem Fileserver abgelegt werden.

Aufbereitung

Gesamtinhaltsverzeichnis, Ordnerverzeichnis und Ordnerinhaltsverzeichnisse

Der Umfang einer Anlagendokumentation kann wie beschrieben zwischen einem und mehreren hundert Aktenordner umfassen. Ab einer gewissen Menge an Ordnern ist für den Überblick ein Gesamtinhaltsverzeichnis nicht mehr ausreichend. Ein gesondertes Verzeichnis aller vorhandenen Ordner wird nötig. Jeder Ordner selbst erhält dannwiederum ein Inhaltsverzeichnis, welches nur den Inhalt des betreffenden Ordners listet.

Kapiteltrennblätter und Registertrenner

Trennblätter zwischen einzelnen Kapiteln können auf stärkerem Papier gedruckt werden. Die Ausgabe dieser Trennblätter erfolgt dann getrennt von der Gesamtdokumentation auf einem anderen Ausgabekanal. Oder die Gesamtdokumentation erhält an den Stellen andersfarbige Blätter, an denen später ein vorgefertigtes Registerblatt eingelegt werden soll

Seitenlayout und -nummerierung

Alle Seiten der zusammengestellten Dokumentation erhalten neue, fortlaufende Seitenzahlen. Diese neuen Seitennummern finden sich auch in den oben genannten Inhaltsverzeichnissenworkflow_page_neu_1 wieder. Diese Umnummerierung ist dann wichtig, wenn man insbesondere Fremddokumentation gut einbeziehen will. Weiterhin erhalten Fremddokumente neue firmeneigene Kopf- und Fußzeilen. Wenn vorhanden können auch fremde Logos durch eigene ersetzt werden. So wird für die Gesamtdokumentation ein durchgängiges Aussehen im eigenen Corporate Design erreicht. Für die spätere Duplexausgabe werden die Dateien mit ungeraden Seiten aufgefüllt.

Interaktives Inhaltsverzeichnis/Bookmark-Struktur

Für die digitale Ausgabe als PDF erhalten diese weitere Navigationshilfen, wie beispielsweise interaktive Inhaltsverzeichnisse und Bookmarks. Beide erlauben den Sprung auf die jeweiligen Anfänge der ursprünglichen Teildateien, jetzt der gelisteten Unterkapitel. Waren in den ursprünglichen Teildokumenten bereits Bookmarks vorhanden, so werden diese in die jetzt neu erzeugten Bookmarks als Unterbäume mit einbezogen.

Vollständige Integration von Zuliefer-Dokumentationen

Der eigentliche Inhalt der Dokumentation stammt aus unterschiedlichen Quellen. Andere Teile, insbesondere Zulieferteile, werden durch die Originaldokumentation des Zulieferers beschrieben. Hier wird durch Prüf- und Anpassungsverfahren im Direct Publishing-Prozess eine nahtlose Integration in die Gesamtdokumentation gewährleistet. Solche Prüfverfahren sind: keine Schutzmechanismen, initiale Ansichten, PDF/A, Bookmarks ab einer bestimmten Dateigröße.

Automatische Fehlblätter/Platzhalter

Teile der Dokumentation können unter Umständen zum Zeitpunkt der Zusammenstellung der Gesamtdokumentation noch nicht fertig sein. An diesen Stellen werden dann Fehlblätter eingeschoben. Auch die gezielte Erstellung von Teildokumentationen ist vorab problemlos möglich.

Beifügung von Dokumenten im Originalformat

Für die künftigen Betreiber der Anlagen können auch Originaldokumente im Applikationsformat (dem Format ihres Erstellungssystems) wichtig sein. Nach Absprache können diese im Rahmen der Dokumentationserstellung mit ausgeleitet und in digitaler ungeänderter Form vom System durchgereicht werden. Neben Maschinensteuerungen oder CAD-Modellen können hier auch signierte Herstellerzertifikate eine Rolle spielen.

elvis_lupeDokumentgenerierung

Einzelne Teile der zu erzeugenden Dokumentation liegen unter Umständen gar nicht in Dateiform vor. Das sind zum Beispiel Daten, einzelne unformatierte Texte, Bilder oder Ähnliches. Diese können mit Hilfe eines integrierten Reportgenerators in PDF aufbereitet werden. Über den Reportgenerator können die gewünschten Layouts für die Darstellung der Daten, Texte und Bilder erzeugt werden. Die so automatisch generierten Dateien können dann der Dokumentation beigefügt werden. Auf diese Weise sind alle Daten immer auf dem aktuellen Stand.

Monitoring

Gerade bei engen Zeitplänen zur Dokumentationserstellung ist es wichtig, dass der Fortschritt im Erstellungsprozess und mögliche Probleme schnell und zuverlässig erkannt werden können. Für die Betreuer der automatischen Dokumentationszusammenstellung gibt es in der Bedienoberfläche des Direct Publishing-Workflows, der Digital Process Factory, zahlreiche Möglichkeiten, den Ablauf zu steuern und zu überwachen. Zusätzlich zu den leistungsstarken Administrationswerkzeugen, welche die DPF beinhaltet, erzeugt der Direct Publishing Workflow selbstständig Warnhinweise (z.B. per Email), um auf unnormale, evtl. unerwünschte Zustände hinzuweisen. An einzelnen Stellen kann im Bearbeitungsprozess auch von vorn herein ein interaktiver Eingriff vorgesehen werden. Manuelle Prüfschritte oder auch nachträgliches manuelles Einfügen von Dokumenten können solche Anwendungen sein.

Customizing

Der Direct Publishing-Workflow kann äußerst flexibel an die besonderen Gegebenheiten und Anforderungen jedes Kunden angepasst werden.

 

Haben Sie Fragen zur automatischen Erstellung von Technischen Dokumentationen? – Fordern Sie unverbindlich weitere Informationen an!

Teilen

Hinterlassen Sie eine Antwort

Ihre E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind markiert. *

* = Pflichtfeld

  • Blog-Kategorien

  • Blog-Abonnement


    Abonnieren Sie unsere RSS-Feeds und bleiben Sie über neue Blogbeiträge auf dem Laufenden!

  • Anstehende Veranstaltungen

    1. Treffen der AG SAP/Microsoft Integration

      10. August 2017 um 09:00 - 16:30
    2. SAP for Utilities

      10. September 2017 um 08:00 - 14. September 2017 um 17:00
    3. TechEd

      25. September 2017 - 29. September 2017
    4. DSAG Jahreskongress

      26. September 2017 - 28. September 2017
    5. SEAL Systems Schulungstage

      7. November 2017 - 9. November 2017