chore: seed BuildPulse v0.1 documentation package
This commit is contained in:
+171
@@ -0,0 +1,171 @@
|
||||
# BuildPulse v0.1 Scope
|
||||
|
||||
## Release Goal
|
||||
|
||||
Build a tiny, useful, single-project planning cockpit with pulse-compatible progress logging and exportable AI handoff context.
|
||||
|
||||
## v0.1 Core Question
|
||||
|
||||
Can BuildPulse help the user keep one project scoped, visible, and handoff-ready for AI-assisted development?
|
||||
|
||||
## In Scope
|
||||
|
||||
### 1. Single Project
|
||||
|
||||
The app supports one active project.
|
||||
The project has:
|
||||
- Name
|
||||
- One-line pitch
|
||||
- Description
|
||||
- Current goal
|
||||
- Notes
|
||||
|
||||
No multiple projects in v0.1.
|
||||
|
||||
### 2. Feature Plan
|
||||
|
||||
The user can create, edit, delete, and organize features.
|
||||
|
||||
Feature columns:
|
||||
- Now
|
||||
- Next
|
||||
- Later
|
||||
- Done
|
||||
|
||||
Feature fields:
|
||||
- Title
|
||||
- Description
|
||||
- Status/column
|
||||
- Priority
|
||||
- Acceptance criteria
|
||||
- Scope notes
|
||||
- Created date
|
||||
- Updated date
|
||||
|
||||
### 3. Parking Lot
|
||||
|
||||
The user can add, edit, delete, and review parked ideas.
|
||||
|
||||
Parking Lot item fields:
|
||||
- Title
|
||||
- Description
|
||||
- Reason parked
|
||||
- Possible future placement
|
||||
- Risk level
|
||||
- Created date
|
||||
|
||||
### 4. Pulse Log
|
||||
|
||||
The user can manually add Pulse events.
|
||||
|
||||
Pulse event fields:
|
||||
- Timestamp
|
||||
- Feature link, optional
|
||||
- Source/agent
|
||||
- Pulse type
|
||||
- Message
|
||||
- Confidence score
|
||||
- Evidence refs
|
||||
- Trace ID, optional
|
||||
|
||||
Pulse types:
|
||||
- INTENT
|
||||
- ACTION
|
||||
- RESULT
|
||||
- BLOCKER
|
||||
- DECISION
|
||||
- PARKED_IDEA
|
||||
- TEST_RESULT
|
||||
- SESSION_START
|
||||
- SESSION_END
|
||||
- REFLECTION
|
||||
|
||||
### 5. Export
|
||||
|
||||
The user can export:
|
||||
- Full project JSON
|
||||
- Pulse log as JSONL
|
||||
- Markdown context package
|
||||
|
||||
Markdown exports:
|
||||
- PROJECT_SUMMARY.md
|
||||
- FEATURE_PLAN.md
|
||||
- PARKING_LOT.md
|
||||
- PULSE_LOG.md
|
||||
- CLAUDE_CONTEXT.md
|
||||
|
||||
### 6. Local Persistence
|
||||
|
||||
The app persists data locally.
|
||||
Acceptable v0.1 storage:
|
||||
- LocalStorage
|
||||
- IndexedDB
|
||||
- JSON file export/import
|
||||
|
||||
No database required.
|
||||
|
||||
## Out of Scope for v0.1
|
||||
|
||||
Do not implement:
|
||||
- Multiple projects
|
||||
- Phases
|
||||
- Releases
|
||||
- AI triage
|
||||
- AI model provider settings
|
||||
- Local/cloud model routing
|
||||
- Real agent integration
|
||||
- OpenClaw integration
|
||||
- Claude Code direct integration
|
||||
- GitHub/Gitea integration
|
||||
- WebSockets
|
||||
- Backend authentication
|
||||
- Database
|
||||
- Multi-user collaboration
|
||||
- Notifications
|
||||
- Advanced analytics
|
||||
- Dependency graph
|
||||
- Calendar planning
|
||||
- Native mobile app
|
||||
- Automated progress computation
|
||||
|
||||
## Scope Guardrail
|
||||
|
||||
Any idea not required for v0.1 must be placed in Parking Lot.
|
||||
|
||||
## v0.1 Definition of Done
|
||||
|
||||
BuildPulse v0.1 is done when:
|
||||
1. The user can edit the single project summary.
|
||||
2. The user can add feature cards.
|
||||
3. The user can move features between Now, Next, Later, and Done.
|
||||
4. The user can add acceptance criteria to a feature.
|
||||
5. The user can add Parking Lot items.
|
||||
6. The user can manually add Pulse events.
|
||||
7. Pulse events can be linked to features.
|
||||
8. Pulse events display in chronological order.
|
||||
9. The app persists data locally after refresh.
|
||||
10. The user can export JSON.
|
||||
11. The user can export Pulse events as JSONL.
|
||||
12. The user can export Markdown context.
|
||||
13. The exported `CLAUDE_CONTEXT.md` is useful as an AI coding handoff.
|
||||
14. The app can be used to manage BuildPulse itself.
|
||||
|
||||
## v0.1 First Data Seed
|
||||
|
||||
On first run, optionally seed the app with BuildPulse as the active project.
|
||||
|
||||
Suggested starter features:
|
||||
|
||||
Now:
|
||||
- Feature Plan screen
|
||||
- Parking Lot screen
|
||||
- Pulse Log screen
|
||||
- Export screen
|
||||
|
||||
Parking Lot:
|
||||
- AI triage
|
||||
- Phases/releases
|
||||
- Multi-project support
|
||||
- Local/cloud model router
|
||||
- Real Agent Pulse event ingestion
|
||||
- Git integration
|
||||
Reference in New Issue
Block a user