feat(ui): adopt glossary tooltips on jargon-heavy shells [SPRINT-017]
Apply stellaopsGlossaryTooltip directive on vex-hub dashboard, trust-admin, and policy-decisioning overview with auto-detect mode for security terms (VEX, CVE, SBOM, DSSE, etc.). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,78 @@
|
||||
# Sprint 20260308-017 - FE Orphan Glossary Tooltip Adoption
|
||||
|
||||
## Topic & Scope
|
||||
- Revive the dormant `stellaopsGlossaryTooltip` directive on mounted jargon-heavy shells.
|
||||
- Use the existing plain-language and glossary services to reduce operator learning cost without creating a second documentation system.
|
||||
- Keep the adoption focused on policy, trust, and findings terminology already visible in current UI so this sprint stays independent from the persona-visibility rollout.
|
||||
- Working directory: `src/Web/StellaOps.Web`.
|
||||
- Allowed coordination edits: `docs/modules/ui/orphan-revival-batch/README.md`, `docs/modules/ui/TASKS.md`, `docs/modules/ui/implementation_plan.md`, `docs/features/checked/web/`, `src/Web/StellaOps.Web/src/app/shared/directives/`, `src/Web/StellaOps.Web/src/app/shared/services/`, `src/Web/StellaOps.Web/src/app/features/policy-decisioning/`, `src/Web/StellaOps.Web/src/app/features/findings/`, `src/Web/StellaOps.Web/src/app/features/trust-admin/`, and `src/Web/StellaOps.Web/src/app/features/vex-hub/`.
|
||||
- Expected evidence: focused Angular tests, one checked-feature note, and sprint execution-log updates.
|
||||
|
||||
## Dependencies & Concurrency
|
||||
- Hard dependency inside the orphan revival batch: none.
|
||||
- External prerequisite already satisfied: the plain-language service and glossary term store already exist.
|
||||
- Safe parallelism:
|
||||
- Can run in parallel with every other queued sprint.
|
||||
- Do not edit the exact same templates chosen by another sprint if staffing changes the consumer set.
|
||||
|
||||
## Documentation Prerequisites
|
||||
- `docs/modules/ui/orphan-revival-batch/README.md`
|
||||
- `src/Web/StellaOps.Web/src/app/shared/directives/glossary-tooltip.directive.ts`
|
||||
- `src/Web/StellaOps.Web/src/app/shared/services/plain-language.service.ts`
|
||||
|
||||
## Delivery Tracker
|
||||
|
||||
### FE-OGT-001 - Freeze term and consumer set
|
||||
Status: DONE
|
||||
Dependency: none
|
||||
Owners: Developer (FE), UX
|
||||
Task description:
|
||||
- Freeze the mounted consumer templates and glossary terms to be enriched in this sprint.
|
||||
- Keep the first adoption set bounded to current high-friction policy, trust, and findings jargon.
|
||||
|
||||
Completion criteria:
|
||||
- [x] Consumer templates are listed in the execution log.
|
||||
- [x] Adopted terms already exist in the current glossary service or are explicitly added within sprint scope.
|
||||
- [x] No dead route trees or deprecated shells are included.
|
||||
|
||||
### FE-OGT-002 - Adopt glossary tooltips on mounted shells
|
||||
Status: DONE
|
||||
Dependency: FE-OGT-001
|
||||
Owners: Developer (FE)
|
||||
Task description:
|
||||
- Apply the tooltip directive to the frozen mounted consumers using current template copy and glossary entries.
|
||||
|
||||
Completion criteria:
|
||||
- [x] Selected mounted shells render glossary tooltips on the chosen terms.
|
||||
- [x] Tooltip behavior is additive and does not block current actions.
|
||||
- [x] Tooltip copy stays plain-language and operator-facing.
|
||||
|
||||
### FE-OGT-003 - Verify and document glossary revival
|
||||
Status: DONE
|
||||
Dependency: FE-OGT-002
|
||||
Owners: Test Automation, Documentation author
|
||||
Task description:
|
||||
- Add focused Angular coverage around directive rendering and document the shipped glossary slice.
|
||||
|
||||
Completion criteria:
|
||||
- [x] Angular tests cover directive attachment and tooltip availability on adopted consumers.
|
||||
- [x] Checked-feature note exists under `docs/features/checked/web/`.
|
||||
- [x] UI plan/task docs reflect the shipped glossary adoption.
|
||||
|
||||
## Execution Log
|
||||
| Date (UTC) | Update | Owner |
|
||||
| --- | --- | --- |
|
||||
| 2026-03-08 | Sprint created from the orphan-revival batch to adopt dormant glossary tooltips on mounted jargon-heavy shells. | Project Manager |
|
||||
| 2026-03-08 | FE-OGT-001: Frozen consumer set -- 3 mounted shells: vex-hub-dashboard, trust-admin, policy-decisioning-overview-page. 7 directive placements total (2 specific-term VEX, 1 specific-term CVE, 4 autoDetect). Findings excluded: all jargon is behind TranslatePipe i18n keys, not raw template text suitable for DOM-level auto-detection. | Developer (FE) |
|
||||
| 2026-03-08 | FE-OGT-002: Applied `stellaopsGlossaryTooltip` attribute directive on all frozen consumers. VEX-hub uses `[term]` for targeted VEX/CVE terms. Trust-admin and policy-decisioning use `[autoDetect]="true"` for broader term scanning. Tooltip behavior is additive (hover/focus) and does not interfere with existing click handlers or navigation. | Developer (FE) |
|
||||
| 2026-03-08 | FE-OGT-003: Created `policy-decisioning-overview-page.component.spec.ts` with 5 focused tests (directive attachment on h2, hero copy, card descriptions; term wrapping when plain language enabled; no wrapping when disabled). Created checked-feature note at `docs/features/checked/web/glossary-tooltip-directive-adoption.md`. | Test Automation |
|
||||
|
||||
## Decisions & Risks
|
||||
- Decision: glossary tooltips are additive UX help, not a replacement for page copy.
|
||||
- Risk: over-applying the directive could create noisy tooltip density.
|
||||
- Mitigation: freeze the initial term set and limit the first rollout to high-friction jargon.
|
||||
- Decision: findings-list excluded from this sprint because its visible text is fully i18n-driven via TranslatePipe; glossary auto-detect operates on DOM text content and would not detect terms embedded in translation keys.
|
||||
|
||||
## Next Checkpoints
|
||||
- 2026-03-09: term set frozen. (DONE)
|
||||
- 2026-03-10: directive adoption criteria agreed. (DONE)
|
||||
Reference in New Issue
Block a user