ARDOS Checker

Der Zeit voraus

Die strukturierte Dokumentation definiert mittels der DTD oder mittels XML Schema bereits erforderliche und optionale Elemente und Attribute, wodurch natürlich eine gleichbleibende Struktur der Technischen Dokumentation garantiert wird. Neben diesen strukturellen Anforderungen gibt es jedoch eine Reihe von inhaltlichen Themen, die man in der Technischen Dokumentation auch in den Griff bekommen möchte.

Welcher Redakteur kennt nicht das leidige Thema, dass man bereits beim Schreiben der Dokumentation auf Fehler, Unstimmigkeiten oder Schwächen in der Dokumentation hingewiesen werden möchte. Oder die Situation, dass die Dokumentation, die ja oftmals aus mehreren hundert oder tausend Seiten besteht, bereits fertig beschrieben wurde und dann in der Schlussredaktion auffällt, dass bestimmte Regeln – entweder für das Team selbst definiert oder durch Kunden vorgegeben – nicht eingehalten wurden und somit aufwendig nachgearbeitet werden muss.  Auch im Rahmen von Migrationen Technischer Dokumentation – also wenn man "fremde" oder "alte" Dokumentation in eigene Systeme und/oder Dokumentationsumgebungen integrieren – benötigt man eine Analyse der zu erwartenden Aufwände.

Für alle diese Gründe wünscht man sich Tools und Features, die die Technische Dokumentation nach definierten Regelwerken analysiert und eventuelle Abweichungen entsprechend protokolliert. Dieses Feature soll natürlich ebenso einfach und effektiv einsetzbar sein, wie eine klassische Rechtschreibprüfung einer normalen Textverarbeitungssoftware.

Mit dem ARDOS Checker haben wir immerhin einige Jahre vor Veröffentlichung der S1000D, BREX – Business Rule Exchange (ab Version 2.2), bereits im Jahre 2005 solche Mechanismen in ARDOS eingebaut. Im Jahre 2005 waren wir mit dem Ansatz einer regelbasierten Überprüfung der Technischen Dokumentation vermutlich der Zeit voraus, heute hat sich diese Idee in der Technischen Dokumentation zumindest für S1000D längst durchgesetzt. Zwar hat man mit der reinen Definition von BREX noch keine integrierten Prüfprozesse bzw. Prüfsoftware. Aber immerhin hat die Industrie einen XML-basierten Standard verabschiedet, mit dem sich ein Regelwerk vorgeben und austauschen lässt. 

Seit über 10 Jahren wird der ARDOS Checker nun entwickelt bzw. weiterentwickelt, um den Anforderungen der Technischen Redaktion, Technischen Illustration oder Datenredaktion (z.B. IPL/IPD Erstellung) zu entsprechen und eine Unterstützung für den kompletten Redaktionsprozess inklusive des Austausches solch eines Regelwerks zu garantieren. Somit ist der Redakteur jederzeit in der Lage, Plausibilitätschecks seiner Dokumentation oder Teilen der Dokumentation, die zugeliefert werden, selbst durchzuführen:

• ARDOS integriertes Regelwerk für iSpec. 2200 Dokumentation
  • Einhaltung von Simplified Technical English
  • Überprüfung sämtlicher Metadaten inkl. deren Vererbung im Manual
  • Check auf Vollständigkeit (viele SGML/XML Elemente sind selbst optional aber in der Verwendung im Kontext sind diese Elemente dann oft zwingend notwendig)
  • Verwendung von Gültigkeiten
  • Nutzung von Bibliotheken (Tools, Materials etc.)
  • Überprüfung von Grafiken (Größe, Titel etc.)
  • Check von DPL Illustrationen, Parts List und Disassembly/Assembly
  • Plausibilität des gesamten Revisionsprozesses
  • Und viele mehr
• S1000D Option, Check nach BREX-Regelwerken
  • Check nach der jeweiligen DEFAULT BREX (S1000D v 2.3.1, v4.01 und v4.1)
  • Check nach der im jeweiligen Datenmodul definierten BREX (z.B. Airbus BREX)
  • Custom BREX mit selbst definierten Business-Regeln
  • eigener BREX Editor
• API Schnittstelle für die Definition eines eigenen Regelwerkes
  Diese Methode empfiehlt sich, sofern man über Spezifikationsvorgaben hinaus eigene "strengere" Regeln für das Team vorgeben möchte.
  • "einfache" XML basierte "Makrosprache" für die Definition von Regeln
  • Allokation von JavaScripten ebenfalls über diese XML-Struktur