generated from Lerking/python-repo-template
Upload files to "wiki"
This commit is contained in:
@@ -0,0 +1,28 @@
|
||||
# Project Specification
|
||||
|
||||
The authoritative project specification lives in
|
||||
[`docs/PROJECT_SPECIFICATION.md`](../docs/PROJECT_SPECIFICATION_TEMPLATE.md) (based on the
|
||||
[project specification template](../docs/PROJECT_SPECIFICATION_TEMPLATE.md)), not on this
|
||||
wiki page — it needs version control and review history that the wiki doesn't give you.
|
||||
|
||||
This page exists so the specification is easy to find. Keep it updated with:
|
||||
|
||||
- **Current version:** `<version>`
|
||||
- **Status:** Draft / In Review / Approved
|
||||
- **Last approved:** `<date>`
|
||||
|
||||
## Summary
|
||||
|
||||
Paste the 3–5 sentence summary from Section 1 of the specification here, so readers get the
|
||||
gist without leaving the wiki.
|
||||
|
||||
## Key goals
|
||||
|
||||
- Goal 1
|
||||
- Goal 2
|
||||
- Goal 3
|
||||
|
||||
## Notable non-goals
|
||||
|
||||
- Non-goal 1
|
||||
- Non-goal 2
|
||||
Reference in New Issue
Block a user