Project-Template/docs/planning/PROJECT_PLAN.md

54 lines
1.5 KiB
Markdown

# <Project> — Project Plan
```
Status: Current
Owner: <who maintains this>
Last reviewed: <YYYY-MM-DD>
Governs: scope, audience, and what this project deliberately is not
Review trigger: Any change of scope, audience, or platform
```
> The vision. The **milestones in this repository's issue tracker** hold the
> sequence of work; this holds what the work is *for*. When the two disagree,
> this one is the argument and those are the plan — resolve it rather than
> letting both stand.
>
> Deliberately no batch list here. A schedule in a document goes stale the day
> after it is written and nothing notices; a schedule in the tracker is updated
> by the act of doing the work.
## What this is
<One paragraph. If it takes three, the scope is not settled yet.>
## Who it is for
<The actual user. "Everyone" is not an answer and produces a product with no
opinions.>
## What it is deliberately not
<The most useful section in this file. Every "not" here is a decision that stops
being re-litigated, and a feature request that can be answered in one line.>
- <not this>
- <not that>
## Stack and platform
| Concern | Choice | Why |
| --- | --- | --- |
| <language / runtime> | <choice> | <the reason, not the marketing> |
| <storage> | <choice> | <> |
| <hosting> | <choice> | <> |
## Success looks like
<Something observable. "Users are happy" is not observable; "a first-time user
completes the core flow without help" is.>
## Known risks
<What could make this fail, and what would be done about it. Written now, while
it is still cheap to be honest.>