Tirsvad-Udemy-100-days-of-code/026-nato-alphabet
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add baseline: Business Case, Stakeholder Analysis, Project Plan, milestones and reviews

Browse Source 
Accepts BC-001, SA-001, PP-001 and MIL-001 to MIL-003 with review records
RC-001 to RC-005 (autonomous mode, AI as stand-in for S01).
This commit is contained in:
Tirsvad
2026-10-13 16:20:36 +08:00
parent 8736aad171
commit 7212302fb9
15 changed files with 977 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/milestones/mil-001-repository-foundation.md
+74
View File
@@ -0,0 +1,74 @@
# MIL-001 Repository foundation
## Metadata
| Key | Value |
| --- | --- |
| ID | MIL-001 |
| CrossReference | [BC-001] |
| Language | en |
| Domain | it |
## Version History
| Date | Status | Author | Reviewer | Change | Commit |
| --- | --- | --- | --- | --- | --- |
| 2026-10-13 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version, reviewed in RC-003 | pending |
---
## Purpose
Decide whether the repository has the structure, configuration and automation that the converter can be built on: a Python 3.13 project with a local virtual environment, pytest, a Doxygen configuration, a CI workflow and a public presentation (description and topics).
## Deliverable
A repository containing `pyproject.toml`, a Python `.gitignore`, the `src/` package skeleton with `constants.py` and the NATO CSV data file, an empty but running `tests/` folder, a `Doxyfile`, a CI workflow, two ADRs, and a repository description and topics set on the git host.
## Go / No-Go Criteria
| # | Criterion (objectively checkable) | Go | No-Go |
| --- | --- | --- | --- |
| 1 | `pyproject.toml` declares `requires-python >=3.13`, an empty `dependencies` list and pytest as a development extra | Present | Missing or a runtime dependency is listed |
| 2 | `.gitignore` ignores `.venv/`, `__pycache__/`, `.env` and the Doxygen output | `git check-ignore` confirms each | Any entry missing |
| 3 | A fresh `.venv` installs the project with `python -m pip install -e ".[dev]"` and `python -m pytest` runs | Exit code 0 | Install or run fails |
| 4 | `doxygen Doxyfile` builds | Exit code 0 | Build fails |
| 5 | The CI workflow runs the same pytest command and passes the framework's workflow checklist | Review `Go` | Review `No-Go` |
| 6 | The repository description and at least 5 topics are set on the host | API returns both | Missing |
| 7 | `.env` is not tracked and no token appears in any tracked file | `git ls-files` and a search show none | Any hit |
## Dependencies
| Depends on | Reason |
| --- | --- |
| None | First phase; follows the accepted Business Case, Stakeholder Analysis and Project Plan |
## Traceability
| Business Case objective / KPI / user story | Reference |
| --- | --- |
| O2, O3, O4, O5 | [BC-001] |
## Ownership
| Role | Stakeholder ID (SA) |
| --- | --- |
| Owner | S01 |
| Approving reviewer | S01 |
## Target Date
2026-10-14 — inside the plan's window (2026-10-13 to 2026-10-16).
## Tasks
| # | Task | Summary | Needs its own Use Case/User Story? | Reference |
| --- | --- | --- | --- | --- |
| 1 | Record architecture decisions | Write ADR-0001 (read the NATO data with the standard library `csv` module instead of Pandas, so the project has no runtime dependencies for S03) and ADR-0002 (KPI, BMC, BPMN and RA are skipped for a project of this size). | No | |
| 2 | Configure the Python project | Add `pyproject.toml` (Python 3.13 or newer, no runtime dependencies, pytest as a development extra, pytest and package settings) and a Python `.gitignore` that also ignores `.env`, `.venv` and Doxygen output. | No | |
| 3 | Create the package skeleton | Create `src/nato_alphabet/` with `constants.py` (data file name, prompt and message texts), the supplied `nato_phonetic_alphabet.csv` as package data, and an empty `tests/` package, so the converter has a place to land. | No | |
| 4 | Add the Doxyfile | Generate a `Doxyfile` that reads `src/`, writes to `build/doxygen/`, extracts Python docstrings and warns on undocumented members. | No | |
| 5 | Add the CI workflow | Add a Gitea Actions workflow that sets up Python 3.13, creates a venv, installs the project and runs `python -m pytest` on every push and pull request. | No | |
| 6 | Set repository description and topics | Use the Gitea API with the token from the git-ignored `.env` (never printed, imported or committed) to set a description and topics so S03 sees what the repository is. | No | |
---
[BC-001]: ../business-case.md
docs/milestones/mil-002-nato-converter.md
+76
View File
@@ -0,0 +1,76 @@
# MIL-002 NATO converter
## Metadata
| Key | Value |
| --- | --- |
| ID | MIL-002 |
| CrossReference | [BC-001] |
| Language | en |
| Domain | it |
## Version History
| Date | Status | Author | Reviewer | Change | Commit |
| --- | --- | --- | --- | --- | --- |
| 2026-10-13 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version, reviewed in RC-004 | pending |
---
## Purpose
Decide whether the console program does what the assignment asks: read a word, and print the NATO code word of each letter, built with list and dictionary comprehensions and tested with pytest.
## Deliverable
The `nato_alphabet` package with a runnable entry point, a test suite that passes, and Doxygen comments on every public item; plus the user story, use case and system sequence diagram of "spell a word".
## Go / No-Go Criteria
| # | Criterion (objectively checkable) | Go | No-Go |
| --- | --- | --- | --- |
| 1 | All 26 letters map to their code word and input is case-insensitive | pytest passes | Any test fails |
| 2 | A character that is not a letter makes the program ask again instead of crashing | pytest covers it and passes | Missing or failing |
| 3 | The loader uses a dictionary comprehension and the converter a list comprehension | Code review confirms | Loops used instead |
| 4 | The assignment's function names are kept in the public API | Names present in the module | Names missing |
| 5 | The code review against `qc-programming-python.md` is a `Go` | `RC-*` verdict `Go` | `No-Go` |
| 6 | `doxygen Doxyfile` reports no warnings | 0 warnings | Any warning |
| 7 | Constants live in `constants.py`; `.env` is not imported by `src/` or `tests/` | Search confirms | Any hit |
## Dependencies
| Depends on | Reason |
| --- | --- |
| [MIL-001] | Project configuration, skeleton, CI and Doxyfile |
## Traceability
| Business Case objective / KPI / user story | Reference |
| --- | --- |
| O1, O3, O4 | [BC-001] |
| Spell a word | US-001, UC-001 |
## Ownership
| Role | Stakeholder ID (SA) |
| --- | --- |
| Owner | S01 |
| Approving reviewer | S01 |
## Target Date
2026-10-15 — inside the plan's window (2026-10-13 to 2026-10-16).
## Tasks
| # | Task | Summary | Needs its own Use Case/User Story? | Reference |
| --- | --- | --- | --- | --- |
| 1 | Model "spell a word" | Write US-001, UC-001 (brief) and the system sequence diagram for the user who types a word and receives its NATO code words, including the retry on invalid input. Domain concepts are only letter and code word, so no domain model is added. | Yes | US-001, UC-001 |
| 2 | Load the NATO alphabet | Read the CSV with the standard library and build the letter-to-code-word dictionary with a dictionary comprehension (`load_nato_dict`), taking the file name from `constants.py`. | No | |
| 3 | Convert a word to code words | Implement the assignment's `generate_phonetic` with a list comprehension: upper-case the word, return the code word of each letter, raise a clear error for a character that is not a letter. | No | |
| 4 | Implement the console entry point | Prompt for a word, print the code words, ask again on invalid input; runnable as `python -m nato_alphabet` and as the `nato-alphabet` command. | Yes | UC-001 |
| 5 | Write the pytest suite | Test all letters, mixed case, unknown characters, the loader (with a temporary CSV) and the entry point (with patched input and captured output). | No | |
| 6 | Add Doxygen comments | Document every module, function and constant with Doxygen comments and confirm the build has no warnings. | No | |
---
[BC-001]: ../business-case.md
[MIL-001]: ./mil-001-repository-foundation.md
docs/milestones/mil-003-documentation-and-publication.md
+75
View File
@@ -0,0 +1,75 @@
# MIL-003 Documentation and publication
## Metadata
| Key | Value |
| --- | --- |
| ID | MIL-003 |
| CrossReference | [BC-001] |
| Language | en |
| Domain | it |
## Version History
| Date | Status | Author | Reviewer | Change | Commit |
| --- | --- | --- | --- | --- | --- |
| 2026-10-13 | Accepted | Jens Tirsvad Nielsen | AI as stand-in for S01 | Initial version, reviewed in RC-005 | pending |
---
## Purpose
Decide whether S02 and S03 can understand, set up and run the project from its README and wiki without help, in English, Danish and Bahasa Malaysia.
## Deliverable
The `README.md` built from the framework template with screenshots, and a wiki in English, Danish and Bahasa Malaysia with the same pages and screenshots, published on the git host.
## Go / No-Go Criteria
| # | Criterion (objectively checkable) | Go | No-Go |
| --- | --- | --- | --- |
| 1 | `check-readme.sh` reports no finding for the README | Exit code 0 | Any finding |
| 2 | The README steps (create `.venv`, upgrade pip, install, run, test) work on a fresh clone on Windows PowerShell | The run produces the expected output | A step fails |
| 3 | Every wiki page exists in en, da and ms | `check-languages.sh` and a file listing agree | A page is missing |
| 4 | The README and each wiki language show a screenshot | Image files exist and are linked | Missing |
| 5 | The wiki is published and readable on the host | Page requests return success | Any page not found |
| 6 | `doxygen Doxyfile` builds and the README says how | Exit code 0 and the section exists | Missing |
## Dependencies
| Depends on | Reason |
| --- | --- |
| [MIL-002] | The documentation describes the finished program |
## Traceability
| Business Case objective / KPI / user story | Reference |
| --- | --- |
| O2, O4, O5 | [BC-001] |
## Ownership
| Role | Stakeholder ID (SA) |
| --- | --- |
| Owner | S01 |
| Approving reviewer | S01 |
## Target Date
2026-10-16 — the end of the plan's window.
## Tasks
| # | Task | Summary | Needs its own Use Case/User Story? | Reference |
| --- | --- | --- | --- | --- |
| 1 | Capture screenshots | Run the program and render its real output as PNG images (a word spelled, an invalid input retried) stored under `docs/images/` for the README and the wiki. | No | |
| 2 | Write the README | Fill the framework README template: set-up on Windows PowerShell, Linux Debian and macOS with a local `.venv` and `python -m pip install --upgrade pip`, run, tests, continuous integration, Doxygen build, layout and licence. | No | |
| 3 | Write the English wiki | Pages Home, Install, Usage and Development in English with screenshots, in the layout of the framework wiki. | No | |
| 4 | Write the Danish wiki | The same pages in Danish with the `-da` suffix. | No | |
| 5 | Write the Bahasa Malaysia wiki | The same pages in Bahasa Malaysia with the `-ms` suffix. | No | |
| 6 | Publish the wiki | Push the pages to the repository's wiki on the git host and check that each page is readable. | No | |
| 7 | Verify the set-up instructions | Follow the README from a fresh clone in a new `.venv`, run the program and the tests, and record the result in the review. | No | |
---
[BC-001]: ../business-case.md
[MIL-002]: ./mil-002-nato-converter.md