ARDOS Author

Das verkannte Potential

Auch bei uns lag zunächst der Fokus auf der Ablieferung der Technischen Dokumentation als strukturierte Dokumentation (SGML/XML) und für den Endanwender als "lesbares" PDF. Doch schnell haben unsere Redakteure erkannt, dass eine vernünftige Authoring-Umgebung zwingend notwendig ist, sofern man den Wunsch hat, Technische Dokumentation effizient und in sich konsistent zu erstellen.

Eine SGML-Dokumentation nach ATA iSpec. 2200 beinhaltet ca. 25-30% mehr Informationen gegenüber klassischer DTP-orientierter Dokumentation. Diese 25-30% mehr Informationen werden natürlich nicht im PDF dargestellt - es handelt sich hierbei vielmehr um Meta-Informationen, die für eine Dokumentationsverwaltung/ein Dokumentationsmanagement in einem Repository unerlässlich sind. In den XML-Dokumentationen nach dem neuen Standard S1000D werden nochmals ca. 25% mehr Meta-Informationen gegenüber ATA iSpec. 2200-Dokumenten bzw. in Summe ca. 50 % mehr gegenüber klassischen DTP-orientierten Dokumentationen an den verschiedensten Datenelementen gepflegt. Hinzu kommen natürlich noch die gesetzlichen und/oder Spezifikations-Änderungen, die meist die Dokumentationen über einen gewissen Zeitraum sowieso komplexer werden lassen.

Das alleinige Merkmal einer strukturierten Dokumentation hätte vermutlich die Dokumentationskosten bereits um 50% erhöht, wenn man nicht die Potentiale dieser Strukturierung für sich nutzt. Ähnlich wie in einer relationalen Datenbank können sämtliche Datenelemente inklusive ihrer Attribute direkt adressiert werden. Das folgende Beispielvideo soll dies für Sie verdeutlichen:

Diese direkte Adressierung birgt ein enormes Potential zur Automatisierung der Technischen Dokumentation. Diese Erkenntnis haben wir konsequent in dem Software-Paket ARDOS Author umgesetzt und so ist durch den ständigen Dialog unserer Software-Entwickler und unserer Redaktionsabteilung eine Fülle von Funktionen entstanden, die den Redakteur bei der täglichen Arbeit unterstützt und gleichzeitig hilft, Kosten zu senken. Nicht unerwähnt möchten wir hier eine durch Automatisierung gewonnene Qualitätssteigerung lassen. Was früher durch mühselige "Handarbeit" erstellt und anschließend manuell geprüft wurde, kann heute durch automatisierte Prozesse erstellt werden.

Die folgende Übersicht und ein Video geben hier bereits einen Überblick, welche Funktionen im ARDOS Author realisiert sind:

• Verwendung optimierter SGML-/XML-Strukturen, welche im Gegensatz zu den S1000D- und iSpec-DTDs für den Erstellungsgrundsatz "designed" sind (S1000D/iSpec – eher für den Datenaustausch).
  ARDOS DTDs stehen für die Vermeidung von Redundanzen, Vereinfachungen von SGML-/XML-Strukturen  und für Vererbungen von Meta-Informationen etc.
• "Erweitertes" Kopieren – bereits beim Kopieren aus anderen Quellen (z.B. ähnliche Manuals, Pageblocks, Tasks, Datenmodule etc.) werden Daten gleichzeitig "bereinigt", Revisionsmerkmale werden für das neue Manual/Datenmodul entfernt, Metadaten werden korrigiert, Vererbungen von Metadaten werden eingefügt.
• Mechanismus für die Selektion von Function Codes bzw. Information Codes inkl. einer aussagekräftigen Aufbereitung (Codes werden nicht nur kryptisch vergeben, z.B. "870 – Description“)
• Vollautomatische Vergabe von Keys, IDs und Sequence Numbers nach definierten und anpassbaren Schemata
• Intelligente Einfüge-Optionen für DPL-Grafiken. Die DPL-Grafiken werden im Batch-Prozess, also gleich mehrere inkl. unterschiedlicher Sheets , an den richtigen Positionen eingefügt.
• "Bulk"-Import von Grafiken, ebenfalls mit Sheets an den vorgesehenen Stellen im Manual (z.B. mehrere 100 Grafiken, jeweils mit 1- ... Sheets mit wenigen Klicks)
• Optimiertes Referenzieren von Grafiken, Tabellen und sonstigen Ankerelementen. Die Auswahl erfolgt komfortabel über Dialoge, die zusätzlich gefiltert werden können.
• Verarbeitung bzw. Anpassung bereits vorhandener Referenzen mit wenigen Klicks.
• "Geführtes" Einfügen von Effectivities (bzw. Applicabilities nach S1000D) inkl. einer TOP-DOWN Vererbung/Reduktion
• Möglichkeit, definierte Templates mit einem Klick einzufügen bzw. Templates selbst zu erstellen
• Excel-Import-Schnittstelle mit variabler Definition. Somit wird die Möglichkeit gegeben, die sonst aufwendige Übernahme von Tabelleninformationen mit wenigen Klicks zu importieren (dies mag zwar für klassische Textverarbeitungen nicht erwähnenswert klingen. Aber für die Dokumentation in SGML/XML dürfte diese Funktion einen erheblichen Komfort- und Zeitgewinn bedeuten).

und vieles mehr!