fristy
c9e643d617
- WPF + WinRT BLE controller for ELK-BLEDOM compatible LED strips - Multi-device control, effects, grayscale and temperature modes - Velopack updates via Gitea Releases, Gitea Actions CI
114 lines
3.4 KiB
Markdown
114 lines
3.4 KiB
Markdown
# Memory Bank v2 Schema
|
|
|
|
## Required Tree
|
|
|
|
```text
|
|
memory-bank/
|
|
00_project_snapshot.md
|
|
10_scope.md
|
|
11_product.md
|
|
12_architecture.md
|
|
13_tech.md
|
|
20_now.md
|
|
21_backlog.md
|
|
decisions/
|
|
ADR-0001-short-title.md
|
|
logs/
|
|
tasks/YYYY/MM/TASK-YYYYMMDD-001-short-title.md
|
|
digests/YYYY-MM.md
|
|
```
|
|
|
|
## ID and Naming Rules
|
|
- ADR ID: `ADR-0001` style, incrementing sequence.
|
|
- Task ID: `TASK-YYYYMMDD-###` style, sequence resets daily.
|
|
- Backlog ID: `BG-001` style.
|
|
- Core file names are fixed and must not be renamed.
|
|
- Keep file names in English; content may be Turkish or English.
|
|
|
|
## Hard Size Budgets
|
|
|
|
| File | Max lines | Role |
|
|
| --- | ---: | --- |
|
|
| `00_project_snapshot.md` | 120 | One-page entry point and quick orientation |
|
|
| `10_scope.md` | 180 | Scope boundaries and success criteria |
|
|
| `11_product.md` | 220 | User/problem/value model |
|
|
| `12_architecture.md` | 260 | Architecture map and critical paths |
|
|
| `13_tech.md` | 220 | Stack, setup, constraints, runbook basics |
|
|
| `20_now.md` | 160 | Current focus, blockers, assumptions |
|
|
| `21_backlog.md` | 200 | Prioritized backlog and status |
|
|
| `decisions/ADR-*.md` | 180 each | Durable rationale and decision records |
|
|
| `logs/tasks/.../*.md` | 250 each | Task execution narrative |
|
|
| `logs/digests/YYYY-MM.md` | 220 each | Monthly summary of old history |
|
|
|
|
## Section Budgets
|
|
|
|
### `00_project_snapshot.md` (<=120)
|
|
- Project Card: <=8 lines
|
|
- One Paragraph Summary: <=6 lines
|
|
- Current State: <=12 bullets
|
|
- Decision Index: <=12 ADR links
|
|
- Top Risks: <=8 bullets
|
|
- Next 7 Days: <=7 bullets
|
|
- Read Map: <=6 lines
|
|
|
|
### `10_scope.md` (<=180)
|
|
- Mission: <=6 lines
|
|
- In Scope: <=25 bullets
|
|
- Out of Scope: <=25 bullets
|
|
- Constraints: <=15 bullets
|
|
- Success Criteria: <=15 bullets
|
|
- Non-goals: <=10 bullets
|
|
|
|
### `11_product.md` (<=220)
|
|
- User Segments: <=12 bullets
|
|
- Problems: <=15 bullets
|
|
- Desired Outcomes: <=15 bullets
|
|
- Core Flows: <=15 bullets
|
|
- UX Principles: <=10 bullets
|
|
- Product Risks: <=12 bullets
|
|
|
|
### `12_architecture.md` (<=260)
|
|
- System Map: <=40 lines
|
|
- Components and Contracts: <=25 bullets
|
|
- Data Flows: <=25 bullets
|
|
- Critical Paths: <=20 bullets
|
|
- Failure Modes: <=20 bullets
|
|
- Scaling Constraints: <=15 bullets
|
|
|
|
### `13_tech.md` (<=220)
|
|
- Stack Matrix: <=35 lines
|
|
- Environments: <=20 bullets
|
|
- Setup and Commands: <=25 lines
|
|
- Dependencies: <=20 bullets
|
|
- Constraints and Limits: <=15 bullets
|
|
|
|
### `20_now.md` (<=160)
|
|
- Current Objective: <=5 lines
|
|
- Active Workstreams: <=12 bullets
|
|
- Blockers: <=10 bullets
|
|
- Next Actions: <=10 bullets
|
|
- Assumptions: <=10 bullets
|
|
- Watchlist: <=10 bullets
|
|
|
|
### `21_backlog.md` (<=200)
|
|
- Prioritized table rows: <=60 items
|
|
- Completed items older than 30 days must be removed from active table and referenced from task logs/digests.
|
|
|
|
## Core File Guardrails
|
|
- Core files are current truth only.
|
|
- Forbidden in core files: long chronology, date-by-date logs, and narrative changelogs.
|
|
- Keep details in ADRs and task logs; keep summaries in core files.
|
|
- Prefer references over duplicated prose.
|
|
|
|
## Over-Limit Policy
|
|
When any file exceeds budget:
|
|
1. Keep only current truth in the core file.
|
|
2. Move historical detail to ADR/task logs.
|
|
3. Add references to moved details.
|
|
4. Re-run a consistency check (IDs resolve, no stale links).
|
|
|
|
## 90-Day Retention Policy
|
|
- Task logs in the last 90 days are hot history.
|
|
- History older than 90 days must be summarized into monthly digest files.
|
|
- Compaction is manual and triggered by `compact memory bank`.
|