Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 81 additions & 0 deletions docs/plans/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# docs/plans -- Plan Document Convention

This folder contains per-issue vertical slice plans for primetimetank21/dev-setup. Plans are
the pre-implementation spec; they capture scope decisions, design decisions, and acceptance
criteria for a given issue before code is written.

---

## Front-Matter Schema

Every plan doc must begin with a YAML front-matter block:

```yaml
---
issue: <GitHub issue number, integer>
title: "Short human-readable title"
status: <see Status Vocabulary below>
created: <ISO date, YYYY-MM-DD>
updated: <ISO date, YYYY-MM-DD>
---
```

No other fields are required. `supersedes: <issue>` is optional when a plan replaces
a prior one.

---

## Status Vocabulary

| Status | Meaning |
|-------------|--------------------------------------------------|
| draft | In progress; not ready for implementation |
| ready | Approved; ready to implement |
| in-progress | Implementation underway (PR open) |
| implemented | Shipped to develop; doc kept for reference |
| superseded | Replaced by another plan doc (note supersedes) |

---

## File Naming

```
NNN-slug.md
```

Where NNN is the GitHub issue number (zero-padded to 3 digits) and slug is a short
kebab-case descriptor. Example: 468-customizable-install.md

---

## Layout

Flat files in docs/plans/. No per-feature subfolders unless a plan accumulates
supplementary assets (diagrams, data tables) that cannot live inline. Threshold: >10 plans
or attached binary assets.

---

## Review History

Do NOT commit review-panel changelogs to plan docs. The HQ coordinator maintains
review history externally. Plan docs contain only the living spec; revision history is
captured in git log and front-matter `updated` field.

---

## What Belongs Here

- Problem statement
- Scope (IN / OUT)
- Design decisions (with rationale)
- Algorithm / data structures / pseudocode as needed
- Test plan / acceptance criteria
- Out-of-scope items (tracked issues)

## What Does NOT Belong Here

- Reviewer names, cast names, or review attributions
- Version changelog blocks (vN Changes sections)
- Process notes (merge decisions, admin notes, coordinator instructions)
- Implementation progress updates (use the GitHub issue for that)
Loading