ARDOS Checker
Die strukturierte Dokumentation definiert durch Document Type Definitions (DTD) oder XML Schema bereits die grammatikalischen Grundlagen, welche Elemente und Attribute erforderlich oder optional sind. Dadurch wird eine gleichbleibende Struktur garantiert. Doch neben der formalen Struktur gibt es zahlreiche inhaltliche Aspekte, die ebenso überwacht werden müssen.
Die Herausforderung
- Fehler oder Unstimmigkeiten sollen idealerweise schon während der Erstellung erkannt werden, um zeitintensive Nacharbeiten zu vermeiden.
- Regelverletzungen, ob intern definiert oder kundenseitig vorgegeben, können in großen Dokumentationen mit hunderten Seiten zu erheblichen Korrekturaufwänden führen.
- Bei der Migration alter oder externer Dokumentationen ist eine Analyse der problematischen Stellen unerlässlich, um die Integration effizient zu gestalten.
Die Lösung
Der ARDOS Checker bietet eine umfassende, regelbasierte Prüfung der Technischen Dokumentation und liefert Protokolle zu eventuellen Abweichungen. Bereits seit 2005 setzt ARDOS auf diesen Ansatz – weit vor der Einführung von Business Rules (BREX) im S1000D-Standard. Mit dem ARDOS Checker können Redakteure Plausibilitätsprüfungen für Dokumentationen und zugelieferte Inhalte durchführen und dabei branchenspezifische Standards wie ATA iSpec 2200 und S1000D einhalten.
Features des ARDOS Checker
Integriertes Regelwerk für ATA iSpec 2200 und S1000D-BREX-Standards.
Simplified Technical English (STE): Überprüfung der Einhaltung sprachlicher Richtlinien.
Metadaten-Checks: Prüfung aller Metadaten inkl. deren Vererbung innerhalb von Manuals.
Vollständigkeitsprüfungen: Kontextbasierte Validierung optionaler SGML/XML-Elemente.
Prüfung von Gültigkeiten: Sicherstellung der korrekten Verwendung von Applicabilities.
Bibliotheksprüfung: Validierung von verwendeten Tools, Materials etc.
Grafikprüfungen: Kontrolle von Größe, Titeln, DPL-Illustrationen, Parts Lists und Assembly/Disassembly.
Revisionsprozess: Plausibilitätscheck des gesamten Änderungsworkflows.
CGM-Checker: Sicherstellung der Grafik-Validität und Konformität mit Spezifikationen, sowie Abgleich von Parts Listings mit den zugehörigen Grafiken.
S1000D-spezifische Optionen
Prüfung nach Standard-BREX und individuellen BREX-Vorgaben (z. B. Airbus BREX).
Erstellung eigener Regeln über eine API oder eine XML-basierte Makrosprache, auch mit Integration von JavaScript für komplexere Prüfungen.
Der Mehrwert
Der ARDOS Checker unterstützt nicht nur die Fehlerfreiheit und Konsistenz Ihrer Dokumentation, sondern optimiert auch die Effizienz. Automatisierte Prozesse reduzieren manuelle Eingriffe und minimieren das Risiko menschlicher Fehler. Dadurch sparen Sie Zeit, Kosten und steigern zugleich die Qualität Ihrer Technischen Dokumentation.