diff --git a/docs/artifact-registry.md b/docs/artifact-registry.md index a5e3564..856092f 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 | 008 | +| RC | SQA Review Record | docs/sqa/reviews/rc-*.md | 009 | | TM | Traceability Matrix | docs/sqa/traceability-matrix.md | 002 | ## Languages diff --git a/docs/business-case.md b/docs/business-case.md index 92cf811..e641079 100644 --- a/docs/business-case.md +++ b/docs/business-case.md @@ -9,8 +9,8 @@ ## Version History | Date | Status | Author | Reviewer | Change | Commit | | --- | --- | --- | --- | --- | --- | -| 2026-10-06 | Accepted | Jens Tirsvad Nielsen | S01 | Added duration constraint (RC-001 action) | [8ef00aa] | -| 2026-10-06 | Proposed | Jens Tirsvad Nielsen | S01 | Added objective 6 and scope for code review and CI | [8ef00aa] | +| 2026-10-06 | Deprecated | Jens Tirsvad Nielsen | S01 | Added objective 6 and scope for code review and CI | [8ef00aa] | +| 2026-10-06 | Accepted | Jens Tirsvad Nielsen | S01 | Added success criterion 6 and clarified the Python version (RC-008 actions) | [71a27dd] | --- @@ -92,6 +92,7 @@ professional project hygiene, and the goal of sharing readable solutions. | 3 | Runtime dependencies | 0 | `pyproject.toml` `dependencies` is empty | | 4 | Setup documented | A new reader can run program and tests from README | README walkthrough | | 5 | Repository metadata | Description and at least 3 topics set | Repository page | +| 6 | Code reviewed and checked automatically | Source review record with verdict Go; latest CI run on `main` green | `docs/sqa/reviews/` and the CI run on the git host | ## Risks @@ -108,7 +109,7 @@ professional project hygiene, and the goal of sharing readable solutions. ## Constraints -- Python greater than 3.13 as requested, `venv` for environments, pytest for tests. +- Python 3.13 or newer (the request says "greater than 3.13"; read as `>=3.13`), `venv` for environments, pytest for tests. - Constants live in `constants.py`. - Source files use Doxygen comments. - Nothing is committed or pushed unless the user asks. @@ -136,3 +137,4 @@ Proceed — the scope is small, well specified and delivers a reusable example. [SA-001]: ./stakeholder-analysis.md [8ef00aa]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/015-coffee_machine/commit/8ef00aafaaa193ea565f1a45238d31e963a5e05d +[71a27dd]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/015-coffee_machine/commit/71a27ddc1f5555c1b836b1556fab292ebc9deb62 diff --git a/docs/sqa/reviews/rc-008-business-case-v3.md b/docs/sqa/reviews/rc-008-business-case-v3.md new file mode 100644 index 0000000..40177ed --- /dev/null +++ b/docs/sqa/reviews/rc-008-business-case-v3.md @@ -0,0 +1,52 @@ +# RC-008 Business Case v3 Review + +## Metadata +| Key | Value | +| --- | --- | +| ID | RC-008 | +| CrossReference | [BC-001], [QC-BC-001] | + +## Version History +| Date | Status | Author | Reviewer | Change | Commit | +| --- | --- | --- | --- | --- | --- | +| 2026-10-06 | Proposed | Jens Tirsvad Nielsen | S01 | Initial version | [861edbf] | + +--- + +## Artifact Under Review + +- Instance reviewed: [BC-001] (docs/business-case.md, version 3 as reviewed; version 4 after the actions below) +- Checklist used: [QC-BC-001] (`QC-BC-001`) +- Independence: S01 is the only stakeholder and is also the recorded author, so the reviewer-is-not-author rule cannot be met. The document was written by Claude on S01's behalf; S01 reviews and signs. This is a known limit of a one-person project, not a clean independent review. +- This record re-reviews the Business Case after version 3 added objective 6 and scope for code review and CI. It follows [RC-001], which reviewed version 2. + +## Checklist Results + +| # | Criterion | Status | Evidence/Notes | +| --- | --- | --- | --- | +| 1 | ROI/Cost-Benefit analysis is quantitative, or where qualitative, is explicitly justified | Pass | Cost-Benefit table is explicitly qualitative and says why. | +| 2 | Risks are identified with documented impact and mitigation | Pass | Three risks, each with impact and mitigation. No new risk comes from objective 6. | +| 3 | Success criteria are measurable, stating explicit targets rather than vague aspirations | Pass | Fixed in v4: objective 6 (review and CI) had no success criterion. Criterion 6 now has a target and a measure; criteria 1 to 6 are all measurable. | +| 4 | Scope explicitly separates In Scope vs Out of Scope | Pass | `### In Scope` and `### Out of Scope` are separate; v3 added the review and CI line to In Scope and nothing contradicts Out of Scope. | +| 5 | Stakeholders are cross-referenced to Stakeholder Analysis IDs rather than re-described inline | Pass | Stakeholders table cites S01 to S03 only. | +| 6 | Methodology and quality-standard foundation are stated explicitly (e.g. ISO/IEC 25010, Larman) | Pass | Methodology section names the framework, ISO/IEC 25010:2023 and the coding conventions. | +| 7 | Assumptions and constraints are explicit and clearly distinguished from one another | Pass | Fixed in v4: the Assumption said "3.13 or newer" but the Constraint said "greater than 3.13". The Constraint now states the reading (`>=3.13`). The duration constraint added after RC-001 is still present. | +| 8 | Document supports executive decision-making with a clear, unambiguous recommendation | Pass | Recommendation is a single "Proceed" with a reason. | + +## Overall Verdict + +Go — all mandatory criteria pass. Two defects were found in version 3 (no success criterion for objective 6; conflicting wording of the Python version) and fixed in the same change as BC-001 v4. + +## Action Items + +| Action | Owner | Due | +| --- | --- | --- | +| Add success criterion 6 for objective 6 (done in v4) | S01 | 2026-10-06 | +| State the Python version reading in the constraint (done in v4) | S01 | 2026-10-06 | + +--- + +[BC-001]: ../../business-case.md +[QC-BC-001]: ../../../framework/qc/qc-business-case.md +[RC-001]: ./rc-001-business-case.md +[861edbf]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/015-coffee_machine/commit/861edbfa92ed8b28b018c44ffd05a0b1eed035b5 diff --git a/docs/sqa/traceability-matrix.md b/docs/sqa/traceability-matrix.md index 3f1c651..4911c7e 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-06 | Proposed | Jens Tirsvad Nielsen | S01 | Added MIL-004 | [8ef00aa] | | 2026-10-06 | Proposed | Jens Tirsvad Nielsen | S01 | Added RC-006, RC-007 and the source code row | [00d47e2] | +| 2026-10-06 | Proposed | Jens Tirsvad Nielsen | S01 | Business Case last reviewed in RC-008 | [71a27dd] | --- @@ -25,7 +25,7 @@ artifact instance is created or reviewed. | Artifact Instance | Type | Upstream (Backward Link) | Downstream (Forward Link) | Last Reviewed (RC-ID) | | --- | --- | --- | --- | --- | | [SA-001] | Stakeholder Analysis | - | [BC-001] | [RC-002] | -| [BC-001] | Business Case | [SA-001] | [PP-001], [MIL-001], [MIL-002], [MIL-003], [MIL-004] | [RC-001] | +| [BC-001] | Business Case | [SA-001] | [PP-001], [MIL-001], [MIL-002], [MIL-003], [MIL-004] | [RC-008] | | [PP-001] | Project Plan | [BC-001], [SA-001] | [MIL-001], [MIL-002], [MIL-003], [MIL-004] | - | | [MIL-001] | Milestone | [BC-001], [PP-001] | - | [RC-003] | | [MIL-002] | Milestone | [BC-001], [PP-001] | - | [RC-004] | @@ -48,12 +48,12 @@ artifact instance is created or reviewed. [MIL-002]: ../milestones/mil-002-coffee-machine-core.md [MIL-003]: ../milestones/mil-003-quality-and-publication.md [MIL-004]: ../milestones/mil-004-code-review-and-ci.md -[RC-001]: ./reviews/rc-001-business-case.md [RC-002]: ./reviews/rc-002-stakeholder-analysis.md [RC-003]: ./reviews/rc-003-mil-001.md [RC-004]: ./reviews/rc-004-mil-002.md [RC-005]: ./reviews/rc-005-mil-003.md [RC-006]: ./reviews/rc-006-source-code.md [RC-007]: ./reviews/rc-007-mil-004.md -[8ef00aa]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/015-coffee_machine/commit/8ef00aafaaa193ea565f1a45238d31e963a5e05d +[RC-008]: ./reviews/rc-008-business-case-v3.md [00d47e2]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/015-coffee_machine/commit/00d47e244c82007bbc55e18312649189b175ec10 +[71a27dd]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/015-coffee_machine/commit/71a27ddc1f5555c1b836b1556fab292ebc9deb62