94 lines
6.4 KiB
Markdown
94 lines
6.4 KiB
Markdown
# Quickstart: Cross-Domain Progress Indicator Semantics Audit
|
|
|
|
**Date**: 2026-05-06
|
|
**Branch**: `278-cross-domain-indicator-audit`
|
|
|
|
This quickstart is the intended reviewer flow after implementation of the audit package. It stays bounded to repository audit artifacts, standards-delta input, and follow-up-lane separation. No application code, migrations, runtime tests, or UI implementation belong in this slice.
|
|
|
|
## Prerequisites
|
|
|
|
1. Work from the `278-cross-domain-indicator-audit` branch with the package artifacts under `specs/278-cross-domain-indicator-audit/` present.
|
|
2. Treat `docs/product/spec-candidates.md`, `docs/product/roadmap.md`, `docs/ui/tenantpilot-enterprise-ui-standards.md`, and the named code anchors as the only source corpus for the audit.
|
|
3. Keep the slice docs and governance first. Do not change files under `apps/platform/tests/`, do not add app code, and do not widen into runtime component or migration work.
|
|
4. Keep related Specs `266`, `268`, `270`, `271`, and `272` as context-only guardrails.
|
|
5. Review the implemented outputs: `inventory.md`, `follow-up-map.md`, and `standards-delta.md`.
|
|
|
|
## Scenario 1: Review inventory coverage across the named anchors
|
|
|
|
1. Open `specs/278-cross-domain-indicator-audit/inventory.md`.
|
|
2. Confirm it covers the named source anchors from the spec and any additional indicator-like cues found through bounded repo search.
|
|
3. Confirm every visible cue records:
|
|
- source path or anchor
|
|
- surface and domain
|
|
- visible wording or pattern
|
|
- data basis and calculation basis
|
|
- semantic category
|
|
- determinism, scope mode, and audience mode when relevant
|
|
- misunderstanding risk
|
|
- one bounded disposition
|
|
4. Confirm visually similar cues are allowed to land in different categories when the underlying truth differs.
|
|
|
|
## Scenario 2: Review the derived standards delta
|
|
|
|
1. Open `specs/278-cross-domain-indicator-audit/standards-delta.md`.
|
|
2. Confirm it states the allowed categories and the anti-patterns that should not pass future review.
|
|
3. Confirm it explicitly covers:
|
|
- determinate-progress eligibility
|
|
- freshness and direction rules
|
|
- customer-safe wording constraints
|
|
- dashboard and summary-surface constraints
|
|
- provider-boundary notes where provider-owned cues are examples, not platform-core defaults
|
|
4. Confirm the standards delta targets `docs/ui/tenantpilot-enterprise-ui-standards.md` without pretending to implement runtime UI in the same slice.
|
|
|
|
## Scenario 3: Review follow-up-lane separation
|
|
|
|
1. Open `specs/278-cross-domain-indicator-audit/follow-up-map.md`.
|
|
2. Confirm later work is split into the following separate lanes:
|
|
- standards patch lane
|
|
- metric/indicator contract foundation
|
|
- shared indicator component system
|
|
- quality gate lane
|
|
- domain migration lane
|
|
3. Confirm no cue is left with a vague "future cleanup" recommendation.
|
|
4. Confirm the package does not collapse these lanes into one broad runtime rewrite.
|
|
|
|
## Scenario 4: Verify docs-only boundaries
|
|
|
|
1. Confirm the package outputs live in `specs/278-cross-domain-indicator-audit/` and point to future documentation targets where needed.
|
|
2. Confirm the named runtime anchors are treated as source surfaces only.
|
|
3. Confirm no app code, tests, routes, assets, panel wiring, global-search behavior, or provider registration changes were introduced.
|
|
4. Confirm the package does not reopen Specs `266`, `268`, `270`, `271`, or `272` as implementation scope.
|
|
|
|
## Targeted Validation Commands
|
|
|
|
Use this implementation-phase command set after the audit outputs are created.
|
|
|
|
```bash
|
|
export PATH="/bin:/usr/bin:/usr/local/bin:$PATH" && git diff --check -- specs/278-cross-domain-indicator-audit/spec.md specs/278-cross-domain-indicator-audit/plan.md specs/278-cross-domain-indicator-audit/research.md specs/278-cross-domain-indicator-audit/data-model.md specs/278-cross-domain-indicator-audit/quickstart.md specs/278-cross-domain-indicator-audit/checklists/requirements.md specs/278-cross-domain-indicator-audit/contracts/cross-domain-indicator-audit.logical.openapi.yaml specs/278-cross-domain-indicator-audit/tasks.md specs/278-cross-domain-indicator-audit/inventory.md specs/278-cross-domain-indicator-audit/follow-up-map.md specs/278-cross-domain-indicator-audit/standards-delta.md docs/ui/tenantpilot-enterprise-ui-standards.md docs/product/spec-candidates.md docs/product/roadmap.md
|
|
|
|
export PATH="/bin:/usr/bin:/usr/local/bin:$PATH" && git diff -- specs/278-cross-domain-indicator-audit docs/ui/tenantpilot-enterprise-ui-standards.md docs/product/spec-candidates.md docs/product/roadmap.md
|
|
|
|
export PATH="/bin:/usr/bin:/usr/local/bin:$PATH" && rg -n -- "standards patch lane|metric/indicator contract foundation|shared indicator component system|quality gate lane|domain migration lane" specs/278-cross-domain-indicator-audit/spec.md specs/278-cross-domain-indicator-audit/plan.md specs/278-cross-domain-indicator-audit/research.md specs/278-cross-domain-indicator-audit/data-model.md specs/278-cross-domain-indicator-audit/quickstart.md specs/278-cross-domain-indicator-audit/checklists/requirements.md specs/278-cross-domain-indicator-audit/tasks.md specs/278-cross-domain-indicator-audit/inventory.md specs/278-cross-domain-indicator-audit/follow-up-map.md specs/278-cross-domain-indicator-audit/standards-delta.md docs/ui/tenantpilot-enterprise-ui-standards.md docs/product/spec-candidates.md docs/product/roadmap.md
|
|
```
|
|
|
|
## Implemented Output Checklist
|
|
|
|
- `inventory.md` inventories named anchors and confirmed additional in-scope cues from bounded search.
|
|
- `follow-up-map.md` keeps standards, contract, component, quality-gate, and migration lanes separate.
|
|
- `standards-delta.md` records the distilled rules applied to the UI standards document.
|
|
- `docs/product/spec-candidates.md` and `docs/product/roadmap.md` reference the five-lane follow-up posture.
|
|
- No runtime Laravel, Filament, Livewire, provider, asset, migration, route, authorization, or test files are implementation targets for this slice.
|
|
|
|
## Out-of-Scope Confirmations
|
|
|
|
While reviewing this package, confirm that it does not add or imply:
|
|
|
|
- application-code changes under `apps/platform/`
|
|
- test additions or changes under `apps/platform/tests/`
|
|
- a shared metric or indicator contract implementation
|
|
- a shared indicator component implementation
|
|
- quality-gate code or guard-test implementation
|
|
- domain migration work
|
|
- analytics, charting, or score recalculation work
|
|
- panel, provider, asset, route, or global-search changes
|