OSQAr (Open Safety Qualification Architecture)¶
OSQAr is a documentation-first framework for producing, verifying, and integrating auditable evidence shipments for safety/compliance work.
A shipment is a reviewable bundle containing Sphinx documentation with traceability, plus implementation, tests, and verification reports — all integrity-protected with checksum manifests.
🚀 Getting Started¶
Getting Started with OSQAr — start here: what OSQAr is, install, first shipment in 5 minutes
Using the OSQAr Boilerplate — comprehensive guide: mental model, terms, workflow recipes
Setting Up A Project From Scratch — scaffold a new project or migrate an existing one
📖 Guides (by role)¶
Supplier’s Guide — produce auditable evidence shipments for a component
Integrator’s Guide — verify, intake, and integrate received shipments
🏢 Professional Deployment¶
For organizations adopting OSQAr across teams and projects:
Lifecycle Management — requirements lifecycle, baselines, change management
Multi-project workflows — workspace orchestration, dependency closure, batch intake
Collaboration workflows (multi-user) — multi-user workflows, review processes, team coordination
Integrating Verification into CI — wire OSQAr into GitHub Actions or other CI pipelines
🔧 Reference¶
CLI Reference — full per-command reference (all flags, exit codes, examples)
Configuration and hooks — project/workspace config files, custom commands, hooks
📦 Examples¶
OSQAr ships with reference examples for C, C++, Rust, and Python:
For safety-related embedded projects, OSQAr recommends C or Rust. The Python example is an easy-to-run demo for the documentation and traceability workflow.
Full demonstration — OSQAr-cJSON¶
For a complete, real-world qualification project, see:
OSQAr-cJSON — an ISO 26262 SEooC qualification attempt of the cJSON library targeting ASIL D, with CI-driven evidence shipments, 88% statement coverage, 162 Unity tests, and reproducible builds.
🧠Agent Skills¶
OSQAr ships with content-authoring skills that help authors — human engineers and AI agents alike — map ISO standards requirements onto OSQAr qualification needs.
Agent Skills for OSQAr Qualification — how agents should navigate the three-tier skill ecosystem (content-authoring + domain-specific + organization-specific), task routing, clause verification, and common pitfalls