mirror of
https://github.com/azaion/satellite-provider.git
synced 2026-06-22 19:31:18 +00:00
[AZ-315] Sync architecture docs after coupling refactor
Phase C of architecture coupling refactor (epic AZ-309). Closes the
last baseline finding (F5 — DataAccess incorrectly documented as
importing Common) and synchronizes the rest of _docs/02_document/
with the post-split project layout from AZ-312/313/314:
- module-layout.md: per-component sections for the three new csprojs
with explicit ProjectReferences and the no-cross-sibling-reference
invariant the split enforces.
- architecture.md: components and internal-communication tables
updated to show calls flow through Common interfaces.
- architecture_compliance_baseline.md: F1..F5 marked Resolved with
task IDs and commit refs; baseline summary now 0 findings.
- diagrams/components.md, components/03_tile_downloader/description.md,
modules/{common_interfaces,services_tile_service,
services_google_maps_downloader,tests_unit}.md updated for the
split, RateLimitException relocation, and new ITileService methods.
Documentation-only batch — no code, no tests, no build changes.
Epic AZ-309 complete (6 tasks across 3 batches).
Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
@@ -0,0 +1,65 @@
|
||||
# Refactor: sync documentation after coupling refactor
|
||||
|
||||
**Task**: AZ-315_refactor_documentation_sync
|
||||
**Name**: Update architecture, module-layout, and component docs for split
|
||||
**Description**: Update `_docs/02_document/` to reflect the post-refactor module boundary and endpoint routing through `ITileService`.
|
||||
**Complexity**: 2 points
|
||||
**Dependencies**: AZ-314
|
||||
**Component**: Docs
|
||||
**Tracker**: AZ-315
|
||||
**Epic**: AZ-309
|
||||
|
||||
## Problem
|
||||
|
||||
The architecture docs (`architecture.md`, `module-layout.md`, `components/03_tile_downloader/description.md`, etc.) describe the pre-refactor world: a single Services csproj and tile endpoints that bypass the service layer. After AZ-310 through AZ-314, the docs drift from reality and the architecture-baseline F3/F4 findings remain unchecked.
|
||||
|
||||
## Outcome
|
||||
|
||||
- `_docs/02_document/architecture.md` reflects the new project structure.
|
||||
- `_docs/02_document/module-layout.md` lists the three new csprojs with their dependency graph.
|
||||
- `_docs/02_document/components/03_tile_downloader/description.md` and the per-component module docs (`modules/services_*.md`) updated for the split.
|
||||
- `_docs/02_document/architecture_compliance_baseline.md` Findings F3 and F4 marked **resolved** with a note linking to AZ-309 / this PR.
|
||||
- Diagrams (`_docs/02_document/diagrams/components.md`) updated if they show the old single Services box.
|
||||
|
||||
## Scope
|
||||
|
||||
### Included
|
||||
- Edits to the documents listed above.
|
||||
- Cross-reference check: any other doc that names `SatelliteProvider.Services` is updated.
|
||||
|
||||
### Excluded
|
||||
- Changing any code.
|
||||
- Adding new tests or test docs.
|
||||
|
||||
## Acceptance Criteria
|
||||
|
||||
**AC-1: Architecture doc reflects the split**
|
||||
Given `_docs/02_document/architecture.md`
|
||||
When read after this task
|
||||
Then it lists three Services csprojs and their dependency boundaries explicitly.
|
||||
|
||||
**AC-2: Module layout is accurate**
|
||||
Given `_docs/02_document/module-layout.md`
|
||||
When read
|
||||
Then each new csproj has its own row with file list and `ProjectReference` set.
|
||||
|
||||
**AC-3: Compliance baseline closed for F3/F4**
|
||||
Given `_docs/02_document/architecture_compliance_baseline.md`
|
||||
When inspected
|
||||
Then findings F3 and F4 are marked resolved with reference to AZ-309 epic and the post-refactor commit.
|
||||
|
||||
**AC-4: No stale references**
|
||||
Given the post-refactor docs tree
|
||||
When grepping for `SatelliteProvider.Services` (without `.TileDownloader`, `.RegionProcessing`, or `.RouteManagement` suffix)
|
||||
Then matches are limited to historical context (e.g. retro / migration notes) — not to descriptions of current state.
|
||||
|
||||
## Constraints
|
||||
|
||||
- No new diagrams unless an existing one becomes wrong.
|
||||
- No copy-edit polish beyond what the refactor requires.
|
||||
|
||||
## Risks & Mitigation
|
||||
|
||||
**Risk 1: Diagram drift**
|
||||
- *Risk*: Mermaid diagrams may show "Services" as a single block.
|
||||
- *Mitigation*: Find each diagram, update to show three blocks with arrows preserving the existing dependency direction.
|
||||
Reference in New Issue
Block a user