The AURIORA Engineering Standard (AES) is the constitutional engineering reference for the AURIORA Platform: it defines the architectural vocabulary (Product Families, Modules, Controllers, Units, Host Interfaces, Unit Interfaces), naming and identity principles, interface and compatibility rules, the maturity model, and minimum release expectations.
AES is a compact constitution designed for a small team — currently one or two developers — doing disciplined open engineering. It scales requirements by maturity level (Experimental, Active Development, Released) instead of applying release-grade process to prototypes. The guiding principle: create enough documentation to understand, continue, test and reproduce the work, but never require documentation whose maintenance costs more than the risk it reduces.
Start with STANDARD.md.
- STANDARD.md — scope, requirement language, maturity model, conformance, foundation rules
- Principles
- Terminology
- Architecture
- Naming and Identity
- Interfaces and Versioning
- EEPROM Metadata
- Maturity and Release
- Decisions and Governance
- Review Checklists
- Document Index
- Worked Example
AES defines what must be true; the companions define how work is done in their domain. Where a companion and AES conflict, AES prevails.
- AURIORA Hardware Design Guide (
AHDG) — how hardware is designed - AURIORA Firmware Style Guide (
AFSG) — how embedded firmware is designed and written - AURIORA Software Style Guide (
ASSG) — how host-side software is designed and written - AURIORA Documentation Standard (
ADS) — how documentation is written and maintained
MUST/SHALL— mandatory when applicable; most requirements are scoped to an artifact type and maturity levelSHOULD— recommended default; engineering judgment may justify another approach, with no formal exception record requiredMAY— optional
Deviations from applicable MUSTs need a concise note in the project's design documentation; formal exception records are reserved for Released artifacts and platform-wide deviations. See STANDARD.md §2.
This repository is a Markdown source of truth. Generated PDFs or websites are derived from these files and are never canonical.
Released AES versions are recorded in the CHANGELOG and tagged in version control per AES-GOV-011. Feedback and change proposals follow the contributing policy.
This documentation is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License (CC BY-SA 4.0).