@comfanion/workflow 3.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/README.md +185 -0
- package/bin/cli.js +406 -0
- package/package.json +50 -0
- package/src/build-info.json +16 -0
- package/src/opencode/ARCHITECTURE.md +255 -0
- package/src/opencode/FLOW.yaml +900 -0
- package/src/opencode/agents/analyst.md +141 -0
- package/src/opencode/agents/architect.md +177 -0
- package/src/opencode/agents/change-manager.md +263 -0
- package/src/opencode/agents/dev.md +171 -0
- package/src/opencode/agents/module-docs.md +628 -0
- package/src/opencode/agents/pm.md +157 -0
- package/src/opencode/agents/researcher.md +254 -0
- package/src/opencode/agents/sm.md +184 -0
- package/src/opencode/agents/workflow-orchestrator.md +249 -0
- package/src/opencode/checklists/architecture-checklist.md +166 -0
- package/src/opencode/checklists/code-review-checklist.md +151 -0
- package/src/opencode/checklists/prd-checklist.md +140 -0
- package/src/opencode/checklists/requirements-checklist.md +86 -0
- package/src/opencode/checklists/story-checklist.md +137 -0
- package/src/opencode/commands/architecture.md +68 -0
- package/src/opencode/commands/archive.md +146 -0
- package/src/opencode/commands/change.md +169 -0
- package/src/opencode/commands/clarify.md +132 -0
- package/src/opencode/commands/code-review.md +96 -0
- package/src/opencode/commands/coding-standards.md +102 -0
- package/src/opencode/commands/dev-story.md +80 -0
- package/src/opencode/commands/diagram.md +152 -0
- package/src/opencode/commands/epics.md +52 -0
- package/src/opencode/commands/help.md +139 -0
- package/src/opencode/commands/jira-sync.md +58 -0
- package/src/opencode/commands/module-docs.md +158 -0
- package/src/opencode/commands/prd.md +63 -0
- package/src/opencode/commands/quick.md +166 -0
- package/src/opencode/commands/requirements.md +49 -0
- package/src/opencode/commands/research.md +113 -0
- package/src/opencode/commands/sprint-plan.md +59 -0
- package/src/opencode/commands/stories.md +61 -0
- package/src/opencode/commands/validate.md +84 -0
- package/src/opencode/commands/workflow-status.md +150 -0
- package/src/opencode/config.yaml +223 -0
- package/src/opencode/opencode.json +36 -0
- package/src/opencode/skills/acceptance-criteria/SKILL.md +212 -0
- package/src/opencode/skills/adr-writing/SKILL.md +241 -0
- package/src/opencode/skills/architecture-design/SKILL.md +183 -0
- package/src/opencode/skills/architecture-validation/SKILL.md +199 -0
- package/src/opencode/skills/archiving/SKILL.md +191 -0
- package/src/opencode/skills/changelog/SKILL.md +280 -0
- package/src/opencode/skills/code-review/SKILL.md +193 -0
- package/src/opencode/skills/coding-standards/SKILL.md +430 -0
- package/src/opencode/skills/diagram-creation/SKILL.md +273 -0
- package/src/opencode/skills/doc-todo/SKILL.md +325 -0
- package/src/opencode/skills/epic-writing/SKILL.md +291 -0
- package/src/opencode/skills/jira-integration/SKILL.md +560 -0
- package/src/opencode/skills/methodologies/SKILL.md +376 -0
- package/src/opencode/skills/module-documentation/SKILL.md +214 -0
- package/src/opencode/skills/prd-validation/SKILL.md +164 -0
- package/src/opencode/skills/prd-writing/SKILL.md +104 -0
- package/src/opencode/skills/requirements-gathering/SKILL.md +132 -0
- package/src/opencode/skills/requirements-validation/SKILL.md +141 -0
- package/src/opencode/skills/research-methodology/SKILL.md +140 -0
- package/src/opencode/skills/sprint-planning/SKILL.md +217 -0
- package/src/opencode/skills/story-writing/SKILL.md +574 -0
- package/src/opencode/skills/test-design/SKILL.md +313 -0
- package/src/opencode/skills/translation/SKILL.md +411 -0
- package/src/opencode/templates/CHANGELOG.md +82 -0
- package/src/opencode/templates/adr-template.md +115 -0
- package/src/opencode/templates/architecture-template.md +362 -0
- package/src/opencode/templates/change-proposal-template.md +186 -0
- package/src/opencode/templates/epic-template.md +151 -0
- package/src/opencode/templates/git-workflow-template.md +384 -0
- package/src/opencode/templates/integration-tests-template.md +265 -0
- package/src/opencode/templates/jira-cache-template.yaml +103 -0
- package/src/opencode/templates/module-index-template.md +139 -0
- package/src/opencode/templates/module-test-cases-template.md +230 -0
- package/src/opencode/templates/prd-acceptance-criteria-template.md +124 -0
- package/src/opencode/templates/prd-template.md +479 -0
- package/src/opencode/templates/requirements-template.md +132 -0
- package/src/opencode/templates/sprint-status-template.yaml +84 -0
- package/src/opencode/templates/story-template.md +437 -0
- package/src/opencode/templates/testing-standards-template.md +359 -0
- package/src/opencode/workflows/dev-story/instructions.md +529 -0
- package/src/repo-structure/.gitattributes +64 -0
- package/src/repo-structure/CONTRIBUTING.md +182 -0
- package/src/repo-structure/README.md +77 -0
- package/src/repo-structure/docs/README.md +62 -0
- package/src/repo-structure/docs/api/README.md +43 -0
- package/src/repo-structure/docs/architecture/README.md +36 -0
- package/src/repo-structure/docs/architecture/adr/README.md +53 -0
- package/src/repo-structure/docs/architecture/diagrams/README.md +59 -0
- package/src/repo-structure/docs/coding-standards/README.md +52 -0
- package/src/repo-structure/docs/confluence/README.md +43 -0
- package/src/repo-structure/docs/requirements/README.md +28 -0
- package/src/repo-structure/docs/sprint-artifacts/README.md +76 -0
- package/src/repo-structure/docs/sprint-artifacts/backlog/README.md +24 -0
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Analyze project state and suggest next steps (context-aware guidance)
|
|
3
|
+
agent: workflow-orchestrator
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Help Command
|
|
7
|
+
|
|
8
|
+
## Arguments
|
|
9
|
+
$ARGUMENTS
|
|
10
|
+
|
|
11
|
+
- Empty: General guidance based on project state
|
|
12
|
+
- "[question]": Specific guidance for a question
|
|
13
|
+
- "blockers": Show blocking issues
|
|
14
|
+
- "quick-wins": Show easy improvements
|
|
15
|
+
|
|
16
|
+
## Analyze Current State
|
|
17
|
+
|
|
18
|
+
### Check All Documents
|
|
19
|
+
!`ls -la docs/requirements/requirements.md 2>/dev/null && echo "EXISTS" || echo "MISSING"`
|
|
20
|
+
!`ls -la docs/prd.md 2>/dev/null && echo "EXISTS" || echo "MISSING"`
|
|
21
|
+
!`ls -la docs/architecture.md 2>/dev/null && echo "EXISTS" || echo "MISSING"`
|
|
22
|
+
!`ls docs/coding-standards/*.md 2>/dev/null | wc -l | xargs echo "Coding Standards files:"`
|
|
23
|
+
!`ls docs/modules/*/README.md 2>/dev/null | wc -l | xargs echo "Module docs:"`
|
|
24
|
+
!`ls docs/sprint-artifacts/*/epic-*.md 2>/dev/null | wc -l | xargs echo "Epics:"`
|
|
25
|
+
!`cat docs/sprint-artifacts/sprint-status.yaml 2>/dev/null | head -20 || echo "No sprint status"`
|
|
26
|
+
|
|
27
|
+
### Check Document Sizes
|
|
28
|
+
!`wc -l docs/prd.md 2>/dev/null || echo "0"`
|
|
29
|
+
!`wc -l docs/architecture.md 2>/dev/null || echo "0"`
|
|
30
|
+
|
|
31
|
+
### Check for Stale Documents
|
|
32
|
+
!`ls -lt docs/*.md docs/**/*.md 2>/dev/null | head -10`
|
|
33
|
+
|
|
34
|
+
### Check Active Changes
|
|
35
|
+
!`ls docs/changes/*/proposal.md 2>/dev/null | wc -l | xargs echo "Active change proposals:"`
|
|
36
|
+
|
|
37
|
+
## Your Task
|
|
38
|
+
|
|
39
|
+
1. **Determine Project Scale**
|
|
40
|
+
- L0: Hotfix (single file)
|
|
41
|
+
- L1: Small (< 5 requirements)
|
|
42
|
+
- L2: Medium (5-20 requirements)
|
|
43
|
+
- L3: Large (20-50 requirements)
|
|
44
|
+
- L4: Enterprise (50+ requirements)
|
|
45
|
+
|
|
46
|
+
2. **Identify Current Phase**
|
|
47
|
+
- Requirements gathering
|
|
48
|
+
- Standards definition
|
|
49
|
+
- PRD creation
|
|
50
|
+
- Architecture design
|
|
51
|
+
- Module documentation
|
|
52
|
+
- Sprint planning
|
|
53
|
+
- Implementation
|
|
54
|
+
|
|
55
|
+
3. **Detect Issues**
|
|
56
|
+
- Missing prerequisites
|
|
57
|
+
- Stale documents
|
|
58
|
+
- Size overflows (> 2000 lines)
|
|
59
|
+
- Validation gaps
|
|
60
|
+
- Conflicting information
|
|
61
|
+
|
|
62
|
+
4. **Generate Recommendations**
|
|
63
|
+
- Required next steps
|
|
64
|
+
- Optional improvements
|
|
65
|
+
- Quick wins
|
|
66
|
+
|
|
67
|
+
## Response Format
|
|
68
|
+
|
|
69
|
+
```markdown
|
|
70
|
+
## 🎯 Project Status
|
|
71
|
+
|
|
72
|
+
**Scale:** L[N] ([type])
|
|
73
|
+
**Phase:** [current phase]
|
|
74
|
+
**Health:** [Good/Warning/Critical]
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
### 📊 Document Status
|
|
79
|
+
|
|
80
|
+
| Document | Status | Lines | Issues |
|
|
81
|
+
|----------|--------|-------|--------|
|
|
82
|
+
| Requirements | ✅/⚠️/❌ | N | [issue] |
|
|
83
|
+
| ...
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
### 🚨 Issues Found
|
|
88
|
+
|
|
89
|
+
[List any issues with severity and fix command]
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
### 📋 Recommended Next Steps
|
|
94
|
+
|
|
95
|
+
#### Required
|
|
96
|
+
1. [Step with command]
|
|
97
|
+
|
|
98
|
+
#### Optional
|
|
99
|
+
1. [Improvement with command]
|
|
100
|
+
|
|
101
|
+
#### Quick Wins
|
|
102
|
+
1. [Easy improvement]
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
### 💡 Context-Specific Tips
|
|
107
|
+
|
|
108
|
+
[Based on user's question if provided]
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
## Scale-Adaptive Suggestions
|
|
112
|
+
|
|
113
|
+
### L0 (Hotfix)
|
|
114
|
+
```
|
|
115
|
+
Skip full workflow. Just:
|
|
116
|
+
1. Document the change
|
|
117
|
+
2. Implement
|
|
118
|
+
3. Test
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### L1 (Small)
|
|
122
|
+
```
|
|
123
|
+
Minimal workflow:
|
|
124
|
+
1. Brief requirements
|
|
125
|
+
2. Implement
|
|
126
|
+
3. Basic tests
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### L2-L4 (Medium to Enterprise)
|
|
130
|
+
```
|
|
131
|
+
Full workflow with appropriate depth
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
## After Help
|
|
135
|
+
|
|
136
|
+
User can:
|
|
137
|
+
- Follow suggested commands
|
|
138
|
+
- Ask for clarification
|
|
139
|
+
- Request different approach
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Synchronize epics and stories with Jira
|
|
3
|
+
agent: sm
|
|
4
|
+
model: anthropic/claude-sonnet-4-20250514
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Jira Synchronization
|
|
8
|
+
|
|
9
|
+
## Arguments
|
|
10
|
+
$ARGUMENTS
|
|
11
|
+
|
|
12
|
+
- `full` or empty: Full sync (create missing, update existing)
|
|
13
|
+
- `status`: Sync status only
|
|
14
|
+
- `epic [id]`: Sync specific epic
|
|
15
|
+
|
|
16
|
+
## Prerequisites
|
|
17
|
+
|
|
18
|
+
**Config:** @.opencode/jira-config.yaml
|
|
19
|
+
|
|
20
|
+
**Environment:**
|
|
21
|
+
```bash
|
|
22
|
+
JIRA_USER=your-email@company.com
|
|
23
|
+
JIRA_API_TOKEN=your-api-token
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Task
|
|
27
|
+
|
|
28
|
+
1. Load skill: `jira-integration`
|
|
29
|
+
2. Read jira-config.yaml for settings
|
|
30
|
+
3. Based on mode:
|
|
31
|
+
|
|
32
|
+
### Full Sync
|
|
33
|
+
- Find all epics/stories without `jira_id`
|
|
34
|
+
- Create in Jira
|
|
35
|
+
- Store `jira_id` in files
|
|
36
|
+
- Update status for existing items
|
|
37
|
+
- Generate sync report
|
|
38
|
+
|
|
39
|
+
### Status Sync
|
|
40
|
+
- For items with `jira_id`
|
|
41
|
+
- Compare local vs Jira status
|
|
42
|
+
- Update whichever is behind
|
|
43
|
+
|
|
44
|
+
### Epic Sync
|
|
45
|
+
- Sync specific epic and its stories
|
|
46
|
+
|
|
47
|
+
## Output
|
|
48
|
+
|
|
49
|
+
- Updated epic/story files with Jira metadata
|
|
50
|
+
- Sync report: `docs/sprint-artifacts/jira-sync-report.md`
|
|
51
|
+
|
|
52
|
+
## Sync Report
|
|
53
|
+
|
|
54
|
+
Shows:
|
|
55
|
+
- Created issues
|
|
56
|
+
- Updated statuses
|
|
57
|
+
- Errors encountered
|
|
58
|
+
- Next actions
|
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Create detailed documentation for a module in docs/architecture/[module]/
|
|
3
|
+
agent: module-docs
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Module Documentation
|
|
7
|
+
|
|
8
|
+
## Arguments
|
|
9
|
+
$ARGUMENTS
|
|
10
|
+
|
|
11
|
+
- `[module-name]`: Create docs for specified module
|
|
12
|
+
- `list`: List existing modules
|
|
13
|
+
- `[module] add [type]`: Add specific file to module (api, events, scenarios, flows)
|
|
14
|
+
|
|
15
|
+
## Module Location
|
|
16
|
+
|
|
17
|
+
All modules live in `docs/architecture/[module-name]/`
|
|
18
|
+
|
|
19
|
+
## Prerequisites Check
|
|
20
|
+
|
|
21
|
+
1. **Main Architecture** - @docs/architecture.md (REQUIRED)
|
|
22
|
+
2. **PRD** - @docs/prd.md (REQUIRED)
|
|
23
|
+
|
|
24
|
+
!`ls -la docs/architecture.md 2>/dev/null || echo "ARCHITECTURE MISSING"`
|
|
25
|
+
!`ls -la docs/prd.md 2>/dev/null || echo "PRD MISSING"`
|
|
26
|
+
|
|
27
|
+
## Check Existing Modules
|
|
28
|
+
|
|
29
|
+
!`ls -la docs/architecture/ 2>/dev/null || echo "No modules yet"`
|
|
30
|
+
|
|
31
|
+
## Input Context
|
|
32
|
+
|
|
33
|
+
Load:
|
|
34
|
+
- @docs/architecture.md (REQUIRED)
|
|
35
|
+
- @docs/prd.md (REQUIRED)
|
|
36
|
+
- @docs/architecture-db.md (if exists)
|
|
37
|
+
- @docs/coding-standards/README.md
|
|
38
|
+
|
|
39
|
+
## Your Task
|
|
40
|
+
|
|
41
|
+
### Create Mode: `/module-docs [module-name]`
|
|
42
|
+
|
|
43
|
+
Create module directory and files:
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
docs/architecture/[module-name]/
|
|
47
|
+
├── index.md # Overview (ALWAYS)
|
|
48
|
+
├── architecture.md # Module architecture (ALWAYS)
|
|
49
|
+
├── prd.md # Module requirements (if needed)
|
|
50
|
+
├── data-model.md # DB schema (if has DB)
|
|
51
|
+
├── domain.md # Domain model (if DDD)
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
**Step by step:**
|
|
55
|
+
|
|
56
|
+
1. Create directory `docs/architecture/[module-name]/`
|
|
57
|
+
|
|
58
|
+
2. **index.md** (ALWAYS)
|
|
59
|
+
- Overview, purpose
|
|
60
|
+
- Quick links to other files
|
|
61
|
+
- Dependencies (depends on / depended by)
|
|
62
|
+
- Key metrics
|
|
63
|
+
|
|
64
|
+
3. **architecture.md** (ALWAYS)
|
|
65
|
+
- Context diagram (ASCII)
|
|
66
|
+
- Layers (domain, application, infrastructure)
|
|
67
|
+
- Boundaries (owns vs references)
|
|
68
|
+
- Use cases table
|
|
69
|
+
- Communication (inbound/outbound)
|
|
70
|
+
|
|
71
|
+
4. **prd.md** (if module has own requirements)
|
|
72
|
+
- Module-specific FRs
|
|
73
|
+
- Module-specific NFRs
|
|
74
|
+
- Subset of main PRD
|
|
75
|
+
|
|
76
|
+
5. **data-model.md** (if module has database)
|
|
77
|
+
- Schema diagram (ASCII)
|
|
78
|
+
- Tables with columns
|
|
79
|
+
- Indexes
|
|
80
|
+
- Relationships
|
|
81
|
+
- Migrations list
|
|
82
|
+
|
|
83
|
+
6. **domain.md** (if using DDD)
|
|
84
|
+
- Aggregates with diagrams
|
|
85
|
+
- State machines
|
|
86
|
+
- Value objects
|
|
87
|
+
- Domain services
|
|
88
|
+
- Domain events
|
|
89
|
+
|
|
90
|
+
### Add Mode: `/module-docs [module] add [type]`
|
|
91
|
+
|
|
92
|
+
Add subdirectory to existing module:
|
|
93
|
+
|
|
94
|
+
| Type | Creates |
|
|
95
|
+
|------|---------|
|
|
96
|
+
| `api` | `api/index.md`, `api/openapi.yaml` |
|
|
97
|
+
| `events` | `events/index.md` |
|
|
98
|
+
| `scenarios` | `scenarios/` directory |
|
|
99
|
+
| `flows` | `flows/` directory |
|
|
100
|
+
| `integrations` | `integrations/` directory |
|
|
101
|
+
| `decisions` | `decisions/adr-001.md` |
|
|
102
|
+
|
|
103
|
+
### List Mode: `/module-docs list`
|
|
104
|
+
|
|
105
|
+
Show all existing modules and their files.
|
|
106
|
+
|
|
107
|
+
## Writing Rules
|
|
108
|
+
|
|
109
|
+
1. **NO code** - Architecture and specs only
|
|
110
|
+
2. **ASCII diagrams** - Box drawing characters
|
|
111
|
+
3. **< 2000 lines** - Per file
|
|
112
|
+
4. **Cross-references** - Link to main architecture (`../../architecture.md`)
|
|
113
|
+
5. **Tables** - Structured, scannable
|
|
114
|
+
|
|
115
|
+
## Output Structure
|
|
116
|
+
|
|
117
|
+
```
|
|
118
|
+
docs/architecture/[module]/
|
|
119
|
+
├── index.md # Overview
|
|
120
|
+
├── architecture.md # Design
|
|
121
|
+
├── prd.md # Requirements
|
|
122
|
+
├── data-model.md # DB schema
|
|
123
|
+
├── domain.md # DDD model
|
|
124
|
+
│
|
|
125
|
+
├── api/ # If has API
|
|
126
|
+
│ ├── index.md
|
|
127
|
+
│ └── openapi.yaml
|
|
128
|
+
│
|
|
129
|
+
├── events/ # If event-driven
|
|
130
|
+
│ └── index.md
|
|
131
|
+
│
|
|
132
|
+
├── scenarios/ # Use case scenarios
|
|
133
|
+
│ └── [scenario].md
|
|
134
|
+
│
|
|
135
|
+
├── flows/ # Flow diagrams
|
|
136
|
+
│ └── [flow].md
|
|
137
|
+
│
|
|
138
|
+
└── integrations/ # External integrations
|
|
139
|
+
└── [system].md
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
## Validation
|
|
143
|
+
|
|
144
|
+
After creating, verify:
|
|
145
|
+
- [ ] index.md and architecture.md present
|
|
146
|
+
- [ ] Each file < 2000 lines
|
|
147
|
+
- [ ] No code examples
|
|
148
|
+
- [ ] ASCII diagrams present
|
|
149
|
+
- [ ] Cross-references work (../../architecture.md)
|
|
150
|
+
- [ ] Aligns with main architecture
|
|
151
|
+
|
|
152
|
+
## After Completion
|
|
153
|
+
|
|
154
|
+
Suggest:
|
|
155
|
+
- `/validate module [name]` - Cascading validation
|
|
156
|
+
- `/module-docs [name] add api` - Add API docs
|
|
157
|
+
- `/module-docs [name] add events` - Add events docs
|
|
158
|
+
- `/diagram [module] c4-component` - Component diagram
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Create or update the Product Requirements Document
|
|
3
|
+
agent: pm
|
|
4
|
+
model: anthropic/claude-sonnet-4-20250514
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# PRD Creation/Update
|
|
8
|
+
|
|
9
|
+
## Arguments
|
|
10
|
+
$ARGUMENTS
|
|
11
|
+
|
|
12
|
+
- `create` or empty: Create new PRD
|
|
13
|
+
- `edit`: Edit existing PRD
|
|
14
|
+
|
|
15
|
+
## Prerequisites
|
|
16
|
+
|
|
17
|
+
**Required:**
|
|
18
|
+
- @docs/requirements/requirements.md - Must exist
|
|
19
|
+
|
|
20
|
+
**Check:**
|
|
21
|
+
!`ls -la docs/requirements/requirements.md 2>/dev/null && echo "EXISTS" || echo "MISSING - Run /requirements first"`
|
|
22
|
+
|
|
23
|
+
## Task
|
|
24
|
+
|
|
25
|
+
**Create Mode:**
|
|
26
|
+
1. Load skill: `prd-writing`
|
|
27
|
+
2. Review all requirements from requirements.md
|
|
28
|
+
3. Collaborate to define:
|
|
29
|
+
- Project classification
|
|
30
|
+
- Success criteria
|
|
31
|
+
- MVP/Growth/Vision scope
|
|
32
|
+
4. Structure into PRD sections
|
|
33
|
+
5. Load skill: `acceptance-criteria` for writing AC
|
|
34
|
+
6. Save to `docs/prd.md`
|
|
35
|
+
|
|
36
|
+
**Edit Mode:**
|
|
37
|
+
1. Load existing @docs/prd.md
|
|
38
|
+
2. Ask what sections need updates
|
|
39
|
+
3. Make targeted edits
|
|
40
|
+
4. Update version in frontmatter
|
|
41
|
+
5. Save updated PRD
|
|
42
|
+
|
|
43
|
+
## Validation Before Save
|
|
44
|
+
|
|
45
|
+
- All FRs from requirements.md addressed
|
|
46
|
+
- All NFRs from requirements.md addressed
|
|
47
|
+
- Success criteria are measurable
|
|
48
|
+
- Scope boundaries clear
|
|
49
|
+
|
|
50
|
+
## Output
|
|
51
|
+
|
|
52
|
+
Save to: `docs/prd.md`
|
|
53
|
+
|
|
54
|
+
## QA Reminder
|
|
55
|
+
|
|
56
|
+
After PRD is complete, create QA artifact:
|
|
57
|
+
`docs/prd-acceptance-criteria.md`
|
|
58
|
+
|
|
59
|
+
Use template: `@.opencode/templates/prd-acceptance-criteria-template.md`
|
|
60
|
+
|
|
61
|
+
## Next Step
|
|
62
|
+
|
|
63
|
+
After completion, suggest: `/validate prd`
|
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Quick mode for small changes - minimal documentation workflow
|
|
3
|
+
agent: workflow-orchestrator
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Quick Mode
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
|
|
10
|
+
Skip the full workflow for small changes (L0-L1 scale):
|
|
11
|
+
- Bug fixes
|
|
12
|
+
- Minor features
|
|
13
|
+
- Configuration changes
|
|
14
|
+
- Small refactors
|
|
15
|
+
|
|
16
|
+
## Arguments
|
|
17
|
+
$ARGUMENTS
|
|
18
|
+
|
|
19
|
+
Description of the change to make.
|
|
20
|
+
|
|
21
|
+
Example:
|
|
22
|
+
```
|
|
23
|
+
/quick Fix login button not working on mobile
|
|
24
|
+
/quick Add dark mode toggle to settings
|
|
25
|
+
/quick Update API endpoint for user service
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Quick Mode Criteria
|
|
29
|
+
|
|
30
|
+
Automatically used when:
|
|
31
|
+
- Single file or < 5 files affected
|
|
32
|
+
- No new requirements needed
|
|
33
|
+
- No architecture changes
|
|
34
|
+
- Estimated time < 2 hours
|
|
35
|
+
|
|
36
|
+
## Quick Workflow
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
┌────────────────────┐
|
|
40
|
+
│ 1. Quick Doc │ Create minimal change doc
|
|
41
|
+
│ (2-5 min) │
|
|
42
|
+
└────────┬───────────┘
|
|
43
|
+
│
|
|
44
|
+
▼
|
|
45
|
+
┌────────────────────┐
|
|
46
|
+
│ 2. Implement │ Make the change
|
|
47
|
+
│ (varies) │
|
|
48
|
+
└────────┬───────────┘
|
|
49
|
+
│
|
|
50
|
+
▼
|
|
51
|
+
┌────────────────────┐
|
|
52
|
+
│ 3. Test & Verify │ Verify it works
|
|
53
|
+
│ (5-10 min) │
|
|
54
|
+
└────────┬───────────┘
|
|
55
|
+
│
|
|
56
|
+
▼
|
|
57
|
+
┌────────────────────┐
|
|
58
|
+
│ 4. Done │ Log in change history
|
|
59
|
+
└────────────────────┘
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Quick Doc Format
|
|
63
|
+
|
|
64
|
+
Create `docs/changes/quick/[date]-[slug].md`:
|
|
65
|
+
|
|
66
|
+
```markdown
|
|
67
|
+
# Quick Change: [Title]
|
|
68
|
+
|
|
69
|
+
**Date:** YYYY-MM-DD
|
|
70
|
+
**Type:** Bug Fix | Minor Feature | Config | Refactor
|
|
71
|
+
**Author:** [name]
|
|
72
|
+
|
|
73
|
+
## Summary
|
|
74
|
+
|
|
75
|
+
[One paragraph description]
|
|
76
|
+
|
|
77
|
+
## Changes Made
|
|
78
|
+
|
|
79
|
+
- [File 1]: [change]
|
|
80
|
+
- [File 2]: [change]
|
|
81
|
+
|
|
82
|
+
## Testing
|
|
83
|
+
|
|
84
|
+
- [ ] [Test 1]
|
|
85
|
+
- [ ] [Test 2]
|
|
86
|
+
|
|
87
|
+
## Notes
|
|
88
|
+
|
|
89
|
+
[Any additional context]
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## Your Task
|
|
93
|
+
|
|
94
|
+
1. **Analyze the request**
|
|
95
|
+
- Is this truly a quick change?
|
|
96
|
+
- What files will be affected?
|
|
97
|
+
|
|
98
|
+
2. **If quick change appropriate:**
|
|
99
|
+
- Create quick doc
|
|
100
|
+
- Proceed with implementation guidance
|
|
101
|
+
|
|
102
|
+
3. **If NOT quick change:**
|
|
103
|
+
- Explain why full workflow is needed
|
|
104
|
+
- Suggest appropriate command
|
|
105
|
+
|
|
106
|
+
## Scale Check
|
|
107
|
+
|
|
108
|
+
Before proceeding, verify:
|
|
109
|
+
|
|
110
|
+
```
|
|
111
|
+
IF affects > 5 files → Use full workflow
|
|
112
|
+
IF adds new requirements → /requirements first
|
|
113
|
+
IF changes architecture → /architecture edit
|
|
114
|
+
IF affects multiple modules → /change new
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
## Quick Doc Location
|
|
118
|
+
|
|
119
|
+
```
|
|
120
|
+
docs/changes/quick/
|
|
121
|
+
├── 2026-01-23-fix-mobile-login.md
|
|
122
|
+
├── 2026-01-22-add-dark-mode.md
|
|
123
|
+
└── ...
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
## Output
|
|
127
|
+
|
|
128
|
+
For valid quick changes:
|
|
129
|
+
|
|
130
|
+
```markdown
|
|
131
|
+
## Quick Change: [Title]
|
|
132
|
+
|
|
133
|
+
**Scale:** L0 (Hotfix) / L1 (Small)
|
|
134
|
+
**Estimated Time:** [X] minutes/hours
|
|
135
|
+
|
|
136
|
+
### Files to Modify
|
|
137
|
+
|
|
138
|
+
1. `path/to/file.go` - [what to change]
|
|
139
|
+
2. `path/to/test.go` - [add test]
|
|
140
|
+
|
|
141
|
+
### Implementation Steps
|
|
142
|
+
|
|
143
|
+
1. [Step 1]
|
|
144
|
+
2. [Step 2]
|
|
145
|
+
3. [Step 3]
|
|
146
|
+
|
|
147
|
+
### Testing Checklist
|
|
148
|
+
|
|
149
|
+
- [ ] Manual test: [description]
|
|
150
|
+
- [ ] Unit test added/updated
|
|
151
|
+
- [ ] No regressions
|
|
152
|
+
|
|
153
|
+
### Quick Doc Created
|
|
154
|
+
|
|
155
|
+
`docs/changes/quick/YYYY-MM-DD-[slug].md`
|
|
156
|
+
|
|
157
|
+
---
|
|
158
|
+
|
|
159
|
+
Ready to implement? I can guide you through each step.
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
## After Quick Mode
|
|
163
|
+
|
|
164
|
+
- Quick doc serves as change log
|
|
165
|
+
- No need to update main docs
|
|
166
|
+
- If pattern emerges, consider documenting in main docs
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Gather and document FR/NFR requirements through stakeholder interview
|
|
3
|
+
agent: analyst
|
|
4
|
+
model: anthropic/claude-sonnet-4-20250514
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Requirements Gathering
|
|
8
|
+
|
|
9
|
+
## Arguments
|
|
10
|
+
$ARGUMENTS
|
|
11
|
+
|
|
12
|
+
Topic or area to focus requirements gathering (optional).
|
|
13
|
+
|
|
14
|
+
## Prerequisites
|
|
15
|
+
|
|
16
|
+
Check for existing context:
|
|
17
|
+
- @docs/prd.md (if exists - for context)
|
|
18
|
+
- @docs/architecture.md (if exists - for context)
|
|
19
|
+
- @CLAUDE.md (project standards)
|
|
20
|
+
|
|
21
|
+
## Task
|
|
22
|
+
|
|
23
|
+
**If `docs/requirements/requirements.md` exists:**
|
|
24
|
+
1. Review existing requirements
|
|
25
|
+
2. Ask if user wants to ADD new requirements or EDIT existing
|
|
26
|
+
3. Continue discovery from where it left off
|
|
27
|
+
|
|
28
|
+
**If starting fresh:**
|
|
29
|
+
1. Load skill: `requirements-gathering`
|
|
30
|
+
2. Begin stakeholder interview
|
|
31
|
+
3. Discover functional requirements (FR-XXX)
|
|
32
|
+
4. Discover non-functional requirements (NFR-XXX)
|
|
33
|
+
5. Structure into requirements.md
|
|
34
|
+
|
|
35
|
+
## Validation Before Save
|
|
36
|
+
|
|
37
|
+
Load skill: `requirements-validation`
|
|
38
|
+
- All requirements have IDs
|
|
39
|
+
- All requirements have acceptance criteria
|
|
40
|
+
- No ambiguous language
|
|
41
|
+
- Priorities are assigned
|
|
42
|
+
|
|
43
|
+
## Output
|
|
44
|
+
|
|
45
|
+
Save to: `docs/requirements/requirements.md`
|
|
46
|
+
|
|
47
|
+
## Next Step
|
|
48
|
+
|
|
49
|
+
After completion, suggest: `/validate requirements`
|