Write and accept the brief use cases for the P1 candidates (UCD-001, US-001, UC-001 to UC-004) #65

Merged
Tirsvad merged 2 commits from mil-002-use-cases into main 2026-10-10 07:07:15 +02:00
Owner

Writes and accepts the brief use cases for the P1 candidates (MIL-002 task 1, issue #8).

Why more than four use cases

The framework requires a use case diagram and user stories before use cases (the issue says so and new-artifact.sh enforces it), so the three layers are written in order.

Added

  • UCD-001 (docs/use-case-diagram.md): system boundary "Reusable Workflow Collection"; actors DevOps Professional (S05), Platform Operator (S03), and Gitea and GitHub as <<System>> actors; one <<include>> (Onboard a Repository includes Configure Workflow Credentials) and one <<extend>> (Diagnose a Failed Workflow extends Synchronize Repository Metadata), each justified.
  • US-001 (docs/user-stories.md): eight stories (US-001.01 to US-001.08), two per use case, with Given/When/Then criteria, traces to UC and MIL-002, and an INVEST check.
  • UC-001 to UC-004 (docs/uc-001/ to docs/uc-004/): Synchronize Repository Metadata, Configure Workflow Credentials, Onboard a Repository, Diagnose a Failed Workflow, in Brief format.
  • Registry rows for UCD, US and UC; PP-001's Open Issues line ("neither exists yet") replaced.

Review (S01 standing in as ADR-0002 records; no independent reader)

  • RC-019 UCD-001 (QC-UCD-001): 8 of 8 Pass, Go.
  • RC-020 US-001 (QC-US-001): 7 of 7 Pass, Go.
  • RC-021 to RC-024 UC-001 to UC-004 (QC-UC-001, Brief): all applicable criteria pass, Go. One finding each, fixed in the review: a Brief use case may describe only the main success scenario, and each paragraph also described alternatives; those are covered by the stories' acceptance criteria. Criteria for numbered steps, extensions and per-step rules are N-A for the Brief format.
  • RC-025 PP-001 (validated against the BC and the milestones, as no plan checklist exists): 7 of 7 Pass, Go. One finding fixed: the Open Issues item said the documents "need review".
  • TM-001 lists the six documents and RC-019 to RC-025; the registry's next RC is 026. Names were checked mechanically: all four use case titles and both story roles match UCD-001.

Not covered

The P2 and P3 candidates have no use case document. Fully dressed versions, SSDs and a domain model are not written.

Closes #8

Writes and accepts the brief use cases for the P1 candidates (MIL-002 task 1, issue #8). ## Why more than four use cases The framework requires a use case diagram and user stories before use cases (the issue says so and `new-artifact.sh` enforces it), so the three layers are written in order. ## Added - **UCD-001** (`docs/use-case-diagram.md`): system boundary "Reusable Workflow Collection"; actors DevOps Professional (S05), Platform Operator (S03), and Gitea and GitHub as `<<System>>` actors; one `<<include>>` (Onboard a Repository includes Configure Workflow Credentials) and one `<<extend>>` (Diagnose a Failed Workflow extends Synchronize Repository Metadata), each justified. - **US-001** (`docs/user-stories.md`): eight stories (US-001.01 to US-001.08), two per use case, with Given/When/Then criteria, traces to UC and MIL-002, and an INVEST check. - **UC-001 to UC-004** (`docs/uc-001/` to `docs/uc-004/`): Synchronize Repository Metadata, Configure Workflow Credentials, Onboard a Repository, Diagnose a Failed Workflow, in Brief format. - Registry rows for UCD, US and UC; PP-001's Open Issues line ("neither exists yet") replaced. ## Review (S01 standing in as ADR-0002 records; no independent reader) - **RC-019** UCD-001 (QC-UCD-001): 8 of 8 Pass, Go. - **RC-020** US-001 (QC-US-001): 7 of 7 Pass, Go. - **RC-021 to RC-024** UC-001 to UC-004 (QC-UC-001, Brief): all applicable criteria pass, Go. One finding each, fixed in the review: a Brief use case may describe only the main success scenario, and each paragraph also described alternatives; those are covered by the stories' acceptance criteria. Criteria for numbered steps, extensions and per-step rules are N-A for the Brief format. - **RC-025** PP-001 (validated against the BC and the milestones, as no plan checklist exists): 7 of 7 Pass, Go. One finding fixed: the Open Issues item said the documents "need review". - TM-001 lists the six documents and RC-019 to RC-025; the registry's next RC is 026. Names were checked mechanically: all four use case titles and both story roles match UCD-001. ## Not covered The P2 and P3 candidates have no use case document. Fully dressed versions, SSDs and a domain model are not written. Closes #8
Tirsvad added 2 commits 2026-10-10 07:05:16 +02:00
Add the use case diagram UCD-001, the user stories US-001 and the brief use
cases UC-001 to UC-004 (Synchronize Repository Metadata, Configure Workflow
Credentials, Onboard a Repository, Diagnose a Failed Workflow). Review and
accept them (RC-019 to RC-024) and the PP-001 row that records them
(RC-025), and update TM-001 and the registry.

Task: MIL-002#1
Resolve pending commit links in the use case documents and review records
Validate workflows / validate (pull_request) Successful in 17s
dc572470e7
Tirsvad merged commit 5608630d3d into main 2026-10-10 07:07:15 +02:00
Tirsvad deleted branch mil-002-use-cases 2026-10-10 07:07:15 +02:00
Sign in to join this conversation.