docs(ui): enrich component preservation map
This commit is contained in:
@@ -1,114 +0,0 @@
|
||||
# Sprint 20260307-009 - UI Component Preservation Map
|
||||
|
||||
## Topic & Scope
|
||||
- Build a durable map of unused and weakly surfaced Angular components in the Stella Ops web console.
|
||||
- Capture first-pass preservation guidance for each component: archive, merge, preserve, wire in, or investigate.
|
||||
- Create a per-component dossier tree so later iterations can deepen the judgment without restarting discovery.
|
||||
- Working directory: `docs/modules/ui/component-preservation-map`.
|
||||
- Expected evidence: generated inventory, per-component markdown dossiers, summary tree, and task-board links.
|
||||
|
||||
## Dependencies & Concurrency
|
||||
- Depends on:
|
||||
- `docs/modules/ui/README.md`
|
||||
- `docs/modules/ui/architecture.md`
|
||||
- `docs/modules/ui/implementation_plan.md`
|
||||
- `docs/modules/platform/architecture-overview.md`
|
||||
- Safe parallelism:
|
||||
- Static inventory generation can run in parallel with manual review of high-value clusters.
|
||||
- Later dossier enrichment can be split by feature family once the index format is frozen.
|
||||
|
||||
## Documentation Prerequisites
|
||||
- `docs/modules/ui/README.md`
|
||||
- `docs/modules/ui/architecture.md`
|
||||
- `docs/modules/ui/implementation_plan.md`
|
||||
- `docs/modules/ui/v2-rewire/source-of-truth.md`
|
||||
- `docs/modules/platform/architecture-overview.md`
|
||||
|
||||
## Delivery Tracker
|
||||
|
||||
### DOCS-UCM-001 - Preservation map scaffold and inventory
|
||||
Status: DONE
|
||||
Dependency: none
|
||||
Owners: Documentation author, Project Manager
|
||||
Task description:
|
||||
- Create the preservation-map doc tree under `docs/modules/ui/` with a stable index, a machine-readable inventory, and one markdown dossier per candidate component.
|
||||
- Inventory should distinguish high-confidence dead components from routed-but-weakly-surfaced components so later review does not conflate them.
|
||||
|
||||
Completion criteria:
|
||||
- [x] Root index exists for the preservation map.
|
||||
- [x] Inventory is deterministic and grouped by feature family.
|
||||
- [x] Each candidate component has a dossier file named after the component.
|
||||
|
||||
### DOCS-UCM-002 - First-pass preservation judgments
|
||||
Status: DONE
|
||||
Dependency: DOCS-UCM-001
|
||||
Owners: Documentation author, Product Manager
|
||||
Task description:
|
||||
- For every inventoried component, document what the component appears to do, why it likely fell out of the active product, and whether its ideas are worth preserving.
|
||||
- Use a constrained recommendation set: `archive`, `merge`, `preserve`, `wire-in`, `investigate`.
|
||||
|
||||
Completion criteria:
|
||||
- [x] Every dossier has a first-pass recommendation.
|
||||
- [x] Recommendations identify likely successor surfaces or merge targets when they exist.
|
||||
- [x] High-value clusters have explicit rationale for preservation vs retirement.
|
||||
|
||||
### DOCS-UCM-003 - Summary tree and iteration plan
|
||||
Status: DONE
|
||||
Dependency: DOCS-UCM-002
|
||||
Owners: Documentation author, Project Manager
|
||||
Task description:
|
||||
- Produce a summary tree that shows the feature branches, what each branch is, and what appears worth keeping in the final product.
|
||||
- Record the remaining gaps that require later iterations and deeper cross-doc validation.
|
||||
|
||||
Completion criteria:
|
||||
- [x] Summary tree exists and is linked from the root index.
|
||||
- [x] Branch-level keep/merge/archive guidance is captured.
|
||||
- [x] Follow-up investigation areas are listed for the next pass.
|
||||
|
||||
### DOCS-UCM-004 - Deep enrichment against Stella Ops dossiers
|
||||
Status: TODO
|
||||
Dependency: DOCS-UCM-003
|
||||
Owners: Documentation author, Product Manager
|
||||
Task description:
|
||||
- Enrich the first-pass dossiers with stronger linkage to product docs, runbooks, contracts, and route-migration decisions.
|
||||
- Resolve ambiguous components whose current value cannot be judged from frontend code alone.
|
||||
|
||||
Completion criteria:
|
||||
- [ ] High-value branches have corroborating doc links.
|
||||
- [ ] Ambiguous components are reduced to a smaller explicit investigate set.
|
||||
- [ ] Final keep/merge/wire recommendations can be defended against current product documentation.
|
||||
|
||||
### DOCS-UCM-005 - Restoration priority backlog
|
||||
Status: DONE
|
||||
Dependency: DOCS-UCM-003
|
||||
Owners: Documentation author, Project Manager
|
||||
Task description:
|
||||
- Convert the branch-level preservation map into an ordered restoration backlog.
|
||||
- Distinguish true restoration work from merge work, wire-in work, and likely retirement.
|
||||
|
||||
Completion criteria:
|
||||
- [x] Ordered backlog exists for dropped and weakly surfaced functionality.
|
||||
- [x] Merge candidates are grouped into product-level topics instead of raw branch names only.
|
||||
- [x] The backlog is linked from the preservation-map root index.
|
||||
|
||||
## Execution Log
|
||||
| Date (UTC) | Update | Owner |
|
||||
| --- | --- | --- |
|
||||
| 2026-03-07 | Sprint created for a multi-iteration preservation map of unused and weakly surfaced UI components. | Project Manager |
|
||||
| 2026-03-07 | Generated first-pass preservation map artifacts under `docs/modules/ui/component-preservation-map/`: root index, summary tree, deterministic inventory, 303 component dossiers, and 89 branch indexes. | Documentation author |
|
||||
| 2026-03-07 | Added `RESTORATION_PRIORITIES.md` to rank dropped-functionality restoration topics by confidence and to distinguish merge candidates from wire-in and retirement work. | Documentation author |
|
||||
|
||||
## Decisions & Risks
|
||||
- Decision: first iteration will prioritize a complete map and first-pass judgment over exhaustive historical certainty.
|
||||
- Decision: preservation guidance uses five stable labels only: `archive`, `merge`, `preserve`, `wire-in`, `investigate`.
|
||||
- Decision: first-pass artifact set is now rooted at `docs/modules/ui/component-preservation-map/README.md`, with `SUMMARY_TREE.md` and `inventory.json` as the stable entry points.
|
||||
- Risk: routed child pages can appear unreachable in static analysis when they are only exposed through relative tab navigation.
|
||||
- Mitigation: record routed-but-weakly-surfaced components separately from high-confidence dead components.
|
||||
- Risk: some components express product intent that lives mostly in docs rather than current route wiring.
|
||||
- Mitigation: keep a follow-up enrichment task that cross-links module docs, contracts, and runbooks before final retirement decisions.
|
||||
- Evidence snapshot: first pass produced 167 `dead` components and 136 `weak-route` components, each with a markdown dossier for later enrichment.
|
||||
|
||||
## Next Checkpoints
|
||||
- 2026-03-08: Preservation-map scaffold and initial inventory complete.
|
||||
- 2026-03-09: First-pass recommendations written for all inventoried components.
|
||||
- 2026-03-10: Summary tree reviewed and next-pass deep-dive list cut.
|
||||
Reference in New Issue
Block a user