Initial commit
This commit is contained in:
157
skills/create-plans/templates/brief.md
Normal file
157
skills/create-plans/templates/brief.md
Normal file
@@ -0,0 +1,157 @@
|
||||
# Brief Template
|
||||
|
||||
## Greenfield Brief (v1.0)
|
||||
|
||||
Copy and fill this structure for `.planning/BRIEF.md` when starting a new project:
|
||||
|
||||
```markdown
|
||||
# [Project Name]
|
||||
|
||||
**One-liner**: [What this is in one sentence]
|
||||
|
||||
## Problem
|
||||
|
||||
[What problem does this solve? Why does it need to exist?
|
||||
2-3 sentences max.]
|
||||
|
||||
## Success Criteria
|
||||
|
||||
How we know it worked:
|
||||
|
||||
- [ ] [Measurable outcome 1]
|
||||
- [ ] [Measurable outcome 2]
|
||||
- [ ] [Measurable outcome 3]
|
||||
|
||||
## Constraints
|
||||
|
||||
[Any hard constraints: tech stack, timeline, budget, dependencies]
|
||||
|
||||
- [Constraint 1]
|
||||
- [Constraint 2]
|
||||
|
||||
## Out of Scope
|
||||
|
||||
What we're NOT building (prevents scope creep):
|
||||
|
||||
- [Not doing X]
|
||||
- [Not doing Y]
|
||||
```
|
||||
|
||||
<guidelines>
|
||||
- Keep under 50 lines
|
||||
- Success criteria must be measurable/verifiable
|
||||
- Out of scope prevents "while we're at it" creep
|
||||
- This is the ONLY human-focused document
|
||||
</guidelines>
|
||||
|
||||
## Brownfield Brief (v1.1+)
|
||||
|
||||
After shipping v1.0, update BRIEF.md to include current state:
|
||||
|
||||
```markdown
|
||||
# [Project Name]
|
||||
|
||||
## Current State (Updated: YYYY-MM-DD)
|
||||
|
||||
**Shipped:** v[X.Y] [Name] (YYYY-MM-DD)
|
||||
**Status:** [Production / Beta / Internal / Live with users]
|
||||
**Users:** [If known: "~500 downloads, 50 DAU" or "Internal use only" or "N/A"]
|
||||
**Feedback:** [Key themes from user feedback, or "Initial release, gathering feedback"]
|
||||
**Codebase:**
|
||||
- [X,XXX] lines of [primary language]
|
||||
- [Key tech stack: framework, platform, deployment target]
|
||||
- [Notable dependencies or architecture]
|
||||
|
||||
**Known Issues:**
|
||||
- [Issue 1 from v1.x that needs addressing]
|
||||
- [Issue 2]
|
||||
- [Or "None" if clean slate]
|
||||
|
||||
## v[Next] Goals
|
||||
|
||||
**Vision:** [What's the goal for this next iteration?]
|
||||
|
||||
**Motivation:**
|
||||
- [Why this work matters now]
|
||||
- [User feedback driving it]
|
||||
- [Technical debt or improvements needed]
|
||||
|
||||
**Scope (v[X.Y]):**
|
||||
- [Feature/improvement 1]
|
||||
- [Feature/improvement 2]
|
||||
- [Feature/improvement 3]
|
||||
|
||||
**Success Criteria:**
|
||||
- [ ] [Measurable outcome 1]
|
||||
- [ ] [Measurable outcome 2]
|
||||
- [ ] [Measurable outcome 3]
|
||||
|
||||
**Out of Scope:**
|
||||
- [Not doing X in this version]
|
||||
- [Not doing Y in this version]
|
||||
|
||||
---
|
||||
|
||||
<details>
|
||||
<summary>Original Vision (v1.0 - Archived for reference)</summary>
|
||||
|
||||
**One-liner**: [What this is in one sentence]
|
||||
|
||||
## Problem
|
||||
|
||||
[What problem does this solve? Why does it need to exist?]
|
||||
|
||||
## Success Criteria
|
||||
|
||||
How we know it worked:
|
||||
- [x] [Outcome 1] - Achieved
|
||||
- [x] [Outcome 2] - Achieved
|
||||
- [x] [Outcome 3] - Achieved
|
||||
|
||||
## Constraints
|
||||
|
||||
- [Constraint 1]
|
||||
- [Constraint 2]
|
||||
|
||||
## Out of Scope
|
||||
|
||||
- [Not doing X]
|
||||
- [Not doing Y]
|
||||
|
||||
</details>
|
||||
```
|
||||
|
||||
<brownfield_guidelines>
|
||||
**When to update BRIEF:**
|
||||
- After completing each milestone (v1.0 → v1.1 → v2.0)
|
||||
- When starting new phases after a shipped version
|
||||
- Use `complete-milestone.md` workflow to update systematically
|
||||
|
||||
**Current State captures:**
|
||||
- What shipped (version, date)
|
||||
- Real-world status (production, beta, etc.)
|
||||
- User metrics (if applicable)
|
||||
- User feedback themes
|
||||
- Codebase stats (LOC, tech stack)
|
||||
- Known issues needing attention
|
||||
|
||||
**Next Goals captures:**
|
||||
- Vision for next version
|
||||
- Why now (motivation)
|
||||
- What's in scope
|
||||
- What's measurable
|
||||
- What's explicitly out
|
||||
|
||||
**Original Vision:**
|
||||
- Collapsed in `<details>` tag
|
||||
- Reference for "where we came from"
|
||||
- Shows evolution of product thinking
|
||||
- Checkboxes marked [x] for achieved goals
|
||||
|
||||
This structure makes all new plans brownfield-aware automatically because they read BRIEF and see:
|
||||
- "v1.0 shipped"
|
||||
- "2,450 lines of existing Swift code"
|
||||
- "Users reporting X, requesting Y"
|
||||
- Plans naturally reference existing files in @context
|
||||
</brownfield_guidelines>
|
||||
|
||||
Reference in New Issue
Block a user