Central navigation hub for all ARES-E enterprise documentation. Organized by audience and function for rapid discovery.
| If you need to... | Go to |
|---|---|
| Understand what ARES-E does | Technical Specification |
| Set up a development environment | Onboarding Guide |
| Deploy to production | Deployment Runbook |
| Review security controls | Security & Compliance Posture |
| Understand data rights & IP | Data Rights & IP Guide |
| Integrate an external engine | Interoperability Specification |
| Document | Purpose |
|---|---|
| Technical Specification | Architecture, scope, FOA alignment, and capability summary |
| Milestone Delivery Matrix | OT milestones mapped to deliverables with acceptance criteria |
| VVUQ Framework | Verification, Validation & Uncertainty Quantification methodology |
| Responsible AI Plan | Ethical AI governance, model cards, bias assessment |
| Document | Purpose |
|---|---|
| Onboarding Guide | Setup, API walkthrough, engine extension tutorial |
| Interoperability Specification | Engine interface contract, registration lifecycle, dispatch protocol |
| Technical Specification | Deep architecture reference |
| Document | Purpose |
|---|---|
| Deployment Runbook | Deployment procedures, monitoring, incident response, maintenance |
| Security & Compliance Posture | Threat model, NIST controls, hardening checklist |
| Document | Purpose |
|---|---|
| Data Rights & IP Guide | IP ownership, patent rights, data markings, DUA compliance |
| Security & Compliance Posture | RTES compliance, export control, NIST/ODNI/DOE mapping |
| Responsible AI Plan | NIST AI RMF alignment, high-risk controls |
| Document | Purpose |
|---|---|
| Security & Compliance Posture | Threat model, incident response, supply chain assessment |
| Deployment Runbook | Monitoring, alerting, incident playbooks |
| File | Lines | Description |
|---|---|---|
| spec.md | ~250 | Master technical specification |
| milestone_delivery_matrix.md | ~120 | OT milestone-to-deliverable mapping |
| vvuq_framework.md | ~150 | VVUQ evaluation methodology |
| interoperability_spec.md | ~200 | Engine interface and dispatch protocol |
| File | Lines | Description |
|---|---|---|
| security_compliance.md | ~200 | Security architecture, threat model, regulatory mapping |
| data_rights_ip_guide.md | ~180 | IP ownership, patent/data rights, DUA compliance |
| responsible_ai_plan.md | ~200 | NIST AI RMF, model cards, bias, human oversight |
| File | Lines | Description |
|---|---|---|
| onboarding_guide.md | ~200 | Developer quickstart, API walkthrough, extension tutorial |
| deployment_runbook.md | ~250 | Production deployment, monitoring, incident response |
| Version | Date | Change |
|---|---|---|
| 0.2.0 | 2025 | Initial enterprise documentation package |
All documents are version-controlled in Git alongside the source code they describe. Updates to source code that affect documented behavior must include corresponding documentation updates in the same commit.