generated from Lerking/python-repo-template
39 lines
1.6 KiB
Markdown
39 lines
1.6 KiB
Markdown
---
|
|
name: "2. Write project specification"
|
|
about: "First step for a new project — complete and get approval on the project specification."
|
|
title: "Write project specification"
|
|
labels: ["setup", "planning"]
|
|
assignees: ""
|
|
---
|
|
|
|
## Task
|
|
|
|
Complete [`docs/PROJECT_SPECIFICATION.md`](../../docs/PROJECT_SPECIFICATION_TEMPLATE.md)
|
|
(copied from the project specification template) for this project, and get it reviewed and
|
|
approved by stakeholders.
|
|
|
|
## Steps
|
|
|
|
- [ ] Copy `docs/PROJECT_SPECIFICATION_TEMPLATE.md` to `docs/PROJECT_SPECIFICATION.md`
|
|
- [ ] Write the summary and problem statement
|
|
- [ ] List goals and — just as importantly — non-goals
|
|
- [ ] Identify stakeholders and their roles
|
|
- [ ] Define scope (in scope / out of scope)
|
|
- [ ] Write functional and non-functional requirements
|
|
- [ ] Sketch the architecture & design section (can stay high-level at this stage)
|
|
- [ ] List constraints, assumptions, and risks
|
|
- [ ] Draft milestones and a timeline
|
|
- [ ] Define success metrics / acceptance criteria
|
|
- [ ] Incorporate findings from the
|
|
[value stream mapping issue](01-define-value-stream-goals.md), if applicable
|
|
- [ ] Circulate for review and log open questions in Section 15
|
|
- [ ] Get sign-off from the stakeholders listed in Section 5 and set status to "Approved"
|
|
|
|
## Definition of done
|
|
|
|
- [ ] `docs/PROJECT_SPECIFICATION.md` exists and every section is filled in or deliberately
|
|
removed
|
|
- [ ] Specification status is "Approved" and the revision history is up to date
|
|
- [ ] Summary is copied onto the
|
|
[Project Specification wiki page](../../wiki/Project-Specification.md)
|