5c6a2e78cf
Register all active platform services and base features in core DB so admin can manage them, add delivery/hospitality/sports-center backend phases, update apps catalog and production deploy tooling. Co-authored-by: Cursor <cursoragent@cursor.com>
7.0 KiB
7.0 KiB
Phase Handover — AF-Service-Snapshot (Service Snapshot Architecture)
| Field | Value |
|---|---|
| Phase ID | ai-framework-service-snapshot |
| Title | Service Snapshot Architecture |
| Status | Complete |
| Service(s) | N/A (documentation / process only) |
| Version | Framework service-snapshot-1.0 |
| Date | 2026-07-26 |
| ADR(s) | Extends ADR-018, ADR-019 (process; no new ADR) |
Business Analysis Summary
| Item | Detail |
|---|---|
| Capabilities delivered | One compact YAML snapshot per service as primary runtime truth; eliminates repeated reconstruction from completed phase documents; mandatory regeneration after each Complete phase |
| Explicit non-goals honored | No business service code changes; no completed business phase retrofits; no pre-populated business snapshots |
Enterprise Phase Discovery Summary (this docs phase)
| Item | Detail |
|---|---|
| Discovery Record location | This handover + service-snapshot-policy.md |
| Gaps promoted & closed | Repeated multi-doc state reconstruction → service snapshot first; completed phase doc re-reads eliminated when snapshot valid |
| Exclusions | All business phases and services |
| CRUD-only rejected | N/A (process rule) |
Enhancement Catalog
New normative document
| Document | Purpose |
|---|---|
| service-snapshot-policy.md | Required fields, execution entry, fallback reconstruction, regeneration rules, primary runtime truth |
New snapshot infrastructure
| Path | Purpose |
|---|---|
| docs/service-snapshots/ | Snapshot storage directory |
| docs/service-snapshots/_template.yaml | Machine-readable template |
| docs/service-snapshots/README.md | Index and policy link |
Core execution upgrades
| Document | Enhancement |
|---|---|
| runtime-read-policy.md | Execution entry; snapshot in always-reload; Discovery mapping uses snapshot baseline |
| context-cache-policy.md | Snapshot always reloads; superseded handovers cache-eligible |
| master-prompt.md | Snapshot-first loading; regeneration on service extension |
| development-loop.md | Snapshot entry in Discovery; regeneration in Documentation Update; completion rule |
| enterprise-phase-discovery.md | Baseline from snapshot; no completed phase doc reconstruction |
| mandatory-phase-artifacts.md | Artifact #43 Service Snapshot |
| phase-handover.md | Service Snapshot Update section; next-phase entry uses snapshot |
| quality-gates.md | Mandatory Service Snapshot gate + sign-off |
Reusable Components
| Component | Location | Reuse notes |
|---|---|---|
| Service Snapshot Policy | docs/ai-framework/service-snapshot-policy.md |
Every service-scoped phase |
| Snapshot template | docs/service-snapshots/_template.yaml |
Copy per service on first Complete phase |
| Service Snapshot gate | docs/ai-framework/quality-gates.md |
Regeneration verification |
Public APIs
N/A — documentation/process only.
Events
N/A.
Permissions
N/A.
Extension Points
| Extension point | How to extend | Forbidden uses |
|---|---|---|
| New snapshot field | Add to policy + template + regeneration procedure | Storing full OpenAPI or phase doc content in snapshot |
| New service | Create <service>.yaml on first Complete phase |
Skipping snapshot gate |
Known Limitations
- No business service snapshots pre-generated — first service phase after this upgrade builds initial snapshot.
- Snapshot summarizes state; full contracts remain in reference docs when triggered by read policy.
- Framework-only phases do not require a service snapshot file.
Migration Notes
| Item | Detail |
|---|---|
| Alembic revision(s) | N/A |
| Upgrade steps | Next service-scoped Complete phase must regenerate docs/service-snapshots/<service>.yaml |
| Breaking changes | None for runtime; reduced doc fan-out for future phases |
Dependencies
| Dependency | Type | Required for |
|---|---|---|
| AF-Context-Cache-Policy | Docs | Incremental loading |
| AF-Runtime-Read-Policy | Docs | Tiered loading |
| AF-Discovery / ADR-019 | Docs | Discovery baseline |
Boundary Compliance
- No foreign service ownership implemented
- No business logic duplication
- No cross-DB access
- No future-phase business functionality pulled forward
- No business service code modified
Service Snapshot Update
| Field | Value |
|---|---|
| Snapshot path | N/A (framework phase) |
| Snapshot version | N/A |
| Last updated | 2026-07-26 |
| Fields changed | Policy, template, gates, framework cross-links |
Enterprise Completeness Sign-Off
- Discovery completeness (snapshot-based baseline)
- Business completeness (framework process)
- Documentation completeness
- Self Audit
Definition of Done
- service-snapshot-policy.md published
- All listed framework docs updated
- Service Snapshot quality gate added
- Framework handover complete
- No business code changes
Next Phase Entry
- service-snapshot-policy.md execution entry order
- Load
docs/service-snapshots/<service>.yamlwhen present; build on first service Complete phase if missing - runtime-read-policy.md · context-cache-policy.md
- Resume business milestones per next-steps.md when explicitly requested
| Field | Value |
|---|---|
| Recommended next phase | Per next-steps.md (business track) — not started by this phase |
| Blockers for next phase | None; initial per-service snapshots created on next Complete phase per service |
| Entry checklist | Policies → snapshot → manifests → latest handover → Discovery → implement → regenerate snapshot |
Completion Sign-Off
- Service Snapshot Architecture integrated
- Mandatory quality gate added
- Framework handover complete
- No TODO for claimed deliverables
- No business service modifications