Tirsvad-Udemy-100-days-of-code/018-hirst-painting
1
0
Fork 0
Code Issues 6 Pull Requests Actions Packages Projects Releases Wiki Activity

Plan the Hirst painting project and review the plan documents

Browse Source 
Add the Business Case (BC-001), Stakeholder Analysis (SA-001), Project Plan
(PP-001) and two milestones: MIL-001 Colour Palette and MIL-002 Spot Painting.
Record their reviews as RC-001 to RC-004 (all Go, self-review accepted by S01).

The PO language is English and the domain is IT. The milestones and their 13
tasks are synced as Gitea milestones 68 and 69 and issues #1 to #13.
This commit is contained in:
Tirsvad
2026-10-07 23:49:16 +08:00
parent 7c0ed0dcc5
commit b823d1f405
10 changed files with 866 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sqa/reviews/rc-001-business-case.md
+73
View File
@@ -0,0 +1,73 @@
# Review Record: Business Case BC-001
## Metadata
| Key | Value |
| --- | --- |
| ID | RC-001 |
| CrossReference | [BC-001], [SA-001], [QC-BC-001], [QC-LANG-001] |
## Version History
| Date | Status | Author | Reviewer | Change | Commit |
| --- | --- | --- | --- | --- | --- |
| 2026-10-07 | Accepted | Jens Tirsvad Nielsen | S01 | Initial version (draft prepared by the assistant for S01 to confirm)<br>Self-review and defaults confirmed by S01 | pending |
---
## Artifact Under Review
- Instance reviewed: [BC-001]
- Checklist used: [QC-BC-001], together with [QC-LANG-001] because the Business Case is written in the PO language
- Scope: full review
- Language and domain: en / it (the artifact's Metadata rows)
- Language reviewer: none. S01 reads English and knows the IT domain. S01 is also the author; S01 accepted a documented self-review on 2026-10-07 (Action Item 1)
**Status of this record:** final. The assistant read the document against
every criterion and recorded what it found; S01 confirmed the open points on
2026-10-07 and the verdict is `Go`.
## Checklist Results
| # | Criterion | Status | Evidence/Notes |
| --- | --- | --- | --- |
| 1 | ROI/Cost-Benefit analysis is quantitative, or where qualitative, is explicitly justified | Pass | Cost–Benefit Assessment states it is qualitative "on purpose: this is a learning exercise with no revenue, so a monetary return would be invented", and lists costs and benefits |
| 2 | Risks are identified with documented impact and mitigation | Pass | Risks table has 6 rows; each has an Impact and a Mitigation |
| 3 | Success criteria are measurable, stating explicit targets rather than vague aspirations | Pass | SC1 to SC7 each have a target and a measure. SC3 (colour threshold 240) and SC6 (30 seconds) were confirmed by S01 on 2026-10-07 (Action Item 3) |
| 4 | Scope explicitly separates In Scope vs Out of Scope | Pass | `### In Scope` and `### Out of Scope` subsections, with distinct content |
| 5 | Stakeholders are cross-referenced to Stakeholder Analysis IDs rather than re-described inline | Pass | Stakeholders table cites S01 and says roles are in [SA-001]. Prose refers to S01 by ID, not by role |
| 6 | Methodology and quality-standard foundation are stated explicitly (e.g. ISO/IEC 25010, Larman) | Pass | "Methodological and Standards Foundation" names the plan-first workflow, Larman, ISO/IEC 25010:2023 and `qc-programming-python` |
| 7 | Assumptions and constraints are explicit and clearly distinguished from one another | Pass | Separate `## Assumptions` and `## Constraints` lists. The one-week timeline is an assumption, confirmed by S01 on 2026-10-07 (Action Item 3) |
| 8 | Document supports executive decision-making with a clear, unambiguous recommendation | Pass | Recommendation is a single "Proceed" with a one-sentence rationale |
## Language and Domain Results
| # | Criterion | Status | Evidence/Notes |
| --- | --- | --- | --- |
| 1 | The Metadata table has a `Language` row and a `Domain` row, and neither is a placeholder | Pass | The `Language` row says `en` and the `Domain` row says `it`; `check-languages.sh --list` reports both |
| 2 | `Language` is a BCP 47 code and `Domain` is a value from the registry's domain list | Pass | `en` is a BCP 47 code; `it` is in the registry's domain list ("Software and IT") |
| 3 | The content (prose and table cells) is written in the stated language | Pass | All prose and table cells are English; tool names (`turtle`, `colorgram`, `exitonclick`) are established technical terms |
| 4 | The register matches the one the registry gives for the artifact type | Pass | Registry gives IT Executive English for BC. The text states decisions, targets and risks; implementation detail was removed from the risks table during drafting. Tool names stay where an objective needs them |
| 5 | Domain terms are the PO terms of the domain's dictionary, with no synonyms | Pass | The project has no Domain Dictionary (`DICT`), so there is no list to check against; the terms *dot*, *palette*, *painting*, *grid* and *phase* are used consistently here and in [SA-001]. "Spot painting" is the name of the genre; the elements are always "dots". S01 confirmed on 2026-10-07 that a dictionary is not needed (Action Item 2) |
| 6 | Metadata keys, section headings, IDs and statuses are in English | Pass | Headings follow the BC reference exactly |
| 7 | No translated twin (`<name>.<language>.md`) exists beside the document | Pass | Only `docs/business-case.md` exists |
| 8 | A change of language or domain since the previous accepted version has a Version History row and was reviewed again | N-A | First version; there is no previous accepted version |
| 9 | A reviewer competent in the domain, and in the language, has confirmed that the domain terms are used correctly | Pass | S01 confirmed on 2026-10-07 that the domain terms are used correctly (Action Item 2). S01 is also the author; the self-review was accepted by S01 (Action Item 1) |
| 10 | Abbreviations are spelled out on first use, in the stated language | Pass | SQA and QC are spelled out in the Executive Summary; ISO/IEC, SC and O numbering are defined where introduced |
## Overall Verdict
Go — every criterion of [QC-BC-001] and of [QC-LANG-001] passes (criterion 8 of [QC-LANG-001] is N-A for a first version). S01 accepted the documented self-review, confirmed the defaults and the stakeholder list, and confirmed on 2026-10-07 that the domain terms are used correctly and that no Domain Dictionary is needed. All action items are closed.
## Action Items
| # | Action | Owner | Due |
| --- | --- | --- | --- |
| 1 | Name a reviewer who is not the author, or record here that the review is a documented self-review accepted by S01. **Closed 2026-10-07:** S01 accepted a documented self-review | S01 | 2026-10-09 |
| 2 | Confirm that the domain terms in [BC-001] are used correctly (QC-LANG-001 criterion 9), and that a Domain Dictionary is not needed for this project. **Closed 2026-10-07:** S01 confirmed both points | S01 | 2026-10-09 |
| 3 | Confirm or change the defaults in [BC-001]: one-week timeline from 2026-10-07, colour threshold 240 (SC3), 30-second run time (SC6); say where the reference image is. **Closed 2026-10-07 for the defaults:** S01 confirmed all three. The reference image location is still open; it is a risk of [BC-001] and goes to the Open Issues of the Project Plan | S01 | 2026-10-09 |
---
[BC-001]: ../../business-case.md
[SA-001]: ../../stakeholder-analysis.md
[QC-BC-001]: ../../../framework/qc/qc-business-case.md
[QC-LANG-001]: ../../../framework/qc/qc-language-domain.md
docs/sqa/reviews/rc-002-stakeholder-analysis.md
+73
View File
@@ -0,0 +1,73 @@
# Review Record: Stakeholder Analysis SA-001
## Metadata
| Key | Value |
| --- | --- |
| ID | RC-002 |
| CrossReference | [SA-001], [BC-001], [QC-SA-001], [QC-LANG-001] |
## Version History
| Date | Status | Author | Reviewer | Change | Commit |
| --- | --- | --- | --- | --- | --- |
| 2026-10-07 | Accepted | Jens Tirsvad Nielsen | S01 | Initial version (draft prepared by the assistant for S01 to confirm)<br>S02 removed on S01's instruction; self-review confirmed by S01 | pending |
---
## Artifact Under Review
- Instance reviewed: [SA-001]
- Checklist used: [QC-SA-001], together with [QC-LANG-001] because the Stakeholder Analysis is written in the PO language
- Scope: full review
- Language and domain: en / it (the artifact's Metadata rows)
- Language reviewer: none. S01 reads English and knows the IT domain. S01 is also the author; S01 accepted a documented self-review on 2026-10-07 (Action Item 1)
**Status of this record:** final. The assistant read the document against
every criterion and recorded what it found; S01 confirmed the open points on
2026-10-07 and the verdict is `Go`.
## Checklist Results
| # | Criterion | Status | Evidence/Notes |
| --- | --- | --- | --- |
| 1 | Power/Interest grid is filled for every stakeholder, with no gaps or unclassified entries | Pass | S01, the only stakeholder, is classified HIGH/HIGH, Manage Closely; the quadrant follows the standard grid |
| 2 | Each stakeholder is assigned a unique, stable ID (e.g. S01-S11 style) reusable for RACI assignments in other artifacts | Pass | S01, unique; [BC-001] and the review records already cite it. S02 was removed on S01's instruction before any review gave `Go`, so no ID was reused |
| 3 | Roles and organizational context are defined with explicit Power and Interest levels, not just narrative description | Pass | Role and Organization columns filled, with explicit levels |
| 4 | Communication needs (channel, frequency, deliverable type) are mapped to project phases or milestones | Pass | Mapped to the review gates of the workflow, since no milestone document exists yet. The mapping to `MIL-*` IDs can be added in a later version once they exist |
| 5 | Conflicting stakeholder interests are identified with documented mitigation or resolution strategies | Pass | 3 conflicts, each with a mitigation. The reviewer-independence conflict is mitigated by S01's accepted self-review (Action Item 1) |
| 6 | Stakeholder concerns are explicitly traced to Business Case objectives | Pass | Business Goal Alignment table traces S01's concerns to O1 to O5 of [BC-001]; the objective numbers match the Business Case |
| 7 | Primary concerns are expressed in both business language and a recognized quality-attribute mapping (e.g. FURPS+) | Pass | Every concern has a FURPS+ attribute; the acronym is spelled out in the Purpose |
| 8 | Document is understandable and navigable by non-technical stakeholders reviewing their own entry | Pass | Short, plain table entries; S01 has a single row to read |
## Language and Domain Results
| # | Criterion | Status | Evidence/Notes |
| --- | --- | --- | --- |
| 1 | The Metadata table has a `Language` row and a `Domain` row, and neither is a placeholder | Pass | The `Language` row says `en` and the `Domain` row says `it`; `check-languages.sh --list` reports both |
| 2 | `Language` is a BCP 47 code and `Domain` is a value from the registry's domain list | Pass | `en` is a BCP 47 code; `it` is in the registry's domain list ("Software and IT") |
| 3 | The content (prose and table cells) is written in the stated language | Pass | All prose and table cells are English; tool names are established technical terms |
| 4 | The register matches the one the registry gives for the artifact type | Pass | Registry gives IT Professional English for SA; the text uses the grid, FURPS+ and RACI terms without over-explaining them |
| 5 | Domain terms are the PO terms of the domain's dictionary, with no synonyms | Pass | The project has no Domain Dictionary (`DICT`), so there is no list to check against; the terms *dot*, *palette*, *painting*, *grid* and *phase* match [BC-001]. S01 confirmed on 2026-10-07 that a dictionary is not needed (Action Item 2) |
| 6 | Metadata keys, section headings, IDs and statuses are in English | Pass | Headings follow the SA reference exactly |
| 7 | No translated twin (`<name>.<language>.md`) exists beside the document | Pass | Only `docs/stakeholder-analysis.md` exists |
| 8 | A change of language or domain since the previous accepted version has a Version History row and was reviewed again | N-A | First version; there is no previous accepted version |
| 9 | A reviewer competent in the domain, and in the language, has confirmed that the domain terms are used correctly | Pass | S01 confirmed on 2026-10-07 that the domain terms are used correctly (Action Item 2). S01 is also the author; the self-review was accepted by S01 (Action Item 1) |
| 10 | Abbreviations are spelled out on first use, in the stated language | Pass | FURPS+ and RACI are spelled out in the Purpose; S01 and BC-001 are IDs defined by the document set |
## Overall Verdict
Go — every criterion of [QC-SA-001] and of [QC-LANG-001] passes (criterion 8 of [QC-LANG-001] is N-A for a first version). S01 accepted the documented self-review, confirmed the defaults and the stakeholder list, and confirmed on 2026-10-07 that the domain terms are used correctly and that no Domain Dictionary is needed. All action items are closed.
## Action Items
| # | Action | Owner | Due |
| --- | --- | --- | --- |
| 1 | Name a reviewer who is not the author, or record here that the review is a documented self-review accepted by S01 (the same decision as RC-001 Action Item 1). **Closed 2026-10-07:** S01 accepted a documented self-review | S01 | 2026-10-09 |
| 2 | Confirm that the domain terms in [SA-001] are used correctly (QC-LANG-001 criterion 9), and that a Domain Dictionary is not needed for this project. **Closed 2026-10-07:** S01 confirmed both points | S01 | 2026-10-09 |
| 3 | Confirm that S01 and S02 are the only stakeholders, or name others (for example a second reviewer). **Closed 2026-10-07:** S01 is the only stakeholder; S02 was removed from [SA-001] and [BC-001] | S01 | 2026-10-09 |
---
[SA-001]: ../../stakeholder-analysis.md
[BC-001]: ../../business-case.md
[QC-SA-001]: ../../../framework/qc/qc-stakeholder-analysis.md
[QC-LANG-001]: ../../../framework/qc/qc-language-domain.md
docs/sqa/reviews/rc-003-milestone-mil-001.md
+69
View File
@@ -0,0 +1,69 @@
# Review Record: Milestone MIL-001
## Metadata
| Key | Value |
| --- | --- |
| ID | RC-003 |
| CrossReference | [MIL-001], [BC-001], [QC-MIL-001], [QC-LANG-001] |
## Version History
| Date | Status | Author | Reviewer | Change | Commit |
| --- | --- | --- | --- | --- | --- |
| 2026-10-07 | Accepted | Jens Tirsvad Nielsen | S01 | Initial version (draft prepared by the assistant for S01 to confirm) | pending |
---
## Artifact Under Review
- Instance reviewed: [MIL-001]
- Checklist used: [QC-MIL-001], together with [QC-LANG-001] because the milestone is written in the PO language
- Scope: full review
- Language and domain: en / it (the artifact's Metadata rows)
- Language reviewer: none. S01 reads English and knows the IT domain. S01 is also the author; S01 accepted a documented self-review on 2026-10-07 (see [BC-001] review record, Action Item 1)
**Status of this record:** final. The assistant read the milestone against
every criterion and recorded what it found; S01 confirmed the open point on
2026-10-07 and the verdict is `Go`.
## Checklist Results
| # | Criterion | Status | Evidence/Notes |
| --- | --- | --- | --- |
| 1 | A concrete deliverable is defined for every gate | Pass | Deliverable: the palette function in the source file under `src/`, its tests and the printed palette of the real image. It is a tangible output, not a date |
| 2 | Explicit Go/No-Go criteria are stated for each gate | Pass | Five criteria, each with a Go and a No-Go column and a check that can be run (imports, colour count, white threshold 240, tests, review record) |
| 3 | Dependencies on other milestones are explicitly mapped | Pass | Dependencies table says "None" with the reason: it is the first gateway and the baseline documents are `Accepted` |
| 4 | Each milestone is traceable to a Business Case objective or KPI | Pass | Traceability table maps O2 and O5 of [BC-001] to the criteria and to SC3 and SC7 |
| 5 | Milestone owner and approving reviewer are identified | Pass | Ownership table gives S01 for both; the shared identity is the accepted self-review |
| 6 | Milestone has a defined target date consistent with project constraints | Pass | 2026-10-09, inside the one-week limit of [BC-001] (2026-10-07 to 2026-10-14) |
## Language and Domain Results
| # | Criterion | Status | Evidence/Notes |
| --- | --- | --- | --- |
| 1 | The Metadata table has a `Language` row and a `Domain` row, and neither is a placeholder | Pass | The `Language` row says `en` and the `Domain` row says `it`; `check-languages.sh --list` reports both |
| 2 | `Language` is a BCP 47 code and `Domain` is a value from the registry's domain list | Pass | `en` is a BCP 47 code; `it` is in the registry's domain list ("Software and IT") |
| 3 | The content (prose and table cells) is written in the stated language | Pass | All prose and table cells are English; tool names are established technical terms |
| 4 | The register matches the one the registry gives for the artifact type | Pass | Registry gives IT Executive English for MIL. Purpose, Deliverable and the Go/No-Go table state decisions and checks. The Tasks table is more technical (`import turtle`, `pip`) because the milestone reference requires each summary to be understood as an Issue without opening the file. S01 confirmed this reading on 2026-10-07 (Action Item 1) |
| 5 | Domain terms are the PO terms of the domain's dictionary, with no synonyms | Pass | S01 confirmed on 2026-10-07 that no dictionary is needed; the terms *dot*, *palette*, *painting*, *grid* and *phase* match [BC-001] |
| 6 | Metadata keys, section headings, IDs and statuses are in English | Pass | Headings follow the MIL reference exactly |
| 7 | No translated twin (`<name>.<language>.md`) exists beside the document | Pass | Only `docs/milestones/mil-001-palette.md` exists |
| 8 | A change of language or domain since the previous accepted version has a Version History row and was reviewed again | N-A | First version; there is no previous accepted version |
| 9 | A reviewer competent in the domain, and in the language, has confirmed that the domain terms are used correctly | Pass | S01 confirmed on 2026-10-07 that the domain terms are used correctly (Action Item 1). S01 is also the author; the self-review was accepted by S01 |
| 10 | Abbreviations are spelled out on first use, in the stated language | Pass | SC3, SC7, O2 and O5 are defined in [BC-001] and cited with it; RGB is spelled out at its first use in task 5, and Tk is explained in task 1 as the graphical toolkit behind `turtle` |
## Overall Verdict
Go — every criterion of [QC-MIL-001] and of [QC-LANG-001] passes (criterion 8 of [QC-LANG-001] is N-A for a first version). S01 accepted the documented self-review and confirmed on 2026-10-07 that the domain terms are used correctly and that the technical wording of the Tasks table is acceptable. The action item is closed. The milestone may now be synced to the git host and its tasks may start (plan-first gate).
## Action Items
| # | Action | Owner | Due |
| --- | --- | --- | --- |
| 1 | Confirm that the domain terms are used correctly (QC-LANG-001 criterion 9), and that the technical wording of the Tasks table is acceptable in a milestone of register IT Executive English. **Closed 2026-10-07:** S01 confirmed both points | S01 | 2026-10-08 |
---
[MIL-001]: ../../milestones/mil-001-palette.md
[BC-001]: ../../business-case.md
[QC-MIL-001]: ../../../framework/qc/qc-milestones-gateways.md
[QC-LANG-001]: ../../../framework/qc/qc-language-domain.md
docs/sqa/reviews/rc-004-milestone-mil-002.md
+69
View File
@@ -0,0 +1,69 @@
# Review Record: Milestone MIL-002
## Metadata
| Key | Value |
| --- | --- |
| ID | RC-004 |
| CrossReference | [MIL-002], [BC-001], [QC-MIL-001], [QC-LANG-001] |
## Version History
| Date | Status | Author | Reviewer | Change | Commit |
| --- | --- | --- | --- | --- | --- |
| 2026-10-07 | Accepted | Jens Tirsvad Nielsen | S01 | Initial version (draft prepared by the assistant for S01 to confirm) | pending |
---
## Artifact Under Review
- Instance reviewed: [MIL-002]
- Checklist used: [QC-MIL-001], together with [QC-LANG-001] because the milestone is written in the PO language
- Scope: full review
- Language and domain: en / it (the artifact's Metadata rows)
- Language reviewer: none. S01 reads English and knows the IT domain. S01 is also the author; S01 accepted a documented self-review on 2026-10-07 (see [BC-001] review record, Action Item 1)
**Status of this record:** final. The assistant read the milestone against
every criterion and recorded what it found; S01 confirmed the open point on
2026-10-07 and the verdict is `Go`.
## Checklist Results
| # | Criterion | Status | Evidence/Notes |
| --- | --- | --- | --- |
| 1 | A concrete deliverable is defined for every gate | Pass | Deliverable: the runnable program in the source file under `src/`, its tests and one timed run showing the finished painting |
| 2 | Explicit Go/No-Go criteria are stated for each gate | Pass | Six criteria, each with a Go and a No-Go column and a check that can be run (dot count, size and spacing, palette membership, clean result, 30 seconds, review record) |
| 3 | Dependencies on other milestones are explicitly mapped | Pass | Dependencies table names MIL-001 and the reason: the painting draws with the palette function that phase delivers |
| 4 | Each milestone is traceable to a Business Case objective or KPI | Pass | Traceability table maps O1, O3, O4 and O5 of [BC-001] to the criteria and to SC1, SC2 and SC4 to SC7; SC3 belongs to MIL-001 |
| 5 | Milestone owner and approving reviewer are identified | Pass | Ownership table gives S01 for both; the shared identity is the accepted self-review |
| 6 | Milestone has a defined target date consistent with project constraints | Pass | 2026-10-14, the last day of the one-week limit of [BC-001] (2026-10-07 to 2026-10-14). There is no slack; the Project Plan names this as a risk |
## Language and Domain Results
| # | Criterion | Status | Evidence/Notes |
| --- | --- | --- | --- |
| 1 | The Metadata table has a `Language` row and a `Domain` row, and neither is a placeholder | Pass | The `Language` row says `en` and the `Domain` row says `it`; `check-languages.sh --list` reports both |
| 2 | `Language` is a BCP 47 code and `Domain` is a value from the registry's domain list | Pass | `en` is a BCP 47 code; `it` is in the registry's domain list ("Software and IT") |
| 3 | The content (prose and table cells) is written in the stated language | Pass | All prose and table cells are English; tool names are established technical terms |
| 4 | The register matches the one the registry gives for the artifact type | Pass | Registry gives IT Executive English for MIL. Purpose, Deliverable and the Go/No-Go table state decisions and checks. The Tasks table is more technical (`random.choice`, `exitonclick`) because the milestone reference requires each summary to be understood as an Issue without opening the file. S01 confirmed this reading on 2026-10-07 (Action Item 1) |
| 5 | Domain terms are the PO terms of the domain's dictionary, with no synonyms | Pass | S01 confirmed on 2026-10-07 that no dictionary is needed; the terms *dot*, *palette*, *painting*, *grid* and *phase* match [BC-001] |
| 6 | Metadata keys, section headings, IDs and statuses are in English | Pass | Headings follow the MIL reference exactly |
| 7 | No translated twin (`<name>.<language>.md`) exists beside the document | Pass | Only `docs/milestones/mil-002-painting.md` exists |
| 8 | A change of language or domain since the previous accepted version has a Version History row and was reviewed again | N-A | First version; there is no previous accepted version |
| 9 | A reviewer competent in the domain, and in the language, has confirmed that the domain terms are used correctly | Pass | S01 confirmed on 2026-10-07 that the domain terms are used correctly (Action Item 1). S01 is also the author; the self-review was accepted by S01 |
| 10 | Abbreviations are spelled out on first use, in the stated language | Pass | SC1 to SC7 and O1 to O5 are defined in [BC-001] and cited with it; RGB is spelled out at its first use in task 1 |
## Overall Verdict
Go — every criterion of [QC-MIL-001] and of [QC-LANG-001] passes (criterion 8 of [QC-LANG-001] is N-A for a first version). S01 accepted the documented self-review and confirmed on 2026-10-07 that the domain terms are used correctly and that the technical wording of the Tasks table is acceptable. The action item is closed. The milestone may now be synced to the git host and its tasks may start (plan-first gate).
## Action Items
| # | Action | Owner | Due |
| --- | --- | --- | --- |
| 1 | Confirm that the domain terms are used correctly (QC-LANG-001 criterion 9), and that the technical wording of the Tasks table is acceptable in a milestone of register IT Executive English. **Closed 2026-10-07:** S01 confirmed both points | S01 | 2026-10-08 |
---
[MIL-002]: ../../milestones/mil-002-painting.md
[BC-001]: ../../business-case.md
[QC-MIL-001]: ../../../framework/qc/qc-milestones-gateways.md
[QC-LANG-001]: ../../../framework/qc/qc-language-domain.md