docs: normalize docs md iii sprint header
This commit is contained in:
StellaOps Bot
@@ -1,75 +1,76 @@
|
||||
# Sprint 0303_0001_0001 · Documentation & Process · Docs Tasks Md III
|
||||
|
||||
## Topic & Scope
|
||||
- Phase Md.III of the docs ladder: console observability/forensics docs and exception-handling doc set.
|
||||
- Keep outputs deterministic (hash-listed fixtures, reproducible captures) and ready for offline packaging.
|
||||
- **Working directory:** `docs/` (module guides, governance, console docs; any fixtures under `docs/assets/**`).
|
||||
|
||||
## Dependencies & Concurrency
|
||||
- Upstream deps: Sprint 200.A Docs Tasks Md.II hand-off; Console observability UX assets and deterministic sample data; Governance/Exceptions contracts and routing matrix; Exception API definitions.
|
||||
- Concurrency: Later Md phases (304–309) remain queued; avoid back edges. Coordinate with console/exception feature sprints but keep doc scope self-contained.
|
||||
|
||||
## Documentation Prerequisites
|
||||
- `docs/README.md`
|
||||
- `docs/modules/platform/architecture-overview.md`
|
||||
- `docs/AGENTS.md` (docs working agreement)
|
||||
- Console module dossier for observability widgets (when provided)
|
||||
- Governance/Exceptions specifications (when provided)
|
||||
|
||||
> **BLOCKED Tasks:** Before working on BLOCKED tasks, review [BLOCKED_DEPENDENCY_TREE.md](./BLOCKED_DEPENDENCY_TREE.md) for root blockers and dependencies.
|
||||
|
||||
## Delivery Tracker
|
||||
| # | Task ID | Status | Key dependency / next step | Owners | Task Definition |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| 1 | DOCS-ATTEST-75-001 | DONE (2025-11-25) | — | Docs Guild · Export Attestation Guild | Add `/docs/modules/attestor/airgap.md` for attestation bundles. |
|
||||
| 2 | DOCS-ATTEST-75-002 | DONE (2025-11-25) | — | Docs Guild · Security Guild | Update `/docs/security/aoc-invariants.md` with attestation invariants. |
|
||||
| 3 | DOCS-CLI-41-001 | DONE (2025-11-25) | — | Docs Guild · DevEx/CLI Guild | Publish CLI overview/configuration/output-and-exit-codes guides under `docs/modules/cli/guides/`. |
|
||||
| 4 | DOCS-CLI-42-001 | DONE (2025-11-25) | DOCS-CLI-41-001 | Docs Guild | Publish `parity-matrix.md` and command guides under `docs/modules/cli/guides/commands/` (policy, sbom, vuln, vex, advisory, export, orchestrator, notify, aoc, auth). |
|
||||
| 5 | DOCS-CLI-OBS-52-001 | DONE (2025-11-25) | — | Docs Guild · DevEx/CLI Guild | Create `/docs/modules/cli/guides/observability.md` (stella obs commands, exit codes, scripting). |
|
||||
| 6 | DOCS-CLI-FORENSICS-53-001 | DONE (2025-11-25) | — | Docs Guild · DevEx/CLI Guild | Publish `/docs/modules/cli/guides/forensics.md` with snapshot/verify/attest flows and offline guidance. |
|
||||
| 7 | DOCS-CONTRIB-62-001 | DONE (2025-11-25) | — | Docs Guild · API Governance Guild | Publish `/docs/contributing/api-contracts.md` (OAS edit/lint/compat rules). |
|
||||
| 8 | DOCS-DEVPORT-62-001 | DONE (2025-11-25) | — | Docs Guild · Developer Portal Guild | Document `/docs/devportal/publishing.md` for build pipeline and offline bundle steps. |
|
||||
| 9 | DOCS-CONSOLE-OBS-52-001 | BLOCKED (2025-11-25) | Need Observability Hub widget shots + deterministic sample payloads from Console Guild; require hash list for captures. | Docs Guild · Console Guild | `/docs/console/observability.md` (widgets, trace/log search, imposed rule banner, accessibility tips). |
|
||||
| 10 | DOCS-CONSOLE-OBS-52-002 | BLOCKED (2025-11-25) | Depends on DOCS-CONSOLE-OBS-52-001 content/assets. | Docs Guild · Console Guild | `/docs/console/forensics.md` (timeline explorer, evidence viewer, attestation verifier, troubleshooting). |
|
||||
| 11 | DOCS-EXC-25-001 | BLOCKED (2025-11-25) | Await governance exception lifecycle spec + examples from Governance Guild. Stub + hash index committed to reduce rework. | Docs Guild · Governance Guild | `/docs/governance/exceptions.md` (lifecycle, scope patterns, compliance checklist). |
|
||||
| 12 | DOCS-EXC-25-002 | BLOCKED (2025-11-25) | Depends on DOCS-EXC-25-001; needs routing matrix and MFA/audit rules from Authority Core. Stub + hash index committed. | Docs Guild · Authority Core | `/docs/governance/approvals-and-routing.md` (roles, routing, audit trails). |
|
||||
| 13 | DOCS-EXC-25-003 | BLOCKED (2025-11-25) | Depends on DOCS-EXC-25-002; waiting on exception API contract. Stub + hash index committed. | Docs Guild · BE-Base Platform Guild | `/docs/api/exceptions.md` (endpoints, payloads, errors, idempotency). |
|
||||
| 14 | DOCS-EXC-25-005 | BLOCKED (2025-11-25) | Depends on DOCS-EXC-25-003 UI payloads + accessibility guidance from UI Guild. Stub + hash index committed. | Docs Guild · UI Guild | `/docs/ui/exception-center.md` (UI walkthrough, badges, accessibility). |
|
||||
| 15 | DOCS-EXC-25-006 | BLOCKED (2025-11-25) | Depends on DOCS-EXC-25-005; needs CLI command shapes + exit codes from DevEx. Stub + hash index committed. | Docs Guild · DevEx/CLI Guild | Update `/docs/modules/cli/guides/exceptions.md` (commands and exit codes). |
|
||||
|
||||
## Execution Log
|
||||
| Date (UTC) | Update | Owner |
|
||||
| --- | --- | --- |
|
||||
| 2025-12-04 | Normalised sprint to standard template and renamed to `SPRINT_0303_0001_0001_docs_tasks_md_iii.md`; legacy details preserved in Delivery Tracker; no status changes. | Project Mgmt |
|
||||
| 2025-11-25 | Delivered DOCS-CLI-41/42-001, DOCS-CLI-OBS-52-001, DOCS-CLI-FORENSICS-53-001; published CLI guides, parity matrix, observability, and forensics docs. | Docs Guild |
|
||||
| 2025-11-25 | Delivered DOCS-ATTEST-75-001/002 (attestor air-gap guide, AOC invariants); statuses mirrored to tasks-all. | Docs Guild |
|
||||
| 2025-11-25 | Delivered DOCS-DEVPORT-62-001 and DOCS-CONTRIB-62-001 (devportal publishing and API contracts docs). | Docs Guild |
|
||||
| 2025-11-23 | Migrated completed work to archive (`docs/implplan/archived/tasks.md`); retained active items in sprint. | Docs Guild |
|
||||
| 2025-11-18 | Imported task inventory from Md.II; flagged console observability and exceptions chain as BLOCKED awaiting upstream specs/assets. | Project Mgmt |
|
||||
# Sprint 0303 · Documentation & Process · Docs Tasks Md III
|
||||
|
||||
## Topic & Scope
|
||||
- Phase Md.III of the docs ladder: console observability/forensics docs and exception-handling doc set.
|
||||
- Keep outputs deterministic (hash-listed fixtures, reproducible captures) and ready for offline packaging.
|
||||
- **Working directory:** `docs/` (module guides, governance, console docs; any fixtures under `docs/assets/**`).
|
||||
|
||||
## Dependencies & Concurrency
|
||||
- Upstream deps: Sprint 200.A Docs Tasks Md.II hand-off; Console observability UX assets and deterministic sample data; Governance/Exceptions contracts and routing matrix; Exception API definitions.
|
||||
- Concurrency: Later Md phases (304–309) remain queued; avoid back edges. Coordinate with console/exception feature sprints but keep doc scope self-contained.
|
||||
|
||||
## Documentation Prerequisites
|
||||
- `docs/README.md`
|
||||
- `docs/modules/platform/architecture-overview.md`
|
||||
- `docs/AGENTS.md` (docs working agreement)
|
||||
- Console module dossier for observability widgets (when provided)
|
||||
- Governance/Exceptions specifications (when provided)
|
||||
|
||||
> **BLOCKED Tasks:** Before working on BLOCKED tasks, review [BLOCKED_DEPENDENCY_TREE.md](./BLOCKED_DEPENDENCY_TREE.md) for root blockers and dependencies.
|
||||
|
||||
## Delivery Tracker
|
||||
| # | Task ID | Status | Key dependency / next step | Owners | Task Definition |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| 1 | DOCS-ATTEST-75-001 | DONE (2025-11-25) | — | Docs Guild · Export Attestation Guild | Add `/docs/modules/attestor/airgap.md` for attestation bundles. |
|
||||
| 2 | DOCS-ATTEST-75-002 | DONE (2025-11-25) | — | Docs Guild · Security Guild | Update `/docs/security/aoc-invariants.md` with attestation invariants. |
|
||||
| 3 | DOCS-CLI-41-001 | DONE (2025-11-25) | — | Docs Guild · DevEx/CLI Guild | Publish CLI overview/configuration/output-and-exit-codes guides under `docs/modules/cli/guides/`. |
|
||||
| 4 | DOCS-CLI-42-001 | DONE (2025-11-25) | DOCS-CLI-41-001 | Docs Guild | Publish `parity-matrix.md` and command guides under `docs/modules/cli/guides/commands/` (policy, sbom, vuln, vex, advisory, export, orchestrator, notify, aoc, auth). |
|
||||
| 5 | DOCS-CLI-OBS-52-001 | DONE (2025-11-25) | — | Docs Guild · DevEx/CLI Guild | Create `/docs/modules/cli/guides/observability.md` (stella obs commands, exit codes, scripting). |
|
||||
| 6 | DOCS-CLI-FORENSICS-53-001 | DONE (2025-11-25) | — | Docs Guild · DevEx/CLI Guild | Publish `/docs/modules/cli/guides/forensics.md` with snapshot/verify/attest flows and offline guidance. |
|
||||
| 7 | DOCS-CONTRIB-62-001 | DONE (2025-11-25) | — | Docs Guild · API Governance Guild | Publish `/docs/contributing/api-contracts.md` (OAS edit/lint/compat rules). |
|
||||
| 8 | DOCS-DEVPORT-62-001 | DONE (2025-11-25) | — | Docs Guild · Developer Portal Guild | Document `/docs/devportal/publishing.md` for build pipeline and offline bundle steps. |
|
||||
| 9 | DOCS-CONSOLE-OBS-52-001 | BLOCKED (2025-11-25) | Need Observability Hub widget shots + deterministic sample payloads from Console Guild; require hash list for captures. | Docs Guild · Console Guild | `/docs/console/observability.md` (widgets, trace/log search, imposed rule banner, accessibility tips). |
|
||||
| 10 | DOCS-CONSOLE-OBS-52-002 | BLOCKED (2025-11-25) | Depends on DOCS-CONSOLE-OBS-52-001 content/assets. | Docs Guild · Console Guild | `/docs/console/forensics.md` (timeline explorer, evidence viewer, attestation verifier, troubleshooting). |
|
||||
| 11 | DOCS-EXC-25-001 | BLOCKED (2025-11-25) | Await governance exception lifecycle spec + examples from Governance Guild. Stub + hash index committed to reduce rework. | Docs Guild · Governance Guild | `/docs/governance/exceptions.md` (lifecycle, scope patterns, compliance checklist). |
|
||||
| 12 | DOCS-EXC-25-002 | BLOCKED (2025-11-25) | Depends on DOCS-EXC-25-001; needs routing matrix and MFA/audit rules from Authority Core. Stub + hash index committed. | Docs Guild · Authority Core | `/docs/governance/approvals-and-routing.md` (roles, routing, audit trails). |
|
||||
| 13 | DOCS-EXC-25-003 | BLOCKED (2025-11-25) | Depends on DOCS-EXC-25-002; waiting on exception API contract. Stub + hash index committed. | Docs Guild · BE-Base Platform Guild | `/docs/api/exceptions.md` (endpoints, payloads, errors, idempotency). |
|
||||
| 14 | DOCS-EXC-25-005 | BLOCKED (2025-11-25) | Depends on DOCS-EXC-25-003 UI payloads + accessibility guidance from UI Guild. Stub + hash index committed. | Docs Guild · UI Guild | `/docs/ui/exception-center.md` (UI walkthrough, badges, accessibility). |
|
||||
| 15 | DOCS-EXC-25-006 | BLOCKED (2025-11-25) | Depends on DOCS-EXC-25-005; needs CLI command shapes + exit codes from DevEx. Stub + hash index committed. | Docs Guild · DevEx/CLI Guild | Update `/docs/modules/cli/guides/exceptions.md` (commands and exit codes). |
|
||||
|
||||
## Execution Log
|
||||
| Date (UTC) | Update | Owner |
|
||||
| --- | --- | --- |
|
||||
| 2025-12-04 | Normalised sprint to standard template and renamed to `SPRINT_0303_0001_0001_docs_tasks_md_iii.md`; legacy details preserved in Delivery Tracker; no status changes. | Project Mgmt |
|
||||
| 2025-11-25 | Delivered DOCS-CLI-41/42-001, DOCS-CLI-OBS-52-001, DOCS-CLI-FORENSICS-53-001; published CLI guides, parity matrix, observability, and forensics docs. | Docs Guild |
|
||||
| 2025-11-25 | Delivered DOCS-ATTEST-75-001/002 (attestor air-gap guide, AOC invariants); statuses mirrored to tasks-all. | Docs Guild |
|
||||
| 2025-11-25 | Delivered DOCS-DEVPORT-62-001 and DOCS-CONTRIB-62-001 (devportal publishing and API contracts docs). | Docs Guild |
|
||||
| 2025-11-23 | Migrated completed work to archive (`docs/implplan/archived/tasks.md`); retained active items in sprint. | Docs Guild |
|
||||
| 2025-11-18 | Imported task inventory from Md.II; flagged console observability and exceptions chain as BLOCKED awaiting upstream specs/assets. | Project Mgmt |
|
||||
| 2025-12-04 | Added deterministic stubs for DOCS-CONSOLE-OBS-52-001 (`docs/console/observability.md`) and DOCS-CONSOLE-OBS-52-002 (`docs/console/forensics.md`) to lock outline and determinism checklist while awaiting assets/hashes; tasks remain BLOCKED. | Docs Guild |
|
||||
| 2025-12-04 | Added `docs/console/SHA256SUMS` placeholder to record hashes once console captures/payloads arrive; keeps determinism workflow ready. | Docs Guild |
|
||||
| 2025-12-05 | Recorded stub hash entries in `docs/console/SHA256SUMS` for observability/forensics outlines; replace with real asset hashes when provided. Tasks stay BLOCKED. | Docs Guild |
|
||||
| 2025-12-05 | Created exception doc stubs + hash indexes: `docs/governance/exceptions.md`, `docs/governance/approvals-and-routing.md`, `docs/api/exceptions.md`, `docs/ui/exception-center.md`, `docs/modules/cli/guides/exceptions.md` with SHA256SUMS placeholders. Tasks remain BLOCKED pending contracts/assets. | Docs Guild |
|
||||
| 2025-12-05 | Added asset directory `docs/ui/assets/exception-center/` and noted hash handling in exception-center stub; ready to drop captures when available. | Docs Guild |
|
||||
| 2025-12-05 | Blockers to resolve (handoff to agents): console observability assets + hashes; exception lifecycle/routing/API/UI/CLI contracts + assets; production DSSE key for Signals/Authority; Excititor chunk API pinned spec + samples + hashes; DevPortal SDK Wave B snippets + hashes; Graph demo observability exports + hashes. | Project Mgmt |
|
||||
|
||||
## Decisions & Risks
|
||||
### Decisions
|
||||
| Decision | Owner(s) | Due | Notes |
|
||||
| --- | --- | --- | --- |
|
||||
| Md.III scope fixed to console observability/forensics plus exceptions documentation chain; avoid adding new module docs until blockers clear. | Docs Guild | 2025-11-18 | Reaffirmed while importing backlog from Md.II. |
|
||||
|
||||
### Risks
|
||||
| Risk | Impact | Mitigation |
|
||||
| --- | --- | --- |
|
||||
| Console observability assets (widgets, sample data, hash list) not yet delivered. | Blocks DOCS-CONSOLE-OBS-52-001/002; delays console doc set. | Request asset drop + hashes from Console Guild; outlines/stubs now in repo to reduce rework; keep BLOCKED until fixtures arrive. |
|
||||
| Exception governance contract & routing matrix outstanding. | Blocks DOCS-EXC-25-001..006 chain; downstream CLI/UI/API docs stalled. | Ask Governance/Authority/Platform guilds for contract + API draft; keep tasks BLOCKED and mirror in `BLOCKED_DEPENDENCY_TREE.md` if escalated. |
|
||||
|
||||
## Next Checkpoints
|
||||
| Date (UTC) | Session | Goal | Owner(s) |
|
||||
| --- | --- | --- | --- |
|
||||
| TBD | Console observability asset drop | Deliver deterministic widget captures + sample payload hashes to unblock DOCS-CONSOLE-OBS-52-001/002. | Console Guild · Docs Guild |
|
||||
| TBD | Exceptions contract hand-off | Provide lifecycle/routing matrix + API contract to unblock DOCS-EXC-25-001..006. | Governance Guild · Authority Core · BE-Base Platform |
|
||||
|
||||
## Appendix
|
||||
- Legacy sprint content prior to normalization was archived at `docs/implplan/archived/tasks.md` (updated 2025-11-08).
|
||||
| 2025-12-05 | Normalised sprint header to standard template; no status changes. | Project Mgmt |
|
||||
|
||||
## Decisions & Risks
|
||||
### Decisions
|
||||
| Decision | Owner(s) | Due | Notes |
|
||||
| --- | --- | --- | --- |
|
||||
| Md.III scope fixed to console observability/forensics plus exceptions documentation chain; avoid adding new module docs until blockers clear. | Docs Guild | 2025-11-18 | Reaffirmed while importing backlog from Md.II. |
|
||||
|
||||
### Risks
|
||||
| Risk | Impact | Mitigation |
|
||||
| --- | --- | --- |
|
||||
| Console observability assets (widgets, sample data, hash list) not yet delivered. | Blocks DOCS-CONSOLE-OBS-52-001/002; delays console doc set. | Request asset drop + hashes from Console Guild; outlines/stubs now in repo to reduce rework; keep BLOCKED until fixtures arrive. |
|
||||
| Exception governance contract & routing matrix outstanding. | Blocks DOCS-EXC-25-001..006 chain; downstream CLI/UI/API docs stalled. | Ask Governance/Authority/Platform guilds for contract + API draft; keep tasks BLOCKED and mirror in `BLOCKED_DEPENDENCY_TREE.md` if escalated. |
|
||||
|
||||
## Next Checkpoints
|
||||
| Date (UTC) | Session | Goal | Owner(s) |
|
||||
| --- | --- | --- | --- |
|
||||
| TBD | Console observability asset drop | Deliver deterministic widget captures + sample payload hashes to unblock DOCS-CONSOLE-OBS-52-001/002. | Console Guild · Docs Guild |
|
||||
| TBD | Exceptions contract hand-off | Provide lifecycle/routing matrix + API contract to unblock DOCS-EXC-25-001..006. | Governance Guild · Authority Core · BE-Base Platform |
|
||||
|
||||
## Appendix
|
||||
- Legacy sprint content prior to normalization was archived at `docs/implplan/archived/tasks.md` (updated 2025-11-08).
|
||||
|
||||
Reference in New Issue
Block a user