Files
014-higher_lower/docs/project-plan.md
T
2026-10-04 23:23:54 +08:00

100 lines
4.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Project Plan
## Metadata
| Key | Value |
| --- | --- |
| ID | PP-001 |
| CrossReference | [BC-001], [SA-001], [MIL-001], [MIL-002], [MIL-003], [MIL-004], [RC-003] |
## Version History
| Date | Status | Author | Reviewer | Change | Commit |
| --- | --- | --- | --- | --- | --- |
| 2026-10-04 | Deprecated | Jens Tirsvad Nielsen | S01 | Initial version | [ddfe96f] |
| 2026-10-04 | Accepted | Jens Tirsvad Nielsen | S01 | Accepted after review RC-003 | [a1ff735] |
---
## Purpose
Schedule the four phases that deliver the Higher Lower game ([BC-001] objectives O1–O5) as a small, tested, documented Python project, with S01 reviewing each phase through its own branch and pull request.
## Planning Assumptions
- Week 1 starts 2026-10-04; the plan ends by 2026-10-14 (the Business Case sets no hard date; this is the author's evening-sized target, see Open Issues).
- One phase per branch and pull request, each closing its issues.
- Nothing under `src/` or `tests/` before the milestone is accepted and the task is a row in it.
- Only S01 reviews ([SA-001]).
## Gateway Schedule
| Gateway | Document | Window | Decision date | Owner | Stories | Main deliverable | Milestone |
| --- | --- | --- | --- | --- | --- | --- | --- |
| Project setup | [MIL-001] | 2026-10-04 – 2026-10-06 | 2026-10-06 | S01 | — | pyproject, Doxyfile, skeleton, repo metadata | |
| Game logic | [MIL-002] | 2026-10-07 – 2026-10-09 | 2026-10-09 | S01 | — | Data, art, constants, pure functions, tests | |
| Console game | [MIL-003] | 2026-10-10 – 2026-10-12 | 2026-10-12 | S01 | — | Playable game loop with score, tests | |
| Documentation and release | [MIL-004] | 2026-10-13 – 2026-10-14 | 2026-10-14 | S01 | — | README, Doxygen run, review records | |
```plantuml
@startgantt
Project starts 2026-10-04
[Project setup] starts 2026-10-04 and ends 2026-10-06
[Project setup Go/No-Go] happens 2026-10-06
[Game logic] starts 2026-10-07 and ends 2026-10-09
[Game logic Go/No-Go] happens 2026-10-09
[Console game] starts 2026-10-10 and ends 2026-10-12
[Console game Go/No-Go] happens 2026-10-12
[Documentation and release] starts 2026-10-13 and ends 2026-10-14
[Documentation and release Go/No-Go] happens 2026-10-14
@endgantt
```
## Scope Coverage
| Business Case scope item | Gateway |
| --- | --- |
| `src/`, `tests/`, `docs/` layout, `pyproject.toml`, `.gitignore`, `Doxyfile` | [MIL-001] |
| Repository description and topics | [MIL-001] |
| Assignment data set, `logo` and `vs` art | [MIL-002] |
| Random pair selection, answer checking | [MIL-002] |
| Console game, score tracking | [MIL-003] |
| `README.md`, venv and test instructions | [MIL-004] |
## Dependencies
```
MIL-001 → MIL-002 → MIL-003 → MIL-004
```
A No-Go on any phase moves all later windows by the rework time.
## Plan Risks
| Risk | Impact | Mitigation |
| --- | --- | --- |
| README template not supplied | README task blocked | Ask S01 before MIL-004 starts |
| Host token missing or lacking scope | Cannot sync issues or set topics | Token read from `.env` for personal use only; ask S01 if absent |
| Doxygen not installed locally | Cannot verify docs build | Treat as a No-Go note; install or review comments manually |
## Open Issues
- README template: the brief says "using the template below" but none was included. Needed before MIL-004.
- Python version: "greater than 3.13" is planned as `>=3.13`; confirm if strictly 3.14+ is meant.
- Target dates are proposed, not stated in the brief; confirm.
- The brief links the organisation; the `origin` remote is the repository `014-higher_lower` within it, which is what will be synced.
---
[BC-001]: ./business-case.md
[SA-001]: ./stakeholder-analysis.md
[MIL-001]: ./milestones/mil-001-project-setup.md
[MIL-002]: ./milestones/mil-002-game-logic.md
[MIL-003]: ./milestones/mil-003-console-game.md
[MIL-004]: ./milestones/mil-004-docs-release.md
[Milestone MIL-001]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/014-higher_lower/milestones/36
[Milestone MIL-002]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/014-higher_lower/milestones/37
[Milestone MIL-003]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/014-higher_lower/milestones/38
[Milestone MIL-004]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/014-higher_lower/milestones/39
[ddfe96f]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/014-higher_lower/commit/ddfe96ffa459d5e4b2e30d71bd53878aba2cfc5d
[RC-003]: ./sqa/reviews/rc-003-project-plan.md
[a1ff735]: https://git.tirsystem.com/Tirsvad-Udemy-100_days_of_code/014-higher_lower/commit/a1ff73580fdcfad5bbb3854298fdfa0c16ada853