Version: 1.0.0
Last Updated: 2026-01-16
Applies To: AMPEL360 Q100 Program
- Overview
- Prerequisites
- Step-by-Step Onboarding Checklist
- Chapter-Specific Customization Guide
- HITL Escalation Decision Tree
- Source-Tracking Requirements
- Effectivity Rules Configuration
- Validation & Compliance
- Common Pitfalls
This playbook provides a comprehensive guide for onboarding new ATA Chapters into the AMPEL360 Q100 OPT-IN Framework, implementing the full GENESIS → SSOT → LLM ENGINE → CSDB → PUBS → EXPORT pipeline.
GENESIS (Uncertainty Space)
├── O-KNOT: Discovery Layer
├── Y-KNOT: Justification Layer
└── KNOT: Framing Layer
↓
SSOT (Certainty Space)
├── LC01: Problem Statement (KNOTS, KNU_PLAN, TOKENOMICS, TBD_REGISTER)
├── LC02-LC14: Lifecycle-bound artifacts with _derivation.yaml
↓
LLM ENGINE METADATA LAYER
├── Enrichment with confidence scores
├── Source tracking (docId, span references)
├── HITL escalation for low-confidence inferences
↓
CSDB (S1000D Compliant Data Modules)
├── DM: Data Modules (YAML → XML)
├── BREX: Business Rules Validation
├── Transforms: XSLT for format conversion
↓
PUBS (Publications)
├── AMM: Aircraft Maintenance Manual
├── TRN: Training Materials
↓
EXPORT
└── Multiple formats (PDF, HTML, IETP)
Before starting chapter onboarding:
- Framework Understanding: Read ATA-00-00 Reference Implementation
- Axis Assignment: Determine which OPT-IN axis (O/N/T/P/I) the chapter belongs to
- Stakeholder Identification: Identify chapter owner and key stakeholders
- Domain Expertise: Ensure domain expert availability for HITL review
- Tools Setup: Python 3.6+, XSLT processor, JSON Schema validator
-
1.1 Run Scaffold Script
cd OPT-IN_FRAMEWORK/_templates python scaffold_chapter.py --chapter XX --title "Chapter Title" --axis AXIS_NAME
-
1.2 Verify Folder Structure
AXIS_NAME/ └── ATA_XX-TITLE/ └── ATA-XX-title/ └── XX-00-general/ ├── GENESIS/ ├── SSOT/ └── PUB/
-
2.1 O-KNOT Discovery
- Edit
GENESIS/O-KNOT/O-KNOT-XX-00-001/discovery.yaml - Document chapter-specific knowledge gaps
- Assess impact hypothesis (safety, certification, cost, schedule, ops)
- Identify heritage sources
- Add domain-specific concerns
- Edit
-
2.2 Y-KNOT Justification
- Edit
GENESIS/Y-KNOT/Y-KNOT-XX-00-001-001/justification.yaml - Document decision context and constraints
- Create
options_analysis.mdwith at least 2 options - Create
decision_record.mddocumenting final decision - Obtain stakeholder signoff
- Edit
-
2.3 KNOT Framing
- Edit
GENESIS/KNOT/KNOT-XX-00-001/framing.yaml - Define scope_in and scope_out clearly
- Specify acceptance criteria (intent level)
- Map upstream/downstream dependencies
- Set residual_target based on chapter complexity
- Create
plan_outline.mdwith high-level approach
- Edit
-
2.4 Registry Updates
- Update
GENESIS/_registry/o-knot_registry.csv - Update
GENESIS/_registry/y-knot_registry.csv - Update
GENESIS/_registry/knot_registry.csv
- Update
-
3.1 LC01 Problem Statement
- Edit
SSOT/LC01_PROBLEM_STATEMENT/TOKENOMICS.yaml- Set total_tt based on chapter complexity (200-600 TT typical)
- Configure knot_pools with complexity_multipliers
- Adjust lambda_spillover for chapter interdependencies
- Edit
SSOT/LC01_PROBLEM_STATEMENT/KNOTS.csv- List all KNOTs for this chapter
- Edit
SSOT/LC01_PROBLEM_STATEMENT/KNU_PLAN.csv- List planned KNUs across LC02-LC14
- Edit
SSOT/LC01_PROBLEM_STATEMENT/TBD_REGISTER.csv- Document initial TBDs with confidence levels
- Set owners and target dates
- Edit
-
3.2 LC02-LC14 Preparation
- For each relevant LC folder:
- Create
_derivation.yamlfor baseline KNUs - Link back to parent KNOT via derivation_lineage
- Set lifecycle_binding correctly
- Document creation_record with UTC timestamp
- Create
- For each relevant LC folder:
-
4.1 Source Tracking Setup
- Define docId schema for chapter (e.g.,
ATA-XX-DOC-NNNN) - Implement span referencing in all extracted content
- Configure confidence scoring thresholds:
- High confidence: ≥ 0.85 (auto-accept)
- Medium confidence: 0.60-0.84 (HITL review)
- Low confidence: < 0.60 (mandatory HITL)
- Define docId schema for chapter (e.g.,
-
4.2 HITL Escalation Configuration
- Define escalation paths for:
- Missing data (null values)
- Ambiguous terminology
- Conflicting requirements
- Novel/non-standard content
- Assign HITL reviewers per domain
- Set SLA for HITL response (24-72 hours typical)
- Define escalation paths for:
-
4.3 Metadata Enrichment
- Configure chapter-specific entity extraction:
- Part numbers (if applicable)
- Torque specifications (if applicable)
- Electrical parameters (if applicable)
- Safety-critical items
- CRITICAL: Never invent part numbers or specs - extract only or mark null
- Configure chapter-specific entity extraction:
-
5.1 Data Module Structure
- Edit
PUB/AMM/CSDB/DM/data-module.yaml.template - Set S1000D metadata:
- dm_code format:
DMC-AMPEL360-XX-SS-SU-SB-SX-AAA-NNN-V - info_code: Select appropriate code (000-999)
- language: en-US (or as required)
- dm_code format:
- Configure BREX reference:
DMC-AMPEL360-00-00-00-00A-022A-A - Set applicability rules for Q100 aircraft variants
- Edit
-
5.2 BREX Validation Setup
- Review BREX business rules for chapter-specific constraints
- Add custom validation rules if needed
- Configure CI/CD pipeline for automatic BREX checks
- Test sample DM against BREX
-
5.3 Transform Configuration
- Review
PUB/AMM/CSDB/DM/transforms/s1000d-to-markdown.xslt - Customize for chapter-specific content patterns
- Add templates for chapter-specific elements
- Test transform with sample XML
- Review
-
6.1 AMM Configuration
- Define chapter structure in AMM
- Configure cross-references to other chapters
- Set up illustration references (ICN)
- Configure applicability filtering
-
6.2 TRN Materials (if applicable)
- Define training data module structure
- Link to AMM procedural content
- Configure for IETP delivery
-
6.3 Export Pipeline
- Test EXPORT to PDF
- Test EXPORT to HTML
- Test IETP integration
- Verify metadata preservation across formats
-
7.1 Schema Validation
- Validate all YAML files against JSON Schema
- Check CSV files for format compliance
- Verify XSLT syntax
-
7.2 Traceability Validation
- Verify O-KNOT → Y-KNOT → KNOT lineage
- Verify KNOT → KNU _derivation links
- Verify KNU → CSDB DM references
- Check for orphaned artifacts
-
7.3 CSDB Compliance
- Run BREX validation on all DMs
- Verify S1000D Issue 5.0 compliance
- Check DMC uniqueness
- Validate cross-references
-
7.4 End-to-End Test
- Create one complete artifact through entire pipeline
- GENESIS → SSOT → LLM → CSDB → PUBS → EXPORT
- Document any gaps or issues
- Obtain stakeholder signoff
Domain Specifics:
- LH₂ storage systems
- Cryogenic handling procedures
- H₂-specific terminology (mass flow kg/s, energy density kJ/kg)
- Safety-critical considerations (flammability, embrittlement)
Customization Points:
- TOKENOMICS: Higher TT allocation (500-600 TT) due to novel technology
- TBD_REGISTER: High volume of TBDs expected for novel H₂ systems
- LLM Confidence: Lower auto-accept threshold (0.80) for safety-critical content
- HITL: Mandatory review for all H₂ safety procedures
Domain Specifics:
- Fuel cell stacks
- Electric motors and power electronics
- Thermal management
- Hybrid propulsion architecture
Customization Points:
- KNOT Dependencies: Heavy dependency on ATA 28 (Fuel)
- SSOT/LC04: Detailed design interfaces with ATA 24 (Electrical Power)
- CSDB: High illustration count (ICN) for complex assemblies
- Effectivity: Variant-specific for different fuel cell configurations
Domain Specifics:
- Novel Q100 extension chapter
- Learning assurance and certification challenges
- AI model versioning and traceability
- Explainability requirements
Customization Points:
- GENESIS: Extensive O-KNOT discovery phase (regulatory uncertainty)
- TBD_REGISTER: High TBD count for certification approach
- LLM Metadata: Special handling for AI training data provenance
- BREX: Custom validation rules for AI artifact documentation
Domain Specifics:
- Digital Product Passport integration
- Blockchain/DLT for traceability
- Lifecycle data capture
- Regulatory compliance (EU DPP requirements)
Customization Points:
- SSOT/LC08: Enhanced configuration management
- Source Tracking: Bidirectional traceability to physical components
- CSDB: Extended metadata fields for DPP attributes
- Export: Additional format for DPP data exchange (JSON-LD)
┌─────────────────────────────┐
│ Content Extracted/ │
│ Generated by LLM │
└──────────┬──────────────────┘
│
▼
┌──────────────┐
│ Confidence │
│ Score? │
└──┬───────┬───┘
│ │
≥0.85│ │<0.60
│ │
▼ ▼
┌────┐ ┌─────────────────┐
│AUTO│ │ MANDATORY HITL │
│PASS│ │ - Human Review │
└────┘ │ - Mark source │
│ - Escalate │
└─────────────────┘
│
0.60-0.84
│
▼
┌─────────────────────┐
│ Content Type? │
└──┬──────┬───────┬───┘
│ │ │
Safety Part# Other
│ │ │
▼ ▼ ▼
┌────┐ ┌────┐ ┌────────┐
│HITL│ │HITL│ │Optional│
│REQ │ │REQ │ │Review │
└────┘ └────┘ └────────┘
Always Escalate:
- Safety-critical procedures (any confidence level)
- Part numbers or specifications (unless ≥0.90 confidence AND verified against parts DB)
- Torque specifications (never auto-accept)
- Novel terminology not in glossary
- Conflicting information from multiple sources
Conditionally Escalate:
- Medium confidence (0.60-0.84) AND first occurrence in chapter
- Cross-chapter dependencies
- Regulatory references
- Revision/update to existing approved content
HITL Response Template:
hitl_review:
artifact_id: "KNU-XX-YY-NNN-REQ-001"
span_reference: "docId:ATA-XX-DOC-1234, span:567-890"
confidence_score: 0.72
issue: "Ambiguous terminology for H₂ flow rate unit"
reviewer: "{{REVIEWER_NAME}}"
review_date: "{{DATE}}"
decision: "ACCEPT|REJECT|MODIFY"
resolution: "Clarified to use kg/s per ATA-28 convention"
confidence_after: 0.95Format: ATA-{CHAPTER}-{DOCTYPE}-{SEQUENCE}
Examples:
ATA-28-REQ-0001- Requirements documentATA-71-DESIGN-0023- Design documentATA-95-CERT-0005- Certification evidence
Implementation:
source_tracking:
doc_id: "ATA-28-REQ-0001"
doc_title: "H₂ Storage System Requirements"
doc_version: "1.2"
doc_date: "2026-01-15"
doc_owner: "STK_SE"Format: docId:{DOC_ID}, span:{START}-{END}[, page:{PAGE}]
Examples:
extracted_content: "The minimum fuel cell operating temperature is -40°C."
source_span: "docId:ATA-71-DESIGN-0012, span:2345-2398, page:14"
confidence: 0.89Span Types:
- Character Offset:
span:2345-2398(byte or character position) - Line Range:
lines:45-47(line numbers) - Section:
section:3.2.1(document structure) - Page:
page:14(PDF page number)
All KNUs must maintain:
- Upstream Trace: Link to source documents via docId/span
- Derivation Trace: Link to parent KNOT via _derivation.yaml
- Downstream Trace: Link to CSDB DMs and publications
Example:
knu_id: "KNU-28-10-001-REQ-001"
derivation_lineage:
parent_knot: "KNOT-28-10-001"
source_documents:
- doc_id: "ATA-28-REQ-0001"
spans: ["span:100-250", "span:500-750"]
confidence: 0.92
downstream_artifacts:
- "DMC-AMPEL360-28-10-00-00A-001A-A"
- "KNU-28-10-001-ICD-001"- Aircraft Serial Number Range: Q100-001 to Q100-999
- Configuration: Baseline, Option A (extended range), Option B (cargo)
- Modification State: Pre-MOD-XXX, Post-MOD-XXX
- Certification Basis: FAA, EASA, CAAC
applicability:
aircraft_serial_numbers:
from: "Q100-001"
to: "Q100-999"
configurations:
include: ["BASELINE", "OPTION_A"]
exclude: ["OPTION_B"]
modifications:
required: ["MOD-28-001"] # H₂ tank upgrade
incompatible: ["MOD-71-005"] # Legacy fuel system
certification:
authorities: ["FAA", "EASA"]
special_conditions: ["SC-28-H2-001"]ATA 28 (Fuel):
effectivity:
fuel_type:
- configuration: "BASELINE"
fuel: "LH2"
applicability: "ALL"
- configuration: "HYBRID"
fuel: "LH2+BATTERY"
applicability: "Q100-501 onwards"ATA 71 (Power Plant):
effectivity:
propulsion_type:
- type: "FUEL_CELL_PRIMARY"
serial_range: "Q100-001 to Q100-500"
- type: "FUEL_CELL_HYBRID"
serial_range: "Q100-501 onwards"Link effectivity to S1000D applicability:
<applic>
<assert applicPropertyIdent="Q100_CONFIG" applicPropertyType="prodattr" applicPropertyValues="BASELINE OPTION_A"/>
<assert applicPropertyIdent="Q100_SERIAL" applicPropertyType="prodattr" applicPropertyValues="Q100-001:Q100-999"/>
</applic>Note: The following validation scripts are planned for future implementation. For now, perform manual validation of schema compliance, BREX rules, and traceability.
-
Schema Validation (Future tool: validate_schema.py)
# Manual validation: Use JSON Schema validators for YAML files # Example: yamllint or python jsonschema library
-
BREX Validation (Future tool: brex_validator.py)
# Manual validation: Use S1000D BREX checker if available # s1000d-brex-check --brex DMC-AMPEL360-00-00-00-00A-022A-A --dm DMC-*.XML
-
Traceability Audit (Future tool: audit_traceability.py)
# Manual validation: Check for broken links in _derivation.yaml files # Verify parent_knot references exist
-
Confidence Score Analysis (Future tool: confidence_report.py)
# Manual validation: Review confidence scores in metadata # Ensure low-confidence items are flagged for HITL review
# .github/workflows/ata-chapter-validation.yml
name: ATA Chapter Validation
on: [push, pull_request]
jobs:
validate:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Validate YAML Schemas
run: python scripts/validate_all_schemas.py
- name: BREX Validation
run: |
python scripts/brex_validate.py --chapter ${{ matrix.chapter }}
- name: Traceability Check
run: python scripts/check_traceability.py
- name: Confidence Report
run: |
python scripts/confidence_report.py > confidence_summary.txt
cat confidence_summary.txt
- name: Upload Results
uses: actions/upload-artifact@v2
with:
name: validation-results
path: confidence_summary.txt❌ Wrong: LLM generates part number P/N: FCS-28-1234 when not in source
✅ Right: Mark as null with confidence < 0.60, escalate to HITL
❌ Wrong: Create KNU without derivation metadata
✅ Right: Every KNU must have _derivation.yaml linking to parent KNOT
❌ Wrong: Mix of ATA-28-10 and ATA-2810 formats, or using formats inappropriately
✅ Right: Use ATA-{CC}-{SS} for chapter-section references (e.g., ATA-28-00). Use full ATA-{CC}-{SS}-{SU}-{SB}-{SX} format only when source documents specify sub-unit/subject granularity. Never use unhyphenated forms.
❌ Wrong: Content without docId/span reference
✅ Right: Every extracted fact has source_span with docId and position
❌ Wrong: Auto-accept all content with confidence > 0.70
✅ Right: Safety-critical content requires HITL regardless of confidence
❌ Wrong: "BREX validation failed but content looks OK"
✅ Right: Fix BREX errors before merging; BREX compliance is mandatory
❌ Wrong: KNOT-28-10-001 depends on KNOT-28-10-002 which depends on KNOT-28-10-001
✅ Right: Use topological sort to verify dependency DAG
❌ Wrong: DM applies to both "BASELINE" and "excludes: BASELINE"
✅ Right: Validate effectivity expressions for logical consistency
- Framework Documentation: OPT-IN_FRAMEWORK/README.md
- ATA-00-00 Reference: 00-00-general/README.md
- Template Library: _templates/
- Scaffold Script: scaffold_chapter.py
Revision History
| Date | Version | Author | Change |
|---|---|---|---|
| 2026-01-16 | 1.0.0 | STK_CM | Initial onboarding playbook |
This playbook is a living document. Submit updates via pull request with changelog entry.