System Architecture Overview Template
Document
Description
{Project Name}: System Architecture Overview
Executive Summary
- System purpose (1-2 sentences)
- Key architectural decisions (bullet list of the most impactful choices)
1. Application Blocks
Bounded Contexts / Domain Packages
- List domain packages with responsibilities
Module Dependency Rules
- Dependency direction diagram or rules
Foundational Architectural Pattern
- Chosen: {pattern}
- Rationale: Why this pattern over alternatives
UI Architecture Patterns (if applicable)
- Rendering model: {server-rendered | SPA | hybrid} — rationale
- Layout pattern: {single-panel | multi-panel | wizard} — rationale
- Component interaction model: {full reload | partial updates | client-side state} — rationale
- Visualization approach: {server-generated | client-rendered | hybrid} — rationale
2. Integration & API Design
API Style
- Chosen: {style}
- Rationale: Why this style
Versioning Strategy
- Chosen: {strategy}
Contract Approach
- Chosen: {approach}
External Integrations
- List 3rd party APIs, webhook patterns, retry policies
Inter-Service Communication
- Chosen: {model}
- Rationale: Why this model
Implementation Patterns
- Service-to-transport mapping:
- Sync/async boundary:
- Protocol-specific constraints:
- Shared service layer:
- Error propagation:
3. Code Organization
4. Data Architecture
5. Test Strategy
6. Performance & Scalability
7. Error Handling & Resilience
8. Infrastructure
9. CI/CD Pipeline
10. Release & Rollback
11. Observability
12. Config & Secrets
13. Security
14. Backup & Recovery
15. Developer Experience
16. Documentation Strategy
17. AI Agent Architecture
Infra layer (Part 1 · Component 1)
| Setting | Value |
|---|---|
| LLM provider | |
| Ollama host / model (if applicable) | |
| API key storage | server env / secret manager |
| Celery broker URL (if CAP-060) | |
| Celery result backend | |
| LLM readiness health check | Yes / No |
Vector tier (Part 1 · Component 3)
| Decision | Value |
|---|---|
| Vector store used | Yes / No |
| Backend | pgvector / dedicated / in-process |
| Embedding model | |
| CAP-090 search_knowledge | Yes / No |
| CAP-094 reference library | Yes / No |
Design pattern & scenario selection
| SC-ID | Pattern | Name | Selected? | Rationale |
|---|---|---|---|---|
| SC-01 | 4 | Conversational planner | ||
| SC-02 | 2 | Field extractor / batch ingest | ||
| SC-03 | 7 | Compiled pipeline | ||
| SC-04 | 3 | Event-driven nudge | ||
| SC-05 | 5 | Governed mutations |
Serving mode (Part 3)
| Mode | Selected? | Notes |
|---|---|---|
| Real-time (3.1) — sync chat, streaming | CAP-040, CAP-003, CAP-100 | |
| Batch / queue (3.2) — worker, CI ingest | CAP-060–066 | |
| Observability for serving (3.3) | CAP-101, CAP-100 events |
Dual execution path (Pattern 4 / SC-01)
| Decision | Choice | Rationale |
|---|---|---|
| Context snapshot in chat (CAP-037) | ||
| Snapshot invalidation (CAP-038) | ||
| Mutation-only conversation tools (CAP-039) | ||
| Full tools in worker only |
Memory tiers (Part 1 · Component 5)
| Tier | CAP-IDs | Selected? | Rationale |
|---|---|---|---|
| 1 Hot snapshot | 037–039 | ||
| 2 Semantic search | 091 | ||
| 3 AI profile | 092 | ||
| 4 Reference library | 094, 090 | ||
| 5 Entity notes | 093 |
Capability checklist
| CAP-ID | Name | Implement? | Project module path |
|---|---|---|---|
| CAP-001 | LLM Port protocol | ||
| CAP-004 | ScriptedLLM | ||
| CAP-037 | Context snapshot hydration | ||
| CAP-038 | Snapshot invalidation hooks | ||
| CAP-039 | Dual tool exposure | ||
| CAP-091 | Semantic context search | ||
| CAP-101 | Agent interaction trace | ||
Assembly template
- Template: {T-01 Planner | T-02 Field | T-03 Pipeline | T-00 Custom}
- Custom CAP list (if T-00): CAP- , CAP- , …
Agent identities (CAP-121 / CAP-122)
| Identity | Role | Model tier | Allowed tools |
|---|---|---|---|
| planning / execution / field |
Agent Blackboard (if CAP-070 selected)
| Key | Role | Durability |
|---|---|---|
- Durability tier: {A — in-process | B — run-persistent}
- Max board size (chars): ______
Plan & Steps (if CAP-050 selected)
- States:
pending → running → completed | failed | waiting_retry - Hybrid step flags in use: {is_critical, is_planning, is_variable_assessment, data-only}
- Worker uses LLM per step (CAP-054) — not mechanical tool-only execution
Worker failure bridge (if CAP-060 selected)
- [ ] CAP-100 plan_failed event and/or chat context injection on worker failure
- [ ] PRF-SC01-07 mapped to integration test file
Observability (Part 1 · Component 6 / CAP-101)
| Field | Value |
|---|---|
| correlation_id header | |
| Cost rate table location | |
| PRF-OBS-01 test file |
Integration proof (DoD gate)
| PRF ID | Scenario | Test file |
|---|---|---|
| PRF-SC02-01 | SC-02 thinking JSON | |
| PRF-SC02-02 | SC-02 parse fail loud | |
| PRF-SC02-03 | SC-02 domain D0 pre-filter | |
| PRF-SC02-04 | SC-02 D1 parse fail loud | |
| PRF-SC01-01 | SC-01 plan handoff | |
| PRF-SC01-02 | SC-01 429 retry | |
| PRF-SC01-03 | SC-01 blackboard retain | |
| PRF-SC01-04 | SC-01 dual tool exposure | |
| PRF-SC01-05 | SC-01 snapshot invalidation | |
| PRF-SC01-06 | SC-01 no mechanical worker | |
| PRF-SC01-07 | SC-01 worker failure bridge | |
| PRF-OBS-01 | all — correlation + usage trace | |
| PRF-SC05-01 | SC-05 HITL | |
| PRF-SC05-02 | SC-02+05 full rescan invariants |
SC-02 × SC-05 full rescan (if batch ingest replaces snapshot)
Complete when both SC-02 and SC-05 are selected:
- [ ] Rescan delete ops meet auto-apply confidence threshold (or rescan disables partial auto-apply)
- [ ] ChangeSet apply ordering: deletes → updates → adds when rescan flag is set
- [ ] PRF-SC05-02 mapped to integration test file
18. MCP Architecture
Integration Case
- Chosen: {Case A — Service Bridge | Case B — API Facade | Hybrid}
- Rationale: _____
Transport Topology
| Target | Transport | Port / Path | Notes |
|---|---|---|---|
| Local IDE | stdio | n/a | |
| Remote AI clients | HTTP+SSE |
Tool Inventory
| Tool name | Service method | Write? | HITL? | Case |
|---|---|---|---|---|
- Write-tool policy: {Require explicit confirmation param | HITL prompt before execute | Audit log only}
Auth Pattern
- Selected: {Process user | PAT per call | Session cookie | Mixed}
- PAT injection point: {Tool argument | HTTP header (Bearer)}
- Rationale: _____
Stdout Hygiene (if stdio)
- Logging redirected to stderr / file: {Yes | N/A}
- Third-party stdout suppressed: {Yes | N/A}
- Boot noise test added: {Yes | N/A}
API Readiness Contract (if Case B)
| Tool | HTTP endpoint | Method | Auth header |
|---|---|---|---|
Technology Stack Table
Machine-readable table consumed by Bootstrap Project (BSP) for automated provisioning.
| Layer | Tool | Version | Install Command (macOS) | Install Command (Linux) | Verify Command |
|---|---|---|---|---|---|
| ... | ... | ... | ... | ... | ... |
Note: Each row must have install + verify commands so BSP can automate provisioning.
Skill Coverage Report
| Domain | Covered Skills | Gaps |
|---|---|---|
| Application Blocks | ||
| Integration & API | ||
| Code Organization | ||
| Data Architecture | ||
| Test Strategy | ||
| Performance & Scalability | ||
| Error Handling & Resilience | ||
| Infrastructure | ||
| CI/CD Pipeline | ||
| Release & Rollback | ||
| Observability | ||
| Config & Secrets | ||
| Security | ||
| Backup & Recovery | ||
| Developer Experience | ||
| Documentation Strategy | ||
| AI Agent Architecture | ||
| MCP Architecture |
Key Decisions with Rationale
| # | Domain | Decision | Rationale |
|---|---|---|---|
| 1 |
Discovered Patterns & Lessons Learned
Critical Discoveries
Retrospective Updates
Metadata
- Type:
- Document
- Required:
- No
- Created:
- Apr 12, 2026
- Updated:
- Aug 21, 2026
Producer Activity
Write SAO.md
Define Architecture
Consumer Activities 13
-
Review SAO & Define Infra Requirements
Design & Deploy Cloud Infra Required
-
Plan Feature
Build Feature Required
-
Review SAO & Define CICD Requirements
Design & Deploy CICD Required
-
Verify DTA Artifacts
Deploy Software Process Required
-
Implement Backend
Build Feature Required
-
Scaffold Project Structure
Bootstrap Project Required
-
Implement Frontend
Build Feature Required
-
Verify Architecture & Code Organization
Deploy Software Process Required
-
Initialize Runtimes & Dependencies
Bootstrap Project Required
-
Generate AI IDE Configuration
Deploy Software Process Required
-
Configure Dev Tooling
Bootstrap Project Required
-
Configure Observability & Logging
Bootstrap Project Required
-
Process Change Request
Build Feature Required