ARDOS Checker
Structured documentation uses Document Type Definitions (DTD) or XML Schema to define the underlying grammatical principles of which elements and attributes are required or optional. This guarantees a consistent structure. However, in addition to the formal structure, there are numerous content-related aspects that also need to be controlled.
The Challenge
- Ideally, errors or inconsistencies should be detected during creation to avoid time-consuming rework.
- Rule violations, whether defined internally or specified by the customer, can lead to considerable correction work in large documents with hundreds of pages.
- When migrating old or external documentation, it is essential to analyze the problematic areas in order to integrate them efficiently.
The Answer
The ARDOS Checker offers a comprehensive, rule-based check of technical documentation and provides reports on any deviations. ARDOS has been using this approach since 2005 – long before the introduction of business rules (BREX) in the S1000D standard. With the ARDOS Checker, authors can carry out plausibility checks of documentation and supplied content while complying with industry-specific standards such as ATA iSpec 2200 and S1000D.
Features of the ARDOS Checker
In tegrated set of rules for ATA iSpec 2200 and S1000D-BREX standards.
Simplified Technical English (STE): Verification of compliance with linguistic guidelines.
Metadata Checks: Check of all metadata including their inheritance within manuals.
Completeness Checks: Context-based validation of optional SGML/XML elements.
Checking Effectivities: Ensuring the correct use of applicabilities.
Library Check: Validation of used tools, materials etc.
Graphic Checks: Control of size, titles, DPL illustrations, parts lists and assembly/disassembly.
Revision Process: Plausibility check of the entire revision workflow.
CGM-Checker: Verification of graphics validity and conformity with specifications, as well as comparison of parts listings with the associated graphics.
Specific S1000D Options
Verification in accordance with standard BREX and individual BREX specifications (e.g. Airbus BREX).
Creation of own rules via an API or an XML-based macro language, also with integration of JavaScript for more complex checks.
The Added Value
The ARDOS Checker not only ensures that your documentation is error-free and consistent, but also optimizes efficiency. Automated processes reduce manual intervention and minimize the risk of human error. This saves you time and money while increasing the quality of your technical documentation.