Schmid AG: herausfordernde Doku-Aufgaben

Von der Firma Schmid energy solutions AG wurden wir Anfang 2015 mit der Erstellung einer modular aufgebauten Anlagendokumentation für Holzfeuerungsanlagen beauftragt.

Ausgangslage
Schmid energy solutions mit Stammsitz in Eschlikon ist ein Schweizer Familienunternehmen, welches 1936 gegründet wurde und Niederlassungen in Deutschland, Österreich, Frankreich, Italien und Polen hat.
Schmid energy solutions produziert und installiert Holzfeuerungsanlagen, welche in öffentlichen Bauten, der Industrie sowie für Nah- und Fernwärmeverbunde eingesetzt werden. Hauptvertriebsgebiet ist Europa, es werden aber auch einzelne Anlagen in den USA und in Asien installiert.
Die Technische Dokumentation besteht anfangs aus einer Vielzahl an Unterlagen in verschiedenen Formaten, wie Word, PDF, gescannten Dokumenten, Fotos etc.
Die Unterlagen für die Dokumentation werden im Laufe der Inbetriebnahme durch den Projektleiter vor Ort ergänzt.

Aufgabenstellung und Zielsetzung
Die Herausforderung ist, diese verschiedenen Dokumente für unterschiedliche Anlagenkonfigurationen in einem elektronischen Gesamtdokument zusammenzuführen, das auch zum Druck geeignet ist. Die Dokumentation muss zweistufig erfolgen. Der Projektleiter erhält zunächst eine Vorabdokumentation zur Ergänzung, bei Vorhandensein sämtlicher Unterlagen werden diese dann in die Enddokumentation integriert. Einige der Basisdokumente müssen – je nach normspezifischer Anlagenausführung – für die Ausgabe ein- bzw. ausgeblendet werden. Der Aufbau der Dokumentation ist modular, mehrere Sprachen sind abzudecken. Ziel ist es, eine druckbare elektronische Gesamtdokumentation mit den nötigen Verlinkungen zwischen den Inhaltsteilen zu generieren, wobei die Inhalte der elektronischen Dokumentation kopiergeschützt sein müssen.

Lösung für die Dokumentation
Zur Erstellung der Basisdokumente wird Adobe FrameMaker verwendet. Es werden strukturierte Einzeldokumente als Kapitel erstellt, der modulare Dokumentaufbau wird durch die Buchfunktion realisiert. Das Ein- und Ausblenden anlagenspezifischer Dokumentinhalte wird durch den Einsatz von XML-Attributen ermöglicht. Die Ergänzung der Vorabdokumentation mit den vom jeweiligen Projektleiter während der Inbetriebnahme gelieferten Rapporten und Fremddokumentationen erfolgt durch den Dateiimport mit FrameScript. Dabei werden PDF-Dokumente vollautomatisch auf FrameMaker-Seiten platziert und skaliert. Die Erstellung eines passwortgeschützten PDFs erfolgt direkt aus FrameMaker.

 

Schmid Pyrotronic

Lösung für die Übersetzung
Der XML-Export für die Übersetzung kann aus Adobe FrameMaker sowohl kapitelweise als auch in Form des gesamten Buches erfolgen. Somit ist auch für die Übersetzungen ein modularer Aufbau möglich und bei Bedarf sind die Kapitel in unterschiedlichen Sprachen vorhanden.

Fazit
Die Buchfunktion von Adobe FrameMaker und die Verwendung von FrameScript sind das richtige Konzept für die einfache Realisierung des modularen Doku-Aufbaus. Es erlaubt die einfache nachträgliche Integration der im Zuge der Inbetriebnahme vom Projektleiter gelieferten Rapporte und Fremddokumentationen.
Der modulare, XML-basierte Aufbau der Dokumentation ist die ideale Basis für die Erstellung zukünftiger mobiler Dokumentationslösungen für Tablet-PCs und Smartphones.

Eschlikon (CH) www.schmid-energy.ch

Branche / Produkte: Hersteller von Holzfeuerungsanlagen für Industrie, öffentliche Bauten sowie für Nah- und Fernwärmeverbunde

Aufgabenstellung: Erstellung der Gesamtdokumentation aller Anlagenkomponenten inklusive Zulieferdokumentation

Zielsetzung

  • Modularer Aufbau: Anlage besteht je nach Kunde aus unterschiedlichen Komponenten, zudem sind mehrere Sprachversionen vorhanden
  • Berücksichtigung der Anlagen-Ausführung nach EN-303-5:2012 bzw.  nicht nach EN-303-5:2012: Text- und Bildmodule müssen für Ausgabe ein- bzw. ausblendbar sein
  • Erstellen der Dokumentation in zwei Schritten: 1. Vorabversion zur Ergänzung mit Anlagenspezifikationen für Projektleiter erstellen 2. Alle Einzeldokumente in der druckbaren Gesamtdokumentation mit entsprechenden Verlinkungen vorhanden

Lösung

  • Adobe FrameMaker-Buch mit den Anlagenkomponenten als optionale Unterkapitel
  • Ergänzung um Zulieferdokumente mit Hilfe von FrameScript
  • Ausgabe der Einzelkapitel als XML- Dateien für die Übersetzung
  • Lieferung als PDF-Datei für den Endkunden

Kontakt & Information:
Michael Payr
Technischer Redaktor
+41 71 727 98 84
m.payr@dogrel.com

 

„Durch die kompetente Unterstützung von DOGREL ist unsere Anlagendokumentation professioneller und effizienter geworden. Die Unterlagen sind vollständig, fehlerfrei und stehen in einem ansprechenden Design zur Verfügung. Darüber hinaus schätzen wir die einfache Handhabung.“

Moritz Ganzoni, Produktmanager
Schmid energy solutions