@leeovery/claude-technical-workflows 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +283 -0
- package/agents/chain-verifier.md +129 -0
- package/commands/interview.md +54 -0
- package/commands/start-discussion.md +36 -0
- package/commands/start-implementation.md +107 -0
- package/commands/start-planning.md +92 -0
- package/commands/start-research.md +21 -0
- package/commands/start-specification.md +89 -0
- package/package.json +24 -0
- package/skills/.gitkeep +0 -0
- package/skills/technical-discussion/SKILL.md +68 -0
- package/skills/technical-discussion/references/guidelines.md +86 -0
- package/skills/technical-discussion/references/meeting-assistant.md +102 -0
- package/skills/technical-discussion/references/template.md +127 -0
- package/skills/technical-implementation/SKILL.md +167 -0
- package/skills/technical-implementation/references/code-quality.md +41 -0
- package/skills/technical-implementation/references/environment-setup.md +97 -0
- package/skills/technical-implementation/references/plan-execution.md +49 -0
- package/skills/technical-implementation/references/tdd-workflow.md +63 -0
- package/skills/technical-planning/SKILL.md +46 -0
- package/skills/technical-planning/references/formal-planning.md +118 -0
- package/skills/technical-planning/references/output-backlog-md.md +227 -0
- package/skills/technical-planning/references/output-beads.md +302 -0
- package/skills/technical-planning/references/output-formats.md +14 -0
- package/skills/technical-planning/references/output-linear.md +211 -0
- package/skills/technical-planning/references/output-local-markdown.md +185 -0
- package/skills/technical-research/SKILL.md +81 -0
- package/skills/technical-review/SKILL.md +107 -0
- package/skills/technical-review/references/review-checklist.md +155 -0
- package/skills/technical-review/references/template.md +46 -0
- package/skills/technical-specification/SKILL.md +51 -0
- package/skills/technical-specification/references/specification-guide.md +170 -0
|
@@ -0,0 +1,227 @@
|
|
|
1
|
+
# Output: Backlog.md
|
|
2
|
+
|
|
3
|
+
*Output adapter for **[technical-planning](../SKILL.md)***
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Use this output format when you want a **local Kanban board with MCP integration**. Backlog.md is a markdown-native task manager designed for Git repositories with AI assistant support.
|
|
8
|
+
|
|
9
|
+
## About Backlog.md
|
|
10
|
+
|
|
11
|
+
Backlog.md is a CLI + web Kanban tool that:
|
|
12
|
+
- Stores tasks as individual markdown files in `backlog/` directory
|
|
13
|
+
- Has MCP (Model Context Protocol) support for Claude Code
|
|
14
|
+
- Provides terminal and web Kanban views
|
|
15
|
+
- Supports dependencies, priorities, assignees
|
|
16
|
+
- Built for Git workflows with auto-commit
|
|
17
|
+
|
|
18
|
+
See: https://github.com/MrLesk/Backlog.md
|
|
19
|
+
|
|
20
|
+
## Setup
|
|
21
|
+
|
|
22
|
+
Install via npm:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npm install -g backlog-md
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Initialize in your project:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
backlog init "Project Name"
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
For MCP integration, configure the Backlog.md MCP server in Claude Code settings.
|
|
35
|
+
|
|
36
|
+
## Output Location
|
|
37
|
+
|
|
38
|
+
For Backlog.md integration, use the project's `backlog/` directory:
|
|
39
|
+
|
|
40
|
+
```
|
|
41
|
+
backlog/
|
|
42
|
+
├── task-1 - Phase 1 Setup.md
|
|
43
|
+
├── task-2 - Implement login endpoint.md
|
|
44
|
+
└── task-3 - Add session management.md
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
The plan file in `docs/workflow/planning/{topic}.md` serves as the reference pointer to backlog tasks.
|
|
48
|
+
|
|
49
|
+
## File Structure
|
|
50
|
+
|
|
51
|
+
### Plan Reference File (`docs/workflow/planning/{topic}.md`)
|
|
52
|
+
|
|
53
|
+
```markdown
|
|
54
|
+
---
|
|
55
|
+
format: backlog-md
|
|
56
|
+
project: {TOPIC_NAME}
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
# Plan Reference: {Topic Name}
|
|
60
|
+
|
|
61
|
+
**Specification**: `docs/workflow/specification/{topic}.md`
|
|
62
|
+
**Created**: {DATE}
|
|
63
|
+
|
|
64
|
+
## About This Plan
|
|
65
|
+
|
|
66
|
+
This plan is managed via Backlog.md. Tasks are stored in the `backlog/` directory.
|
|
67
|
+
|
|
68
|
+
## How to Use
|
|
69
|
+
|
|
70
|
+
**View the board**: Run `backlog board` (terminal) or `backlog browser` (web UI)
|
|
71
|
+
|
|
72
|
+
**Implementation will**:
|
|
73
|
+
1. Read this file to identify the plan
|
|
74
|
+
2. Query backlog via MCP or read task files directly
|
|
75
|
+
3. Work through tasks by status/priority
|
|
76
|
+
4. Update task status as work completes
|
|
77
|
+
|
|
78
|
+
**To add tasks**: Run `backlog add "Task title"` or create task files directly.
|
|
79
|
+
|
|
80
|
+
## Phases
|
|
81
|
+
|
|
82
|
+
Tasks are organized with labels/priorities:
|
|
83
|
+
- Label: `phase-1`, `phase-2`, etc.
|
|
84
|
+
- Priority: high (foundational), medium (core), low (refinement)
|
|
85
|
+
|
|
86
|
+
## Key Decisions
|
|
87
|
+
|
|
88
|
+
[Summary of key decisions from specification]
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### Task File Format
|
|
92
|
+
|
|
93
|
+
Each task is a separate file: `backlog/task-{id} - {title}.md`
|
|
94
|
+
|
|
95
|
+
Tasks should be **fully self-contained** - include all context so humans and agents can execute without referencing other files.
|
|
96
|
+
|
|
97
|
+
```markdown
|
|
98
|
+
---
|
|
99
|
+
status: To Do
|
|
100
|
+
priority: high
|
|
101
|
+
labels: [phase-1, api]
|
|
102
|
+
---
|
|
103
|
+
|
|
104
|
+
# {Task Title}
|
|
105
|
+
|
|
106
|
+
## Goal
|
|
107
|
+
|
|
108
|
+
{What this task accomplishes and why - include rationale from specification}
|
|
109
|
+
|
|
110
|
+
## Implementation
|
|
111
|
+
|
|
112
|
+
{The "Do" - specific files, methods, approach}
|
|
113
|
+
|
|
114
|
+
## Acceptance Criteria
|
|
115
|
+
|
|
116
|
+
1. [ ] Test written: `it does expected behavior`
|
|
117
|
+
2. [ ] Test written: `it handles edge case`
|
|
118
|
+
3. [ ] Implementation complete
|
|
119
|
+
4. [ ] Tests passing
|
|
120
|
+
5. [ ] Committed
|
|
121
|
+
|
|
122
|
+
## Edge Cases
|
|
123
|
+
|
|
124
|
+
{Specific edge cases for this task}
|
|
125
|
+
|
|
126
|
+
## Context
|
|
127
|
+
|
|
128
|
+
{Relevant decisions and constraints from specification}
|
|
129
|
+
|
|
130
|
+
Specification reference: `docs/workflow/specification/{topic}.md` (for ambiguity resolution)
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### Frontmatter Fields
|
|
134
|
+
|
|
135
|
+
| Field | Purpose | Values |
|
|
136
|
+
|-------|---------|--------|
|
|
137
|
+
| `status` | Workflow state | To Do, In Progress, Done |
|
|
138
|
+
| `priority` | Importance | high, medium, low |
|
|
139
|
+
| `labels` | Categories | `[phase-1, api, edge-case, needs-info]` |
|
|
140
|
+
| `assignee` | Who's working on it | (optional) |
|
|
141
|
+
| `dependencies` | Blocking tasks | `[task-1, task-3]` |
|
|
142
|
+
|
|
143
|
+
### Using `needs-info` Label
|
|
144
|
+
|
|
145
|
+
When creating tasks with incomplete information:
|
|
146
|
+
|
|
147
|
+
1. **Create the task anyway** - don't block planning
|
|
148
|
+
2. **Add `needs-info` to labels** - makes gaps visible
|
|
149
|
+
3. **Note what's missing** in task body - be specific
|
|
150
|
+
4. **Continue planning** - circle back later
|
|
151
|
+
|
|
152
|
+
This allows iterative refinement. Create all tasks, identify gaps, circle back to specification if needed, then update tasks with missing detail.
|
|
153
|
+
|
|
154
|
+
## Phase Representation
|
|
155
|
+
|
|
156
|
+
Since Backlog.md doesn't have native milestones, represent phases via:
|
|
157
|
+
|
|
158
|
+
1. **Labels**: `phase-1`, `phase-2`, etc.
|
|
159
|
+
2. **Task naming**: Prefix with phase number `task-X - [P1] Task name.md`
|
|
160
|
+
3. **Priority**: Foundation tasks = high, refinement = low
|
|
161
|
+
|
|
162
|
+
## Benefits
|
|
163
|
+
|
|
164
|
+
- Visual Kanban board in terminal or web UI
|
|
165
|
+
- Local and fully version-controlled
|
|
166
|
+
- MCP integration for Claude Code
|
|
167
|
+
- Auto-commit on task changes
|
|
168
|
+
- Individual task files for easy editing
|
|
169
|
+
|
|
170
|
+
## MCP Integration
|
|
171
|
+
|
|
172
|
+
If Backlog.md MCP server is configured, planning can:
|
|
173
|
+
- Create tasks via MCP tools
|
|
174
|
+
- Set status, priority, labels
|
|
175
|
+
- Query existing tasks
|
|
176
|
+
|
|
177
|
+
Implementation can:
|
|
178
|
+
- Query tasks by status/label
|
|
179
|
+
- Update task status as work completes
|
|
180
|
+
- Add notes to tasks
|
|
181
|
+
|
|
182
|
+
## Resulting Structure
|
|
183
|
+
|
|
184
|
+
After planning:
|
|
185
|
+
|
|
186
|
+
```
|
|
187
|
+
project/
|
|
188
|
+
├── backlog/
|
|
189
|
+
│ ├── task-1 - [P1] Configure auth.md
|
|
190
|
+
│ ├── task-2 - [P1] Add login endpoint.md
|
|
191
|
+
│ └── task-3 - [P2] Session management.md
|
|
192
|
+
├── docs/workflow/
|
|
193
|
+
│ ├── discussion/{topic}.md # Phase 2 output
|
|
194
|
+
│ ├── specification/{topic}.md # Phase 3 output
|
|
195
|
+
│ └── planning/{topic}.md # Phase 4 output (format: backlog-md - pointer)
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
## Implementation
|
|
199
|
+
|
|
200
|
+
### Reading Plans
|
|
201
|
+
|
|
202
|
+
1. If Backlog.md MCP is available, query tasks via MCP
|
|
203
|
+
2. Otherwise, read task files from `backlog/` directory
|
|
204
|
+
3. Filter tasks by label (e.g., `phase-1`) or naming convention
|
|
205
|
+
4. Process in priority order (high → medium → low)
|
|
206
|
+
|
|
207
|
+
### Updating Progress
|
|
208
|
+
|
|
209
|
+
- Update task status to "In Progress" when starting
|
|
210
|
+
- Check off acceptance criteria items in task file
|
|
211
|
+
- Update status to "Done" when complete
|
|
212
|
+
- Backlog.md CLI auto-moves to completed folder
|
|
213
|
+
|
|
214
|
+
### Fallback
|
|
215
|
+
|
|
216
|
+
Can read `backlog/` files directly if MCP unavailable.
|
|
217
|
+
|
|
218
|
+
## CLI Commands Reference
|
|
219
|
+
|
|
220
|
+
```bash
|
|
221
|
+
backlog init "Project" # Initialize backlog
|
|
222
|
+
backlog add "Task title" # Add task
|
|
223
|
+
backlog board # Terminal Kanban view
|
|
224
|
+
backlog browser # Web UI
|
|
225
|
+
backlog list # List all tasks
|
|
226
|
+
backlog search "query" # Search tasks
|
|
227
|
+
```
|
|
@@ -0,0 +1,302 @@
|
|
|
1
|
+
# Output: Beads
|
|
2
|
+
|
|
3
|
+
*Output adapter for **[technical-planning](../SKILL.md)***
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Use this output format when you need **dependency-aware task tracking designed for AI agents**. Beads is a git-backed graph issue tracker that excels at complex, multi-phase implementations with real dependency management.
|
|
8
|
+
|
|
9
|
+
## About Beads
|
|
10
|
+
|
|
11
|
+
Beads (`bd`) is an issue tracker built specifically for AI agents:
|
|
12
|
+
- Git-backed storage in `.beads/` directory (JSONL format)
|
|
13
|
+
- Hash-based IDs (`bd-a1b2`) prevent merge conflicts
|
|
14
|
+
- Native dependency graph with blocking relationships
|
|
15
|
+
- Hierarchical tasks: epics → tasks → subtasks
|
|
16
|
+
- `bd ready` command identifies unblocked work
|
|
17
|
+
- Semantic summarization preserves context windows
|
|
18
|
+
- Multi-agent coordination via sync protocol
|
|
19
|
+
|
|
20
|
+
See: https://github.com/steveyegge/beads
|
|
21
|
+
|
|
22
|
+
## Setup
|
|
23
|
+
|
|
24
|
+
### 1. Check Installation
|
|
25
|
+
|
|
26
|
+
Check if beads is installed (required every session in ephemeral environments):
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
which bd
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
- **Local systems**: May already be installed via Homebrew
|
|
33
|
+
- **Ephemeral environments** (Claude Code on web): Needs installation each session
|
|
34
|
+
|
|
35
|
+
If not installed:
|
|
36
|
+
```bash
|
|
37
|
+
curl -sSL https://raw.githubusercontent.com/steveyegge/beads/main/scripts/install.sh | bash
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### 2. Check If Project Initialized
|
|
41
|
+
|
|
42
|
+
Check if beads is already set up in this project:
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
ls .beads/config.yaml
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
**If `.beads/` exists**: Project is already initialized - skip to using beads.
|
|
49
|
+
|
|
50
|
+
**If not initialized**: Continue with steps 3 and 4.
|
|
51
|
+
|
|
52
|
+
### 3. Choose Database Mode
|
|
53
|
+
|
|
54
|
+
Beads supports two modes. Ask the user:
|
|
55
|
+
|
|
56
|
+
> "Beads can run with or without a local database. Database mode uses a daemon that auto-syncs to JSONL. No-database mode writes directly to JSONL. Which do you prefer? (default: database)"
|
|
57
|
+
|
|
58
|
+
### 4. Initialize
|
|
59
|
+
|
|
60
|
+
Based on the user's choice:
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
bd init --quiet # database mode (default)
|
|
64
|
+
bd init --quiet --no-db # no-database mode
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
This creates `.beads/config.yaml` with the appropriate `no-db` setting.
|
|
68
|
+
|
|
69
|
+
## Benefits
|
|
70
|
+
|
|
71
|
+
- Complex dependency graphs with native blocking relationships
|
|
72
|
+
- Multi-session context preservation via semantic summarization
|
|
73
|
+
- Multi-agent coordination support
|
|
74
|
+
- `bd ready` identifies actionable unblocked work
|
|
75
|
+
- Git-backed and version-controlled
|
|
76
|
+
|
|
77
|
+
## Beads Structure Mapping
|
|
78
|
+
|
|
79
|
+
| Planning Concept | Beads Entity |
|
|
80
|
+
|------------------|--------------|
|
|
81
|
+
| Plan | Epic issue |
|
|
82
|
+
| Phase | Sub-issue under epic |
|
|
83
|
+
| Task | Sub-task under phase |
|
|
84
|
+
| Dependency | `bd dep add` relationship |
|
|
85
|
+
|
|
86
|
+
Example hierarchy:
|
|
87
|
+
```
|
|
88
|
+
bd-a3f8 (Epic: User Authentication)
|
|
89
|
+
├── bd-a3f8.1 (Phase 1: Core Auth)
|
|
90
|
+
│ ├── bd-a3f8.1.1 (Task: Login endpoint)
|
|
91
|
+
│ └── bd-a3f8.1.2 (Task: Session management)
|
|
92
|
+
└── bd-a3f8.2 (Phase 2: OAuth)
|
|
93
|
+
└── bd-a3f8.2.1 (Task: Google provider)
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
## Output Process
|
|
97
|
+
|
|
98
|
+
### 1. Create Epic for Plan
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
bd create "Plan: {Topic Name}" -p 1
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
Note the returned ID (e.g., `bd-a3f8`). This is the plan epic.
|
|
105
|
+
|
|
106
|
+
### 2. Create Phase Issues
|
|
107
|
+
|
|
108
|
+
For each phase, create a sub-issue under the epic:
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
bd create "Phase 1: {Phase Name}" -p 1 --parent bd-a3f8
|
|
112
|
+
bd create "Phase 2: {Phase Name}" -p 2 --parent bd-a3f8
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
Add phase acceptance criteria in the issue body.
|
|
116
|
+
|
|
117
|
+
### 3. Create Task Issues
|
|
118
|
+
|
|
119
|
+
For each task, create under the appropriate phase:
|
|
120
|
+
|
|
121
|
+
```bash
|
|
122
|
+
bd create "{Task Name}" -p 1 --parent bd-a3f8.1
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
Tasks should be **fully self-contained** - include all context so humans and agents can execute without referencing other files.
|
|
126
|
+
|
|
127
|
+
Task body should include:
|
|
128
|
+
```
|
|
129
|
+
## Goal
|
|
130
|
+
{What this task accomplishes and why - include rationale from specification}
|
|
131
|
+
|
|
132
|
+
## Implementation
|
|
133
|
+
{Specific files, methods, approach}
|
|
134
|
+
|
|
135
|
+
## Tests
|
|
136
|
+
- `it does expected behavior`
|
|
137
|
+
- `it handles edge case`
|
|
138
|
+
|
|
139
|
+
## Edge Cases
|
|
140
|
+
{Specific edge cases for this task}
|
|
141
|
+
|
|
142
|
+
## Context
|
|
143
|
+
{Relevant decisions and constraints from specification}
|
|
144
|
+
|
|
145
|
+
Specification reference: docs/workflow/specification/{topic}.md (for ambiguity resolution)
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### 4. Add Dependencies
|
|
149
|
+
|
|
150
|
+
When tasks depend on each other:
|
|
151
|
+
|
|
152
|
+
```bash
|
|
153
|
+
bd dep add bd-a3f8.1.2 bd-a3f8.1.1 # 1.2 blocked by 1.1
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
### 5. Create Local Plan File
|
|
157
|
+
|
|
158
|
+
Create `docs/workflow/planning/{topic}.md`:
|
|
159
|
+
|
|
160
|
+
```markdown
|
|
161
|
+
---
|
|
162
|
+
format: beads
|
|
163
|
+
epic: bd-{EPIC_ID}
|
|
164
|
+
---
|
|
165
|
+
|
|
166
|
+
# Plan Reference: {Topic Name}
|
|
167
|
+
|
|
168
|
+
**Specification**: `docs/workflow/specification/{topic}.md`
|
|
169
|
+
**Created**: {DATE}
|
|
170
|
+
|
|
171
|
+
## About This Plan
|
|
172
|
+
|
|
173
|
+
This plan is managed via Beads. Tasks are stored in `.beads/` and tracked as a dependency graph.
|
|
174
|
+
|
|
175
|
+
## How to Use
|
|
176
|
+
|
|
177
|
+
**View ready tasks**: Run `bd ready`
|
|
178
|
+
**View all tasks**: Run `bd list --tree`
|
|
179
|
+
**View specific task**: Run `bd show bd-{id}`
|
|
180
|
+
|
|
181
|
+
**Implementation will**:
|
|
182
|
+
1. Read this file to identify the epic
|
|
183
|
+
2. Query `bd ready` for unblocked tasks
|
|
184
|
+
3. Work through tasks respecting dependencies
|
|
185
|
+
4. Close tasks with `bd close bd-{id} "reason"`
|
|
186
|
+
|
|
187
|
+
## Key Decisions
|
|
188
|
+
|
|
189
|
+
[Summary of key decisions from specification]
|
|
190
|
+
|
|
191
|
+
## Phase Overview
|
|
192
|
+
|
|
193
|
+
| Phase | Goal | Epic ID |
|
|
194
|
+
|-------|------|---------|
|
|
195
|
+
| Phase 1 | {Goal} | bd-{id}.1 |
|
|
196
|
+
| Phase 2 | {Goal} | bd-{id}.2 |
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
## Frontmatter
|
|
200
|
+
|
|
201
|
+
The `format: beads` frontmatter tells implementation to use beads CLI:
|
|
202
|
+
|
|
203
|
+
```yaml
|
|
204
|
+
---
|
|
205
|
+
format: beads
|
|
206
|
+
epic: bd-a3f8
|
|
207
|
+
---
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
## Flagging Incomplete Tasks
|
|
211
|
+
|
|
212
|
+
When information is missing, note it in the task body:
|
|
213
|
+
|
|
214
|
+
```bash
|
|
215
|
+
bd create "Configure rate limiting [needs-info]" -p 2 --parent bd-a3f8.1
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
In the task body:
|
|
219
|
+
```
|
|
220
|
+
## Needs Clarification
|
|
221
|
+
- What's the rate limit threshold?
|
|
222
|
+
- Per-user or per-IP?
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
## Implementation
|
|
226
|
+
|
|
227
|
+
### Reading Plans
|
|
228
|
+
|
|
229
|
+
1. Extract `epic` ID from frontmatter
|
|
230
|
+
2. Check `.beads/config.yaml` for `no-db` setting
|
|
231
|
+
3. Run `bd ready` to get unblocked tasks
|
|
232
|
+
4. View task details with `bd show bd-{id}`
|
|
233
|
+
5. Process by priority (P0 → P1 → P2 → P3)
|
|
234
|
+
6. Respect dependency graph - only work on ready tasks
|
|
235
|
+
|
|
236
|
+
### Updating Progress
|
|
237
|
+
|
|
238
|
+
- Close tasks with `bd close bd-{id} "reason"` when complete
|
|
239
|
+
- Include task ID in commit messages: `git commit -m "message (bd-{id})"`
|
|
240
|
+
- **Database mode**: Run `bd sync` before committing or ending session to ensure changes are persisted
|
|
241
|
+
- **No-db mode**: No sync needed - changes write directly to JSONL
|
|
242
|
+
- Use `bd ready` to identify next unblocked task
|
|
243
|
+
|
|
244
|
+
### Fallback
|
|
245
|
+
|
|
246
|
+
If `bd` CLI is unavailable, follow the installation steps in the **Setup** section above.
|
|
247
|
+
|
|
248
|
+
## Beads Workflow Commands
|
|
249
|
+
|
|
250
|
+
| Command | Purpose |
|
|
251
|
+
|---------|---------|
|
|
252
|
+
| `bd ready` | List tasks with no open blockers |
|
|
253
|
+
| `bd list --tree` | Show full task hierarchy |
|
|
254
|
+
| `bd show bd-{id}` | View task details |
|
|
255
|
+
| `bd close bd-{id} "reason"` | Complete a task |
|
|
256
|
+
| `bd dep add child parent` | Add dependency |
|
|
257
|
+
| `bd sync` | Force immediate sync to JSONL (database mode only) |
|
|
258
|
+
|
|
259
|
+
## Sync Protocol (Database Mode Only)
|
|
260
|
+
|
|
261
|
+
In database mode, a daemon auto-syncs changes to JSONL with a ~5 second debounce. Run `bd sync` before committing or ending a session to ensure all pending changes are persisted:
|
|
262
|
+
|
|
263
|
+
```bash
|
|
264
|
+
bd sync
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
**Skip this entirely if `no-db: true`** - changes write directly to JSONL, no sync needed.
|
|
268
|
+
|
|
269
|
+
## Commit Message Convention
|
|
270
|
+
|
|
271
|
+
Include issue IDs in commits:
|
|
272
|
+
|
|
273
|
+
```bash
|
|
274
|
+
git commit -m "Add login endpoint (bd-a3f8.1.1)"
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
This enables `bd doctor` to identify orphaned issues.
|
|
278
|
+
|
|
279
|
+
## Resulting Structure
|
|
280
|
+
|
|
281
|
+
After planning:
|
|
282
|
+
|
|
283
|
+
```
|
|
284
|
+
project/
|
|
285
|
+
├── .beads/
|
|
286
|
+
│ └── issues.jsonl # Beads database
|
|
287
|
+
├── docs/workflow/
|
|
288
|
+
│ ├── discussion/{topic}.md # Phase 2 output
|
|
289
|
+
│ ├── specification/{topic}.md # Phase 3 output
|
|
290
|
+
│ └── planning/{topic}.md # Phase 4 output (format: beads)
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
## Priority Mapping
|
|
294
|
+
|
|
295
|
+
| Planning Priority | Beads Priority |
|
|
296
|
+
|-------------------|----------------|
|
|
297
|
+
| Foundation/Setup | P0 |
|
|
298
|
+
| Core functionality | P1 |
|
|
299
|
+
| Enhancement | P2 |
|
|
300
|
+
| Nice-to-have | P3 |
|
|
301
|
+
|
|
302
|
+
Use `-p {0-3}` flag when creating issues.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Output Formats
|
|
2
|
+
|
|
3
|
+
*Reference for **[technical-planning](../SKILL.md)***
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Plans can be stored in different formats. **Ask the user which format they prefer** - present the benefits from each adapter file and let them decide.
|
|
8
|
+
|
|
9
|
+
## Available Formats
|
|
10
|
+
|
|
11
|
+
- **[Local Markdown](output-local-markdown.md)** - Single markdown file, no external tools
|
|
12
|
+
- **[Linear](output-linear.md)** - Linear project with labeled issues (requires MCP)
|
|
13
|
+
- **[Backlog.md](output-backlog-md.md)** - Kanban board with task files
|
|
14
|
+
- **[Beads](output-beads.md)** - Git-backed graph issue tracker for AI agents
|