huge documentaton restructure for docusaurus
This commit is contained in:
18
docs/process/README.md
Normal file
18
docs/process/README.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Process & Planning Hub
|
||||
|
||||
This directory centralizes living planning artefacts that previously sat in scattered folders.
|
||||
|
||||
## Structure
|
||||
|
||||
- `changes/` — dated session logs, retro notes, and ad-hoc findings. Drop a new Markdown file per session (`YYYY-MM-DD-topic.md`) and reference it from epics when relevant.
|
||||
- `todo/` — backlog of active epics or initiatives. Each file focuses on a single problem space (e.g. `security-hardening-epic.md`) and contains goals, status, and actionable checklists.
|
||||
- `roadmap.md` — top-level view that summarizes what is in progress, what is queued up next, and which epics have been completed recently.
|
||||
|
||||
## Workflow
|
||||
|
||||
1. After every planning or incident-review session, capture the outcome in `changes/`.
|
||||
2. Update the relevant `todo/*.md` files with new tasks, decisions, or links back to change logs.
|
||||
3. Keep `roadmap.md` in sync with the current quarter’s priorities so product/ops can scan it quickly.
|
||||
4. When an initiative is completed and no longer useful operationally, move its Markdown file to `docs/archive/` to keep the active backlog lightweight.
|
||||
|
||||
> Tip: Link to concrete specs (PRP chapters, ops runbooks) from each epic so contributors know where implementation details live.
|
||||
Reference in New Issue
Block a user