7a0bd0f701
generate_plans.md: Master plan defining 10 phases (0, 1, 2, 3A, 3B, 3C, 4-8) with component assignments, sub-tasks, testable outcomes, and HighLevelReqs coverage. Phase 3 split into 3A (runtime foundation + failover), 3B (site I/O + observability), 3C (deployment pipeline + S&F) per Codex review. Failover testing embedded in runtime phases, not deferred to hardening. requirements-traceability.md: Full matrix mapping all 54 HighLevelReqs sections and 22 REQ-* identifiers to implementation phases. Zero unmapped requirements. questions.md: 15 open questions requiring follow-up before/during implementation (tooling, environments, team, integration targets).
6.9 KiB
6.9 KiB
Requirements Traceability Matrix
Purpose: Ensures every requirement from HighLevelReqs.md and every REQ-* identifier maps to at least one implementation phase. Updated as plan documents are generated.
HighLevelReqs.md Sections → Phase Mapping
| Section | Description | Phase(s) | Plan Document | Status |
|---|---|---|---|---|
| 1.1 | Central vs. Site Responsibilities | 3A | phase-3a-runtime-foundation.md | Pending |
| 1.2 | Failover | 3A, 8 | phase-3a, phase-8 | Pending |
| 1.3 | Store-and-Forward Persistence | 3C | phase-3c-deployment-store-forward.md | Pending |
| 1.4 | Deployment Behavior | 3C, 6 | phase-3c, phase-6 | Pending |
| 1.5 | System-Wide Artifact Deployment | 3C, 6 | phase-3c, phase-6 | Pending |
| 2.1 | Central Databases (MS SQL) | 1 | phase-1-central-foundations.md | Pending |
| 2.2 | Communication: Central ↔ Site | 3B | phase-3b-site-io-observability.md | Pending |
| 2.3 | Site-Level Storage & Interface | 3A | phase-3a-runtime-foundation.md | Pending |
| 2.4 | Data Connection Protocols | 3B | phase-3b-site-io-observability.md | Pending |
| 2.5 | Scale | 8 | phase-8-production-readiness.md | Pending |
| 3.1 | Template Structure | 2 | phase-2-modeling-validation.md | Pending |
| 3.2 | Attribute Definition | 2 | phase-2-modeling-validation.md | Pending |
| 3.3 | Data Connections | 2, 3 | phase-2, phase-3 | Pending |
| 3.4 | Alarm Definitions | 2 | phase-2-modeling-validation.md | Pending |
| 3.4.1 | Alarm State | 3B | phase-3b-site-io-observability.md | Pending |
| 3.5 | Template Relationships | 2 | phase-2-modeling-validation.md | Pending |
| 3.6 | Locking | 2 | phase-2-modeling-validation.md | Pending |
| 3.6 | Attribute Resolution Order | 2 | phase-2-modeling-validation.md | Pending |
| 3.7 | Override Scope | 2 | phase-2-modeling-validation.md | Pending |
| 3.8 | Instance Rules | 2 | phase-2-modeling-validation.md | Pending |
| 3.8.1 | Instance Lifecycle | 3C, 4 | phase-3c, phase-4 | Pending |
| 3.9 | Template Deployment & Change Propagation | 3C, 6 | phase-3c, phase-6 | Pending |
| 3.10 | Areas | 2, 4 | phase-2, phase-4 | Pending |
| 3.11 | Pre-Deployment Validation | 2 | phase-2-modeling-validation.md | Pending |
| 4.1 | Script Definitions | 2, 3B | phase-2, phase-3b | Pending |
| 4.2 | Script Triggers | 3B | phase-3b-site-io-observability.md | Pending |
| 4.3 | Script Error Handling | 3B | phase-3b-site-io-observability.md | Pending |
| 4.4 | Script Capabilities | 3B, 7 | phase-3b, phase-7 | Pending |
| 4.4.1 | Script Call Recursion Limit | 3B | phase-3b-site-io-observability.md | Pending |
| 4.5 | Shared Scripts | 3B | phase-3b-site-io-observability.md | Pending |
| 4.6 | Alarm On-Trigger Scripts | 3B | phase-3b-site-io-observability.md | Pending |
| 5.1 | External System Definitions | 5, 7 | phase-5, phase-7 | Pending |
| 5.2 | Site-to-External-System Communication | 7 | phase-7-integrations.md | Pending |
| 5.3 | Store-and-Forward for External Calls | 3C, 7 | phase-3c, phase-7 | Pending |
| 5.4 | Parked Message Management | 3C, 6 | phase-3c, phase-6 | Pending |
| 5.5 | Database Connections | 5, 7 | phase-5, phase-7 | Pending |
| 5.6 | Database Access Modes | 7 | phase-7-integrations.md | Pending |
| 6.1 | Notification Lists | 5, 7 | phase-5, phase-7 | Pending |
| 6.2 | Email Support | 7 | phase-7-integrations.md | Pending |
| 6.3 | Script API | 7 | phase-7-integrations.md | Pending |
| 6.4 | Store-and-Forward for Notifications | 7 | phase-7-integrations.md | Pending |
| 7.1 | Inbound API Purpose | 7 | phase-7-integrations.md | Pending |
| 7.2 | API Key Management | 4 | phase-4-operator-ui.md | Pending |
| 7.3 | Inbound API Authentication | 7 | phase-7-integrations.md | Pending |
| 7.4 | API Method Definitions | 5, 7 | phase-5, phase-7 | Pending |
| 7.5 | Inbound API Availability | 7 | phase-7-integrations.md | Pending |
| 8 | Central UI (all workflows) | 4, 5, 6 | phase-4, phase-5, phase-6 | Pending |
| 8.1 | Debug View | 6 | phase-6-deployment-ops-ui.md | Pending |
| 9.1 | Authentication | 1 | phase-1-central-foundations.md | Pending |
| 9.2 | Authorization | 1 | phase-1-central-foundations.md | Pending |
| 9.3 | Roles | 1 | phase-1-central-foundations.md | Pending |
| 9.4 | Role Scoping | 1 | phase-1-central-foundations.md | Pending |
| 10.1 | Audit Storage | 1 | phase-1-central-foundations.md | Pending |
| 10.2 | Audit Scope | 1 | phase-1-central-foundations.md | Pending |
| 10.3 | Audit Detail Level | 1 | phase-1-central-foundations.md | Pending |
| 10.4 | Audit Transactional Guarantee | 1 | phase-1-central-foundations.md | Pending |
| 11.1 | Monitored Metrics | 3B | phase-3b-site-io-observability.md | Pending |
| 11.2 | Health Reporting | 3B | phase-3b-site-io-observability.md | Pending |
| 12.1 | Events Logged | 3B | phase-3b-site-io-observability.md | Pending |
| 12.2 | Event Log Storage | 3B | phase-3b-site-io-observability.md | Pending |
| 12.3 | Central Access to Event Logs | 6 | phase-6-deployment-ops-ui.md | Pending |
| 13.1 | Timestamps (UTC) | 0 | phase-0-solution-skeleton.md | Pending |
REQ-* Identifiers → Phase Mapping
| REQ ID | Component | Description | Phase(s) | Status |
|---|---|---|---|---|
| REQ-COM-1 | Commons | Shared Data Type System | 0 | Pending |
| REQ-COM-2 | Commons | Protocol Abstraction (IDataConnection) | 0, 3 | Pending |
| REQ-COM-3 | Commons | Domain Entity Classes (POCOs) | 0 | Pending |
| REQ-COM-4 | Commons | Per-Component Repository Interfaces | 0 | Pending |
| REQ-COM-4a | Commons | Cross-Cutting Service Interfaces (IAuditService) | 0, 1 | Pending |
| REQ-COM-5 | Commons | Cross-Component Message Contracts | 0 | Pending |
| REQ-COM-5a | Commons | Message Contract Versioning | 0 | Pending |
| REQ-COM-5b | Commons | Namespace & Folder Convention | 0 | Pending |
| REQ-COM-6 | Commons | No Business Logic | 0 | Pending |
| REQ-COM-7 | Commons | Minimal Dependencies | 0 | Pending |
| REQ-HOST-1 | Host | Single Binary Deployment | 0 | Pending |
| REQ-HOST-2 | Host | Role-Based Service Registration | 0, 1 | Pending |
| REQ-HOST-3 | Host | Configuration Binding (Options pattern) | 0, 1 | Pending |
| REQ-HOST-4 | Host | Startup Validation | 1 | Pending |
| REQ-HOST-4a | Host | Readiness Gating | 1 | Pending |
| REQ-HOST-5 | Host | Windows Service Hosting | 1 | Pending |
| REQ-HOST-6 | Host | Akka.NET Bootstrap | 1, 3A | Pending |
| REQ-HOST-7 | Host | ASP.NET Web Endpoints (Central Only) | 1 | Pending |
| REQ-HOST-8 | Host | Structured Logging (Serilog) | 1 | Pending |
| REQ-HOST-8a | Host | Dead Letter Monitoring | 1 | Pending |
| REQ-HOST-9 | Host | Graceful Shutdown (CoordinatedShutdown) | 1 | Pending |
| REQ-HOST-10 | Host | Extension Method Convention | 0 | Pending |
Coverage Verification
HighLevelReqs sections: 54 sections mapped. 0 unmapped. REQ- identifiers*: 22 identifiers mapped. 0 unmapped.
All requirements have at least one phase assignment. Coverage will be re-verified as each phase plan is generated.