ARDOS Publisher

Die Herausforderung

Neben Marketing-Prospekten und Unternehmenspräsentationen unterliegt auch die Technische Dokumentation dem Anspruch einer Corporate Identity. So soll die  Technische Dokumentation über viele Projekte immer "gleich" aussehen.  Diesem Anspruch kann mit der Nutzung von SGML und XML und der damit verbundenen Trennung von Layout und Content bereits bestens begegnet werden. Zusätzlich zu diesem Anspruch bestehen aber Forderungen, die neuesten Spezifikations-, Gesetzes- oder Unternehmens-Erfordernisse für alle Projekte oft auch rekursiv, d.h. für alte und in Bearbeitung befindliche Projekte, entsprechend umzusetzen. Jeder technische Redakteur kennt nun die Problematik, dass man das Projekt fast abgeschlossen hat und nun doch diese neu hinzugefügten Anforderungen in die bestehende Dokumentation einbauen muss. Alles vor dem Hintergrund, dass die Technische Dokumentation bereits mit zig unterschiedlichen Seitenformaten, Absatzformaten etc. daher kommt. Spätestens hier sucht man clevere und variable Lösungen!

Unser Ansatz

Durch die  Grundforderung der Luftfahrt nach strukturierter Dokumentation, wie SGML nach iSpec 2200 bzw. XML nach S1000D, schreiben wir bereits in diesen Formaten. Insofern lag es - neben der Trennung von Layout und Content - nahe, konsequent auf die Layout-basierte Erstellung der Dokumentation (z.B. DTP-Programme mit XML-/SGML-Erweiterungen) bzw. auf FOSI-basierte Techniken zu verzichten, um oben genannte Anforderungen effizient umzusetzen.
ARDOS verwendet XSL (Extensible Stylesheet Language) für die Publizierung der bereitgestellten strukturierten Dokumentation. Hier kommen vor allem ein modularer Ansatz, XSLT für Transformationsprozesse und XSL-FO für Formatierungsanweisungen zum Einsatz. Zugleich sind wir damit in der Lage, zur Laufzeit sämtliche Dokumente anzupassen, ohne das Programmierkenntnisse beim Redakteur vorhanden sein müssen. Das SGML-/XML-Dokument inkl. aller Grafiken wird innerhalb ARDOS um die XSL-FO-Elemente ergänzt und anschließend dem XSL-Prozessor (derzeit XSL-Formatter von Antennahouse) übergeben. Sämtliche Grafiken werden im Dokument entsprechend ihrer Größe eingebunden. Es erfolgt eine automatische Bestimmung der Grafikgröße, der damit verbundenen Auswahl von Letter- oder Fold-Out-Seiten sowie dazugehöriger Einbindung von "Intentionally Left Blank"-Seiten. Eine im ARDOS-Prozess beiliegende "Steuer-/Konfigurationsdatei" definiert sämtliche Parameter zur Ausgabe der PDF-Datei. Wir sind in der Lage, die Technische Dokumentation zur Laufzeit an über 200 unterschiedlichen Parametern zu verändern und somit an die unterschiedlichsten Anforderungen anzupassen:

  • Unterschiedliche Schriftarten
  • Einbinden von Logos an "zentraler" Stelle
  • Einbinden weiterer Bibliotheken (Tools, Materials etc.)
  • Ein-/Ausschalten diverser Indexe
  • Veränderungen des Layouts
  • Anpassen von PDF-Eigenschaften
  • Ein-/Ausblenden bestimmter SGML-/XML-Elemente im PDF
  • Verschieben von Elementen im PDF
  • Generieren verschiedenster Indexe (Numerical Index, List of Effective Pages etc.)
  • Setzen von Revisionskennzeichnungen – konsistent im ganzen Manual (in der LEP und auf den entsprechenden Seiten)

und vieles mehr!

Der modulare Ansatz der in ARDOS verwendeten Stylesheets ermöglicht außerdem eine rasche Umsetzung weiterer Dokumentationstypen nach Bedarf. Der ARDOS Publisher unterstützt bereits heute eine Reihe von ATA iSpec-Dokumentationen und insbesondere Dokumentationen nach den neuen S1000D-Spezifikationen:

  • CMM – Component Maintenance Manual
    • SGML DTD Version 5.1, 6, 6.1, 7, 7.1, 8, 9, 10, 11 und 12
    • ARDOS XML DTD
      Hinweis: für sämtliche Dokumente wird neben der ARDOS DTD auch immer die ATA DTD/S1000D DTD unterstützt.
  • ACMM – Abbreviated Component Maintenance Manual
  • SB – Service Bulletin
  • SIL – Service Information Letter
  • CRM – Component Repair Manual
  • FRM/FIM – Fault Recovery Manual/Fault Isolation Manual
  • AMM – Aircraft Maintenance Manual (Supplement)
  • IPC – Illustrated Parts Catalog (Supplement)
  • OM – Operation Manual
  • CLM – Cargo Loading Manual
  • OSMM – Operation and System Maintenance Manual
  • GEM – Ground Equipment Manual
  • UM – User Manual
  • SPM – Standard Practices Manual
  • WDM (AWM) – Wiring Diagram Manual (Aircraft Wiring Manual)
  • Diverse S1000D Datenmodule nach v.2.3
  • Diverse S1000D Datenmodule nach v.4.0
  • Diverse S1000D Datenmodule nach v.4.1

 Das folgende Video präsentiert eine Reihe von Konfigurationsparametern für das Publishing der Technischen Dokumentation.

 

Durch die Nutzung von ARDOS Publisher ist man in der Lage:

 

  • verschiedenste Formatierungswünsche umzusetzen,
  • den unterschiedlichen Endkunden-Anforderungen (Airbus/Boeing) zu entsprechen oder
  • als Dienstleister sich den unterschiedlichsten Anforderungen seiner Auftraggeber anzupassen!