Skip to content

Commit 6312fd0

Browse files
committed
docs: reorganize docs into maintainer-first structure
1 parent 18a3c85 commit 6312fd0

19 files changed

+260
-0
lines changed

docs/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Documentation Index
2+
3+
This `docs/` tree is optimized for maintainer use: quick retrieval, low noise, and explicit lifecycle.
4+
5+
## Layout
6+
7+
- `docs/runbooks/`: repeatable operational procedures (deploy, rollback, emergency checks)
8+
- `docs/decisions/`: durable architecture/product decisions (ADR-style notes)
9+
- `docs/plans/active/`: plans currently in progress
10+
- `docs/plans/archive/`: completed or superseded plans (grouped by year)
11+
- `docs/perf/`: benchmark artifacts and performance snapshots
12+
13+
## Lifecycle Rules
14+
15+
1. Draft plans in `docs/plans/active/`.
16+
2. When work is done or abandoned, move the plan to `docs/plans/archive/<year>/`.
17+
3. Record long-term rationale in `docs/decisions/` instead of leaving it only in plan files.
18+
4. Keep runbooks task-oriented and executable; avoid narrative-only docs.
19+
20+
## Naming
21+
22+
- Plans: `YYYY-MM-DD-<topic>.md`
23+
- Decisions: `YYYY-MM-DD-<topic>-decision.md`
24+
- Runbooks: `<topic>-runbook.md`

docs/decisions/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Decisions
2+
3+
Use this folder for durable decisions (ADR-like records), not implementation plans.
4+
5+
Template suggestion:
6+
7+
- Context
8+
- Decision
9+
- Trade-offs
10+
- Consequences
11+
- Revisit trigger

docs/plans/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Plans
2+
3+
Plans are temporary execution artifacts.
4+
5+
## Folders
6+
7+
- `active/`: only currently actionable plans
8+
- `archive/<year>/`: historical plans
9+
10+
## Operator Rules
11+
12+
- Never keep finished plans in `active/`.
13+
- If a plan is replaced by a newer version, archive the old one immediately.
14+
- If a plan drives permanent policy, extract that policy into `docs/decisions/`.

docs/plans/active/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Active Plans
2+
3+
Put only ongoing plans here.
4+
5+
A plan is considered active when there are still planned steps not executed yet.
File renamed without changes.

docs/plans/2026-02-02-first-download-performance.md renamed to docs/plans/archive/2026/2026-02-02-first-download-performance.md

File renamed without changes.

docs/plans/2026-02-03-restore-upload-defaults.md renamed to docs/plans/archive/2026/2026-02-03-restore-upload-defaults.md

File renamed without changes.

docs/plans/2026-02-03-upload-log-level-design.md renamed to docs/plans/archive/2026/2026-02-03-upload-log-level-design.md

File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)