diff --git a/docs/artifact-registry.md b/docs/artifact-registry.md index 06384b3..d62dffc 100644 --- a/docs/artifact-registry.md +++ b/docs/artifact-registry.md @@ -15,7 +15,7 @@ document of a type. `Primary File` may contain a glob (e.g. | SA | Stakeholder Analysis | docs/stakeholder-analysis.md | 002 | | PP | Project Plan | docs/project-plan.md | 002 | | MIL | Milestone / Gateway | docs/milestones/*.md | 005 | -| RC | SQA Review Record | docs/sqa/reviews/rc-*.md | 007 | +| RC | SQA Review Record | docs/sqa/reviews/rc-*.md | 011 | | TM | Traceability Matrix | docs/sqa/traceability-matrix.md | 002 | | UCD | Use Case Diagram | docs/use-case-diagram.md | 002 | | US | User Story | docs/user-stories.md | 002 | diff --git a/docs/sqa/reviews/rc-007-ucd-001.md b/docs/sqa/reviews/rc-007-ucd-001.md new file mode 100644 index 0000000..0901f90 --- /dev/null +++ b/docs/sqa/reviews/rc-007-ucd-001.md @@ -0,0 +1,47 @@ +# SQA Review Record: UCD-001 Use Case Diagram + +## Metadata +| Key | Value | +| --- | --- | +| ID | RC-007 | +| CrossReference | [UCD-001], [QC-UCD-001] | + +## Version History +| Date | Status | Author | Reviewer | Change | Commit | +| --- | --- | --- | --- | --- | --- | +| 2026-10-04 | Accepted | Jens Tirsvad Nielsen | S01 | Initial version | pending | + +--- + +## Artifact Under Review + +- Instance reviewed: [UCD-001] +- Checklist used: [QC-UCD-001] + +## Checklist Results + +| # | Criterion | Status | Evidence/Notes | +| --- | --- | --- | --- | +| 1 | Actors are defined with correct UML stereotypes (e.g. `<>`, `<>`) | Pass | Actor <> and boundary <> stereotyped. | +| 2 | System boundary is clearly drawn and labeled | Pass | Boundary rectangle labelled Higher Lower. | +| 3 | Include/extend relationships are used correctly per UML 2.5.1, not as generic "uses" arrows | Pass | No include/extend used; the Relationships section says so. | +| 4 | Every actor participates in at least one use case (no orphan actors) | Pass | Player is in Play a Game. | +| 5 | Diagram is traceable to a documented stakeholder need | Pass | Player traces to S01 and S02 in SA-001. | +| 6 | Use case names are verb phrases describing actor goals, not internal system operations | Pass | Play a Game is an actor goal. | +| 7 | Diagram is free of implementation detail (e.g. UI widgets, database tables) (Optional) | Pass | No UI or storage detail. | +| 8 | Actor and use case naming is consistent with corresponding Use Case and User Story documents (Optional) | Pass | Names match US-001 and UC-001. | + +## Overall Verdict + +Go — all applicable criteria pass. Reviewer and author are both S01: the project has a single participant, so the framework's author/reviewer separation cannot be met. S01 accepted this deviation when requesting acceptance (2026-10-04). + +## Action Items + +| Action | Owner | Due | +| --- | --- | --- | +| None | — | — | + +--- + +[UCD-001]: ../../use-case-diagram.md +[QC-UCD-001]: ../../../framework/qc/qc-use-case-diagram.md diff --git a/docs/sqa/reviews/rc-008-us-001.md b/docs/sqa/reviews/rc-008-us-001.md new file mode 100644 index 0000000..158e74a --- /dev/null +++ b/docs/sqa/reviews/rc-008-us-001.md @@ -0,0 +1,46 @@ +# SQA Review Record: US-001 User Stories + +## Metadata +| Key | Value | +| --- | --- | +| ID | RC-008 | +| CrossReference | [US-001], [QC-US-001] | + +## Version History +| Date | Status | Author | Reviewer | Change | Commit | +| --- | --- | --- | --- | --- | --- | +| 2026-10-04 | Accepted | Jens Tirsvad Nielsen | S01 | Initial version | pending | + +--- + +## Artifact Under Review + +- Instance reviewed: [US-001] +- Checklist used: [QC-US-001] + +## Checklist Results + +| # | Criterion | Status | Evidence/Notes | +| --- | --- | --- | --- | +| 1 | Follows INVEST criteria (Independent, Negotiable, Valuable, Estimable, Small, Testable) | Pass | INVEST check present, no exceptions. | +| 2 | Written in "As a / I want / So that" form | Pass | Both stories use As a / I want / so that. | +| 3 | Clear, testable acceptance criteria are included | Pass | Given/When/Then criteria on both stories. | +| 4 | Traceable to a use case or epic | Pass | Both trace to UC-001 and MIL-003. | +| 5 | Story is sized to fit within a single iteration (Optional) | Pass | Each fits one iteration. | +| 6 | Story statement avoids technical implementation detail (Optional) | Pass | Stated as player goals. | +| 7 | Role named in the story matches an actor defined in the Use Case Diagram | Pass | Role Player matches UCD-001. | + +## Overall Verdict + +Go — all applicable criteria pass. Reviewer and author are both S01: the project has a single participant, so the framework's author/reviewer separation cannot be met. S01 accepted this deviation when requesting acceptance (2026-10-04). + +## Action Items + +| Action | Owner | Due | +| --- | --- | --- | +| None | — | — | + +--- + +[US-001]: ../../user-stories.md +[QC-US-001]: ../../../framework/qc/qc-user-story.md diff --git a/docs/sqa/reviews/rc-009-uc-001.md b/docs/sqa/reviews/rc-009-uc-001.md new file mode 100644 index 0000000..11046dd --- /dev/null +++ b/docs/sqa/reviews/rc-009-uc-001.md @@ -0,0 +1,51 @@ +# SQA Review Record: UC-001 Use Case + +## Metadata +| Key | Value | +| --- | --- | +| ID | RC-009 | +| CrossReference | [UC-001], [QC-UC-001] | + +## Version History +| Date | Status | Author | Reviewer | Change | Commit | +| --- | --- | --- | --- | --- | --- | +| 2026-10-04 | Accepted | Jens Tirsvad Nielsen | S01 | Initial version | pending | + +--- + +## Artifact Under Review + +- Instance reviewed: [UC-001] +- Checklist used: [QC-UC-001] + +## Checklist Results + +| # | Criterion | Status | Evidence/Notes | +| --- | --- | --- | --- | +| 1 | Consists of a single, concise paragraph summarizing only the primary success scenario | N-A | Applies to the Brief format only; this use case is Fully Dressed. | +| 2 | Written as an informal multi-paragraph narrative; may mention some alternate flows without formal structure | N-A | Applies to the Casual format only; this use case is Fully Dressed. | +| 3 | All standard sections are present: actors, preconditions, postconditions, main success scenario, alternative/exception flows | Pass | Scope, level, actor, stakeholders, pre/postconditions, scenario, extensions, rules and open issues present. | +| 4 | Preconditions and postconditions are explicitly defined | Pass | Both defined. | +| 5 | Primary actor is explicitly stated | Pass | Player. | +| 6 | Stakeholders and their interests are stated | Pass | S01 and S02 with interests. | +| 7 | Main success scenario is written as clear, numbered steps | Pass | Seven numbered steps. | +| 8 | Alternative/exception flows correctly reference `<>`/`<>` use cases where relevant, per UML 2.5.1 | Pass | No include/extend applies; stated. | +| 9 | Explicit business rules are captured per step where applicable, rather than embedded loosely in narrative text (Optional) | Pass | Rules listed for steps 2, 3b and 5. | +| 10 | Naming of actors and use case title is consistent with the corresponding Use Case Diagram and User Stories | Pass | Title and actor match UCD-001 and US-001. | +| 11 | Scope/level (e.g. summary, user-goal, subfunction) is explicitly stated (Optional) | Pass | Level: user goal. | +| 12 | Use case is written from the actor's goal perspective, free of UI or implementation detail | Pass | Goal wording, no UI or implementation detail. | + +## Overall Verdict + +Go — all applicable criteria pass. Reviewer and author are both S01: the project has a single participant, so the framework's author/reviewer separation cannot be met. S01 accepted this deviation when requesting acceptance (2026-10-04). + +## Action Items + +| Action | Owner | Due | +| --- | --- | --- | +| None | — | — | + +--- + +[UC-001]: ../../uc-001/uc.md +[QC-UC-001]: ../../../framework/qc/qc-use-case.md diff --git a/docs/sqa/reviews/rc-010-ssd-001.md b/docs/sqa/reviews/rc-010-ssd-001.md new file mode 100644 index 0000000..8be3b79 --- /dev/null +++ b/docs/sqa/reviews/rc-010-ssd-001.md @@ -0,0 +1,46 @@ +# SQA Review Record: SSD-001 System Sequence Diagram + +## Metadata +| Key | Value | +| --- | --- | +| ID | RC-010 | +| CrossReference | [SSD-001], [QC-SSD-001] | + +## Version History +| Date | Status | Author | Reviewer | Change | Commit | +| --- | --- | --- | --- | --- | --- | +| 2026-10-04 | Accepted | Jens Tirsvad Nielsen | S01 | Initial version | pending | + +--- + +## Artifact Under Review + +- Instance reviewed: [SSD-001] +- Checklist used: [QC-SSD-001] + +## Checklist Results + +| # | Criterion | Status | Evidence/Notes | +| --- | --- | --- | --- | +| 1 | Input/output messages match the corresponding Use Case's main success scenario step-for-step | Pass | startGame and makeGuess cover steps 1 to 7 of UC-001. | +| 2 | Actor and System are treated strictly as black boxes (system shown as `:System`) | Pass | Only Player and :System. | +| 3 | Object creation/destruction of the System instance handled explicitly where relevant (Optional) | Pass | Lifecycle notes state when the game starts and ends. | +| 4 | Return values are shown for operations that produce one, using dashed return arrows | Pass | Dashed returns on every operation. | +| 5 | Alternate/exceptional flows are represented separately (or explicitly out of scope noted) | Pass | Alternative flows noted as out of scope. | +| 6 | Message names are verb phrases consistent with the use case's system responsibilities (Optional) | Pass | startGame, makeGuess. | +| 7 | Diagram references the specific Use Case (name and ID) it depicts | Pass | Cites UC-001 Play a Game. | + +## Overall Verdict + +Go — all applicable criteria pass. Reviewer and author are both S01: the project has a single participant, so the framework's author/reviewer separation cannot be met. S01 accepted this deviation when requesting acceptance (2026-10-04). + +## Action Items + +| Action | Owner | Due | +| --- | --- | --- | +| None | — | — | + +--- + +[SSD-001]: ../../uc-001/ssd.md +[QC-SSD-001]: ../../../framework/qc/qc-ssd.md diff --git a/docs/sqa/traceability-matrix.md b/docs/sqa/traceability-matrix.md index 46bd58f..fb38fd5 100644 --- a/docs/sqa/traceability-matrix.md +++ b/docs/sqa/traceability-matrix.md @@ -9,8 +9,8 @@ ## Version History | Date | Status | Author | Reviewer | Change | Commit | | --- | --- | --- | --- | --- | --- | -| 2026-10-04 | Proposed | Jens Tirsvad Nielsen | S01 | Added RC-005 review of MIL-002 | [ee58fcd] | | 2026-10-04 | Proposed | Jens Tirsvad Nielsen | S01 | Added RC-006 and the UC-001 artifacts | [923dde7] | +| 2026-10-04 | Proposed | Jens Tirsvad Nielsen | S01 | Added RC-007 to RC-010 for UCD-001, US-001, UC-001 and SSD-001 | pending | --- @@ -30,14 +30,14 @@ target is measurable. A row is added or updated whenever an artifact instance is | [MIL-002] | MIL | [BC-001], [PP-001], [MIL-001] | - | [RC-005] | | [MIL-003] | MIL | [BC-001], [PP-001], [MIL-002], [US-001] | [UC-001] | [RC-006] | | [MIL-004] | MIL | [BC-001], [PP-001] | - | - | -| [UCD-001] | UCD | [SA-001], [BC-001] | [US-001], [UC-001] | - | -| [US-001] | US | [UCD-001], [BC-001], [MIL-003] | [UC-001] | - | -| [UC-001] | UC | [UCD-001], [US-001], [SA-001] | [SSD-001] | - | -| [SSD-001] | SSD | [UC-001] | - | - | +| [UCD-001] | UCD | [SA-001], [BC-001] | [US-001], [UC-001] | [RC-007] | +| [US-001] | US | [UCD-001], [BC-001], [MIL-003] | [UC-001] | [RC-008] | +| [UC-001] | UC | [UCD-001], [US-001], [SA-001] | [SSD-001] | [RC-009] | +| [SSD-001] | SSD | [UC-001] | - | [RC-010] | ## Coverage Notes -- UCD-001, US-001, UC-001 and SSD-001 exist but are not reviewed yet. No domain model or design artifacts exist yet. +- No domain model or design artifacts exist yet. - `-` in Upstream means foundational; in Downstream, nothing is built on it yet; in Last Reviewed, no `RC-*` exists yet. --- @@ -54,10 +54,13 @@ target is measurable. A row is added or updated whenever an artifact instance is [RC-003]: ./reviews/rc-003-project-plan.md [RC-004]: ./reviews/rc-004-mil-001.md [RC-005]: ./reviews/rc-005-mil-002.md -[ee58fcd]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/014-higher_lower/commit/ee58fcdc1c9c83b0721022d623e4989591a47987 [UCD-001]: ../use-case-diagram.md [US-001]: ../user-stories.md [UC-001]: ../uc-001/uc.md [SSD-001]: ../uc-001/ssd.md [RC-006]: ./reviews/rc-006-mil-003.md [923dde7]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/014-higher_lower/commit/923dde7dc9b59d2c77eddc88336451193147c557 +[RC-007]: ./reviews/rc-007-ucd-001.md +[RC-008]: ./reviews/rc-008-us-001.md +[RC-009]: ./reviews/rc-009-uc-001.md +[RC-010]: ./reviews/rc-010-ssd-001.md diff --git a/docs/uc-001/ssd.md b/docs/uc-001/ssd.md index 64c0576..e74588e 100644 --- a/docs/uc-001/ssd.md +++ b/docs/uc-001/ssd.md @@ -4,12 +4,13 @@ | Key | Value | | --- | --- | | ID | SSD-001 | -| CrossReference | [UC-001] | +| CrossReference | [UC-001], [RC-010] | ## Version History | Date | Status | Author | Reviewer | Change | Commit | | --- | --- | --- | --- | --- | --- | -| 2026-10-04 | Proposed | Jens Tirsvad Nielsen | S01 | Initial version | [923dde7] | +| 2026-10-04 | Deprecated | Jens Tirsvad Nielsen | S01 | Initial version | [923dde7] | +| 2026-10-04 | Accepted | Jens Tirsvad Nielsen | S01 | Accepted after review RC-010 | pending | --- @@ -52,3 +53,4 @@ A game starts with `startGame` and ends when `makeGuess` returns wrong; the Syst [UC-001]: ./uc.md [923dde7]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/014-higher_lower/commit/923dde7dc9b59d2c77eddc88336451193147c557 +[RC-010]: ../sqa/reviews/rc-010-ssd-001.md diff --git a/docs/uc-001/uc.md b/docs/uc-001/uc.md index af0130f..7d73c2e 100644 --- a/docs/uc-001/uc.md +++ b/docs/uc-001/uc.md @@ -4,12 +4,13 @@ | Key | Value | | --- | --- | | ID | UC-001 | -| CrossReference | [UCD-001], [US-001], [SA-001], [SSD-001] | +| CrossReference | [UCD-001], [US-001], [SA-001], [SSD-001], [RC-009] | ## Version History | Date | Status | Author | Reviewer | Change | Commit | | --- | --- | --- | --- | --- | --- | -| 2026-10-04 | Proposed | Jens Tirsvad Nielsen | S01 | Initial version | [923dde7] | +| 2026-10-04 | Deprecated | Jens Tirsvad Nielsen | S01 | Initial version | [923dde7] | +| 2026-10-04 | Accepted | Jens Tirsvad Nielsen | S01 | Accepted after review RC-009 | pending | --- @@ -76,3 +77,4 @@ None. [SA-001]: ../stakeholder-analysis.md [SSD-001]: ./ssd.md [923dde7]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/014-higher_lower/commit/923dde7dc9b59d2c77eddc88336451193147c557 +[RC-009]: ../sqa/reviews/rc-009-uc-001.md diff --git a/docs/use-case-diagram.md b/docs/use-case-diagram.md index 962a1cf..a0ae109 100644 --- a/docs/use-case-diagram.md +++ b/docs/use-case-diagram.md @@ -4,12 +4,13 @@ | Key | Value | | --- | --- | | ID | UCD-001 | -| CrossReference | [SA-001], [BC-001], [US-001], [UC-001] | +| CrossReference | [SA-001], [BC-001], [US-001], [UC-001], [RC-007] | ## Version History | Date | Status | Author | Reviewer | Change | Commit | | --- | --- | --- | --- | --- | --- | -| 2026-10-04 | Proposed | Jens Tirsvad Nielsen | S01 | Initial version | [923dde7] | +| 2026-10-04 | Deprecated | Jens Tirsvad Nielsen | S01 | Initial version | [923dde7] | +| 2026-10-04 | Accepted | Jens Tirsvad Nielsen | S01 | Accepted after review RC-007 | pending | --- @@ -53,3 +54,4 @@ None: there is a single use case, so no `<>` or `<>` is used. [US-001]: ./user-stories.md [UC-001]: ./uc-001/uc.md [923dde7]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/014-higher_lower/commit/923dde7dc9b59d2c77eddc88336451193147c557 +[RC-007]: ./sqa/reviews/rc-007-ucd-001.md diff --git a/docs/user-stories.md b/docs/user-stories.md index d83b6a7..7d66dd1 100644 --- a/docs/user-stories.md +++ b/docs/user-stories.md @@ -4,12 +4,13 @@ | Key | Value | | --- | --- | | ID | US-001 | -| CrossReference | [UCD-001], [UC-001], [BC-001], [MIL-003] | +| CrossReference | [UCD-001], [UC-001], [BC-001], [MIL-003], [RC-008] | ## Version History | Date | Status | Author | Reviewer | Change | Commit | | --- | --- | --- | --- | --- | --- | -| 2026-10-04 | Proposed | Jens Tirsvad Nielsen | S01 | Initial version | [923dde7] | +| 2026-10-04 | Deprecated | Jens Tirsvad Nielsen | S01 | Initial version | [923dde7] | +| 2026-10-04 | Accepted | Jens Tirsvad Nielsen | S01 | Accepted after review RC-008 | pending | --- @@ -49,3 +50,4 @@ Both stories are Independent of each other in wording, Negotiable in detail, Val [BC-001]: ./business-case.md [MIL-003]: ./milestones/mil-003-console-game.md [923dde7]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/014-higher_lower/commit/923dde7dc9b59d2c77eddc88336451193147c557 +[RC-008]: ./sqa/reviews/rc-008-us-001.md