owflow 0.3.0 → 0.4.2
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 +22 -0
- package/dist/agents/information-gatherer.md +691 -691
- package/dist/agents/research-planner.md +450 -447
- package/dist/agents/research-synthesizer.md +403 -401
- package/dist/agents/solution-brainstormer.md +257 -257
- package/dist/agents/solution-designer.md +372 -372
- package/dist/commands/goal-research.md +33 -0
- package/dist/commands/research-brainstorm.md +33 -0
- package/dist/commands/research-converge.md +33 -0
- package/dist/commands/research-design.md +33 -0
- package/dist/commands/research-finalize.md +33 -0
- package/dist/commands/research-fork.md +40 -0
- package/dist/commands/research-gather.md +33 -0
- package/dist/commands/research-plan.md +37 -0
- package/dist/commands/research-quick.md +37 -0
- package/dist/commands/research-synthesize.md +33 -0
- package/dist/commands/research.md +55 -36
- package/dist/commands/work.md +3 -3
- package/dist/configuration/skills-config.js +1 -1
- package/dist/index.js +5 -2
- package/dist/skills/goal-research/SKILL.md +118 -0
- package/dist/skills/orchestrator-framework/references/dispatcher-handoff.md +8 -1
- package/dist/skills/orchestrator-framework/references/gate-contract.md +112 -104
- package/dist/skills/research/SKILL.md +249 -495
- package/dist/skills/research-brainstorm/SKILL.md +120 -0
- package/dist/skills/{research → research-brainstorm}/references/brainstorming-techniques.md +1 -1
- package/dist/skills/research-converge/SKILL.md +130 -0
- package/dist/skills/research-design/SKILL.md +146 -0
- package/dist/skills/{research → research-design}/references/design-techniques.md +1 -1
- package/dist/skills/research-finalize/SKILL.md +125 -0
- package/dist/skills/research-fork/SKILL.md +190 -0
- package/dist/skills/research-gather/SKILL.md +133 -0
- package/dist/skills/research-plan/SKILL.md +141 -0
- package/dist/skills/research-quick/SKILL.md +139 -0
- package/dist/skills/research-synthesize/SKILL.md +127 -0
- package/dist/templates/orchestrator-state-research.yml +19 -13
- package/dist/tools/fork_task.js +36 -0
- package/dist/tools/verify_template.js +10 -31
- package/dist/utils/file-util.js +1 -1
- package/dist/utils/fork-task.js +74 -0
- package/dist/utils/plugin-info.js +20 -0
- package/dist/utils/yaml-structure.js +32 -0
- package/package.json +1 -1
- package/dist/constants.js +0 -4
- /package/dist/skills/{research → research-plan}/references/research-methodologies.md +0 -0
|
@@ -1,495 +1,249 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: owflow:research
|
|
3
|
-
description:
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
-
|
|
58
|
-
-
|
|
59
|
-
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
|
103
|
-
|
|
|
104
|
-
|
|
|
105
|
-
|
|
|
106
|
-
|
|
|
107
|
-
|
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
```
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
**
|
|
201
|
-
**
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
- `output_path`: `outputs/solution-exploration.md` — brainstormer MUST write to this exact path
|
|
251
|
-
- Accumulated context: `research_type`, `research_question`, `confidence_level`, `phase_summaries` (Phase 1)
|
|
252
|
-
- `project_doc_paths` (from state)
|
|
253
|
-
|
|
254
|
-
> **SELF-CHECK**: After Task tool returns, verify `outputs/solution-exploration.md` exists and contains alternatives. If missing: **STOP. Do NOT proceed to Phase 4 or Phase 5.** Re-invoke the brainstormer with corrected context (ensure `output_path` is `outputs/solution-exploration.md`). If second attempt also fails, use question to report the failure and ask whether to retry or skip brainstorming.
|
|
255
|
-
|
|
256
|
-
→ **AUTO-CONTINUE**
|
|
257
|
-
|
|
258
|
-
---
|
|
259
|
-
|
|
260
|
-
### Phase 4: Solution Convergence
|
|
261
|
-
|
|
262
|
-
**Purpose**: Present brainstorming alternatives to user for decision-making on each decision area
|
|
263
|
-
**Execute**: Direct (interactive)
|
|
264
|
-
**Output**: Updated `orchestrator-state.yml` with chosen approaches
|
|
265
|
-
**State**: Update `phase_summaries.phase-4` with `decision_areas` and `deferred_ideas`
|
|
266
|
-
|
|
267
|
-
**Skip if**: `brainstorming_enabled = false`
|
|
268
|
-
**Resume check**: If `phase_summaries.phase-4.decision_areas` has entries with `chosen_approach` set, skip already-resolved areas
|
|
269
|
-
|
|
270
|
-
> **ANTI-PATTERN**: Do NOT present all decision areas in a single summary table and ask one combined "do you agree?" question. Each area MUST get its own detailed presentation and its own question call.
|
|
271
|
-
>
|
|
272
|
-
> **ANTI-PATTERN**: Do NOT show full alternatives/pros/cons for the first area and then shortcut remaining areas to just a recommendation line + question. EVERY area gets the SAME level of detail — all alternatives with descriptions, pros, and cons. No exceptions.
|
|
273
|
-
|
|
274
|
-
1. Read `outputs/solution-exploration.md`
|
|
275
|
-
2. For each decision area sequentially, output ALL of the following (steps a-d) BEFORE calling question:
|
|
276
|
-
a. **Area header**: area name and why this decision matters (1-2 sentences of context)
|
|
277
|
-
b. **Alternatives detail**: For EVERY alternative in this area, show:
|
|
278
|
-
- Name and description (2-3 sentences)
|
|
279
|
-
- Pros (bullet list)
|
|
280
|
-
- Cons (bullet list)
|
|
281
|
-
c. **Recommendation**: which alternative is recommended and why (1 sentence)
|
|
282
|
-
d. **question**: this area's alternatives as options (mark recommended with "(Recommended)") + "Need more info" option
|
|
283
|
-
e. If user picks → record choice, move to next area
|
|
284
|
-
f. If "Need more info" → present the detailed trade-off analysis for the requested alternative, then re-ask
|
|
285
|
-
|
|
286
|
-
> **SELF-CHECK before each question**: Did you output the alternatives with pros/cons for THIS area? If you only showed a recommendation line without listing all alternatives and their pros/cons, STOP and output the full detail before asking.
|
|
287
|
-
|
|
288
|
-
3. After all areas resolved, present a brief summary of the chosen combination
|
|
289
|
-
4. Update state with chosen approaches per decision area
|
|
290
|
-
|
|
291
|
-
> **GATE CHECK**: Verify that question was called for EACH decision area. If any decision area was skipped for any reason (e.g., output file missing, read failure), STOP and resolve before continuing. Do NOT mark Phase 4 complete without user convergence on all decision areas.
|
|
292
|
-
|
|
293
|
-
→ Pause
|
|
294
|
-
|
|
295
|
-
question - "Brainstorming complete. Continue to high-level design?"
|
|
296
|
-
|
|
297
|
-
---
|
|
298
|
-
|
|
299
|
-
### Phase 5: High-Level Design
|
|
300
|
-
|
|
301
|
-
> **Phase gate**: Requires `question` confirmation from the preceding phase before executing.
|
|
302
|
-
|
|
303
|
-
**Purpose**: Create architecture design from selected solution approach
|
|
304
|
-
**Execute**: Orchestrator-Direct Hybrid
|
|
305
|
-
**Output**: `outputs/high-level-design.md`, `outputs/decision-log.md`
|
|
306
|
-
**State**: Update `phase_summaries.phase-5`
|
|
307
|
-
|
|
308
|
-
**Skip if**: `design_enabled = false`
|
|
309
|
-
|
|
310
|
-
**Read `references/design-techniques.md` NOW using the Read tool** — MADR format, ADR guidance, decision documentation patterns
|
|
311
|
-
|
|
312
|
-
**Part A — Design Direction (Direct)**:
|
|
313
|
-
|
|
314
|
-
1. If Phase 4 ran: confirm selected approaches from convergence
|
|
315
|
-
2. If Phase 4 was skipped: use research report recommendations as design input
|
|
316
|
-
3. question for any design preferences or constraints (e.g., "Any architectural constraints or preferences?")
|
|
317
|
-
|
|
318
|
-
**Part B — Design Generation (Subagent)**:
|
|
319
|
-
|
|
320
|
-
> **ANTI-PATTERN**: Do NOT generate C4 architecture diagrams or ADRs inline. The solution-designer agent has specialized architecture and MADR documentation capabilities.
|
|
321
|
-
|
|
322
|
-
**INVOKE NOW**: Use Task tool with `subagent_type: solution-designer`
|
|
323
|
-
|
|
324
|
-
**Context to pass** (Pattern 7):
|
|
325
|
-
|
|
326
|
-
- `task_path`, `synthesis_path`, `research_report_path`
|
|
327
|
-
- `solution_exploration_path` (only if Phase 3-4 ran)
|
|
328
|
-
- `selected_approach` (from Phase 4 convergence if ran, or from research report recommendations)
|
|
329
|
-
- `design_preferences` (from Part A)
|
|
330
|
-
- Accumulated context: `research_type`, `research_question`, `confidence_level`, `phase_summaries`
|
|
331
|
-
- `project_doc_paths` (from state)
|
|
332
|
-
|
|
333
|
-
> **SELF-CHECK**: After Task tool returns, verify both `outputs/high-level-design.md` and `outputs/decision-log.md` exist. If missing: **STOP. Do NOT proceed to Part C.** Re-invoke the designer with corrected context. If second attempt also fails, use question to report the failure and ask whether to retry or skip design.
|
|
334
|
-
|
|
335
|
-
**Part C — Summary (Direct)**: 3. Read `outputs/high-level-design.md` and `outputs/decision-log.md` 4. Present executive summary to user:
|
|
336
|
-
|
|
337
|
-
- Architecture style and key components
|
|
338
|
-
- Number of architectural decisions recorded
|
|
339
|
-
- Key decision highlights (1 line each)
|
|
340
|
-
- Integration points with existing system (if applicable)
|
|
341
|
-
|
|
342
|
-
**Part D — Diagram Refinement (Skill, content-preserving)**:
|
|
343
|
-
|
|
344
|
-
5. Invoke Skill tool: `diagrams-mermaid` to refine visual communication in `outputs/high-level-design.md`
|
|
345
|
-
6. Add diagrams that supplement (not replace) existing architecture content:
|
|
346
|
-
- one architecture view (`C4Container` preferred, `C4Component` only if needed),
|
|
347
|
-
- one interaction/state view (`sequenceDiagram` or `flowchart`) for the critical flow.
|
|
348
|
-
7. If minimum context for a diagram is missing, record explicit gaps in the document and avoid speculative components/relationships.
|
|
349
|
-
|
|
350
|
-
→ Pause
|
|
351
|
-
|
|
352
|
-
question - "Design complete. Continue to output generation?"
|
|
353
|
-
|
|
354
|
-
---
|
|
355
|
-
|
|
356
|
-
### Phase 6: Completion → Exit Gate
|
|
357
|
-
|
|
358
|
-
> **Phase gate**: Requires `question` confirmation from the preceding phase before executing.
|
|
359
|
-
|
|
360
|
-
**Purpose**: Present research results, confirm correctness with the user, and hand off (Exit Gate contract, [Gate Contract](../orchestrator-framework/references/gate-contract.md))
|
|
361
|
-
**Execute**: Direct
|
|
362
|
-
**Output**: No new files — summarizes existing outputs
|
|
363
|
-
|
|
364
|
-
**Process**:
|
|
365
|
-
|
|
366
|
-
1. Inventory all generated outputs: `outputs/research-report.md` (always), plus conditional: `solution-exploration.md`, `high-level-design.md`, `decision-log.md`
|
|
367
|
-
2. **Results box**:
|
|
368
|
-
|
|
369
|
-
```markdown
|
|
370
|
-
## ✅ RESEARCH COMPLETE — <research question>
|
|
371
|
-
|
|
372
|
-
**Type** — [research type]
|
|
373
|
-
**Confidence** — [confidence level]
|
|
374
|
-
**Phases run** — [e.g. 1, 3-4 brainstorm, 5 design]
|
|
375
|
-
**Key findings** — [2-3 one-line highlights]
|
|
376
|
-
**Decisions** — [count of ADRs, if design ran]
|
|
377
|
-
|
|
378
|
-
**Artifacts**
|
|
379
|
-
- `outputs/research-report.md`
|
|
380
|
-
- `outputs/solution-exploration.md` [conditional]
|
|
381
|
-
- `outputs/high-level-design.md` [conditional]
|
|
382
|
-
- `outputs/decision-log.md` [conditional]
|
|
383
|
-
```
|
|
384
|
-
|
|
385
|
-
3. **Results-acceptance question** — use `question` — "Are these results correct?" with options:
|
|
386
|
-
- **Accept** — research is complete; print next steps (below).
|
|
387
|
-
- **Adjust** — re-run the affected phase (re-gather, re-brainstorm, re-design) with the user's corrections, then re-present the results box.
|
|
388
|
-
- **Discuss** — walk through specific findings or decisions in more depth; then re-ask.
|
|
389
|
-
- **Stop here** — print the resume command (`/owflow:research <task-path>`) and end.
|
|
390
|
-
|
|
391
|
-
4. **Next steps (after Accept)** — if design artifacts exist, suggest starting development in a fresh session:
|
|
392
|
-
|
|
393
|
-
```
|
|
394
|
-
To start development based on this research, clear context first or start a new session, then run:
|
|
395
|
-
→ /owflow:development <task-path>
|
|
396
|
-
```
|
|
397
|
-
|
|
398
|
-
→ End of workflow
|
|
399
|
-
|
|
400
|
-
---
|
|
401
|
-
|
|
402
|
-
## Domain Context (State Extensions)
|
|
403
|
-
|
|
404
|
-
Research-specific fields in `orchestrator-state.yml`:
|
|
405
|
-
|
|
406
|
-
Refer to the template [src/templates/orchestrator-state-research.yml](../../templates/orchestrator-state-research.yml).
|
|
407
|
-
|
|
408
|
-
---
|
|
409
|
-
|
|
410
|
-
## Task Structure
|
|
411
|
-
|
|
412
|
-
```
|
|
413
|
-
.owflow/tasks/research/YYYY-MM-DD-research-name/
|
|
414
|
-
├── orchestrator-state.yml
|
|
415
|
-
├── planning/
|
|
416
|
-
│ ├── research-brief.md # Phase 1, Step 1
|
|
417
|
-
│ ├── research-plan.md # Phase 1, Step 2
|
|
418
|
-
│ └── sources.md # Phase 1, Step 2
|
|
419
|
-
├── analysis/
|
|
420
|
-
│ ├── findings/
|
|
421
|
-
│ │ ├── codebase-*.md # Phase 1, Step 3
|
|
422
|
-
│ │ ├── docs-*.md # Phase 1, Step 3
|
|
423
|
-
│ │ ├── config-*.md # Phase 1, Step 3
|
|
424
|
-
│ │ ├── external-*.md # Phase 1, Step 3
|
|
425
|
-
│ │ └── [custom-category]-*.md # Phase 1, Step 3 (dynamic categories)
|
|
426
|
-
│ └── synthesis.md # Phase 1, Step 4 (reasoning log)
|
|
427
|
-
├── outputs/
|
|
428
|
-
│ ├── research-report.md # Phase 1, Step 4 (main deliverable)
|
|
429
|
-
│ ├── solution-exploration.md # Phase 3 (conditional)
|
|
430
|
-
│ ├── high-level-design.md # Phase 5 (conditional)
|
|
431
|
-
│ └── decision-log.md # Phase 5 (conditional)
|
|
432
|
-
```
|
|
433
|
-
|
|
434
|
-
---
|
|
435
|
-
|
|
436
|
-
## Auto-Recovery
|
|
437
|
-
|
|
438
|
-
| Phase | Max Attempts | Strategy |
|
|
439
|
-
| ---------- | ------------ | ------------------------------------------------------------- |
|
|
440
|
-
| 1 (Step 1) | 1 | Prompt user for clarification if question unclear |
|
|
441
|
-
| 1 (Step 2) | 2 | Expand search patterns, use fallback mixed methodology |
|
|
442
|
-
| 1 (Step 3) | 3 | Retry failed agents only, continue with successful categories |
|
|
443
|
-
| 1 (Step 4) | 2 | Request targeted re-gathering for gaps |
|
|
444
|
-
| 2 | 1 | Re-evaluate recommendation if synthesis unclear |
|
|
445
|
-
| 3 | 2 | Re-invoke solution-brainstormer with adjusted context |
|
|
446
|
-
| 4 | 1 | Re-read exploration file, re-present decision areas |
|
|
447
|
-
| 5 | 2 | Re-invoke solution-designer with adjusted context |
|
|
448
|
-
| 6 | 0 | Summary only |
|
|
449
|
-
|
|
450
|
-
---
|
|
451
|
-
|
|
452
|
-
## Integration with Other Workflows
|
|
453
|
-
|
|
454
|
-
### As Standalone Research
|
|
455
|
-
|
|
456
|
-
**Command**: `/owflow:research [research-question]`
|
|
457
|
-
**Flow**: Complete all phases, save outputs in task directory
|
|
458
|
-
|
|
459
|
-
### As Embedded Research Phase
|
|
460
|
-
|
|
461
|
-
**Invoked by**: development orchestrator, migration orchestrator
|
|
462
|
-
|
|
463
|
-
**Integration**:
|
|
464
|
-
|
|
465
|
-
1. Parent orchestrator invokes research skill
|
|
466
|
-
2. Research executes phases 1-5 (skip Phase 6 completion — parent orchestrator handles next steps)
|
|
467
|
-
3. Design outputs fed into parent's specification phase
|
|
468
|
-
4. Research report saved in parent task's `analysis/research/` directory
|
|
469
|
-
|
|
470
|
-
**Handoff**:
|
|
471
|
-
|
|
472
|
-
Refer to `research_outputs` in the template [src/templates/orchestrator-state-research.yml](../../templates/orchestrator-state-research.yml).
|
|
473
|
-
|
|
474
|
-
---
|
|
475
|
-
|
|
476
|
-
## Command Integration
|
|
477
|
-
|
|
478
|
-
Invoked via:
|
|
479
|
-
|
|
480
|
-
- `/owflow:research [question] [--type=TYPE] [--brainstorm] [--no-brainstorm] [--design] [--no-design]` (new)
|
|
481
|
-
- `/owflow:research [task-path] [--from=PHASE]` (resume)
|
|
482
|
-
|
|
483
|
-
**Brainstorming flags**:
|
|
484
|
-
|
|
485
|
-
- `--brainstorm`: Force brainstorming phase (auto-resolves Phase 2 brainstorming decision to "enable")
|
|
486
|
-
- `--no-brainstorm`: Skip brainstorming phase
|
|
487
|
-
- Neither: Phase 2 presents recommendation and asks user
|
|
488
|
-
|
|
489
|
-
**Design flags**:
|
|
490
|
-
|
|
491
|
-
- `--design`: Force high-level design phase (auto-resolves Phase 2 design decision to "enable")
|
|
492
|
-
- `--no-design`: Skip high-level design phase
|
|
493
|
-
- Neither: Phase 2 presents recommendation and asks user
|
|
494
|
-
|
|
495
|
-
Task directory: `.owflow/tasks/research/YYYY-MM-DD-task-name/`
|
|
1
|
+
---
|
|
2
|
+
name: owflow:research
|
|
3
|
+
description: Research workflow dispatcher. Initializes/resumes research tasks, derives the next step from state, and hands off to the matching /owflow:research-* subskill. Handles comprehensive research and analysis — technical, requirements, literature, and mixed research types with adaptive methodology, multi-source gathering, pattern synthesis, and evidence-based artifact outputs (findings documentation). Supports standalone research tasks and embedded research phases feeding development workflows. Use /owflow:goal-research to run all phases in one session.
|
|
4
|
+
argument-hint: "[task description | task-path] [--from=<slug>] [--type=<type>]"
|
|
5
|
+
user-invocable: true
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Research Dispatcher
|
|
9
|
+
|
|
10
|
+
Entry point for research tasks in **assisted mode**: initialize (or resume) the task, derive the next pending step from `orchestrator-state.yml`, print the matching subskill command, and STOP. Each `/owflow:research-*` subskill runs its steps with fresh context — the explicit invocation IS the step gate.
|
|
11
|
+
|
|
12
|
+
Research state uses descriptive step slugs in `completed_phases` / `failed_phases` / `auto_fix_attempts` (NOT phase numbers): `brief-written`, `plan-created`, `findings-gathered`, `synthesis-complete`, `alternatives-generated`, `approaches-chosen`, `design-generated`, `research-completed`. The routing table below maps slugs to subskills.
|
|
13
|
+
|
|
14
|
+
For the all-in-one loop with in-session `question` gates, use `/owflow:goal-research`.
|
|
15
|
+
|
|
16
|
+
Gates follow the shared contract in the [Gate Contract](../orchestrator-framework/references/gate-contract.md), with the [dispatcher exception](../orchestrator-framework/references/gate-contract.md).
|
|
17
|
+
|
|
18
|
+
## Input / Output Artifacts
|
|
19
|
+
|
|
20
|
+
| Artifact | Normal mode | Quick mode |
|
|
21
|
+
| ---------------------------------------------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
|
22
|
+
| Argument (question / path) | research question (new task) or task path/identifier (resume) | task path/identifier only — quick runs are never STARTED here; an interrupted quick task resumes at full fidelity |
|
|
23
|
+
| `orchestrator-state.yml` | read on resume (artifact validation of `completed_phases`) | read on resume — honors `entry_point: "research-quick"` and quick-lane artifacts |
|
|
24
|
+
| Task directory + `orchestrator-state.yml` init | written (Step 3, new task) — `entry_point: "research"` | n/a — quick bootstrap is owned by `/owflow:research-quick` |
|
|
25
|
+
|
|
26
|
+
The dispatcher writes nothing else — every task artifact is produced by the subskills (see [Task Structure](#task-structure)).
|
|
27
|
+
|
|
28
|
+
## Entry Gate
|
|
29
|
+
|
|
30
|
+
**BEFORE deriving the handoff, complete these steps:**
|
|
31
|
+
|
|
32
|
+
### Step 1: Load Framework Patterns
|
|
33
|
+
|
|
34
|
+
**Read the framework reference files NOW using the Read tool:**
|
|
35
|
+
|
|
36
|
+
1. The [Dispatcher & Handoff Pattern](../orchestrator-framework/references/dispatcher-handoff.md) governs this skill.
|
|
37
|
+
2. The [Delegation Rules](../orchestrator-framework/references/delegation-rules.md) bound what subskills delegate.
|
|
38
|
+
3. The [Orchestrator Patterns](../orchestrator-framework/references/orchestrator-patterns.md) define state schema, initialization, and context passing.
|
|
39
|
+
|
|
40
|
+
### Step 2: Resolve the Argument
|
|
41
|
+
|
|
42
|
+
**If the argument is a task path or identifier** (a directory, or a directory name under `.owflow/tasks/research/`) → **resume mode**:
|
|
43
|
+
|
|
44
|
+
1. Read `orchestrator-state.yml`; validate expected artifacts for `completed_phases` (remove entries whose artifacts are missing)
|
|
45
|
+
2. Find resume point: first step slug NOT in `completed_phases`; `--from=<slug>` overrides (validate its prerequisites exist, else use `question`)
|
|
46
|
+
3. Missing state file → print: `No research task found at <path>. Run /owflow:research <question> to start from scratch.` and STOP
|
|
47
|
+
|
|
48
|
+
**If the argument is a research question description** (any other free text) → new task.
|
|
49
|
+
|
|
50
|
+
**If nothing is provided** → ask via `question`: "What is your research question?" (free-form answer), then WAIT. Never guess or auto-pick a task.
|
|
51
|
+
|
|
52
|
+
### Step 3: Initialize (new task)
|
|
53
|
+
|
|
54
|
+
**New task** (research question argument):
|
|
55
|
+
|
|
56
|
+
1. **Create Task Directory**: `.owflow/tasks/research/YYYY-MM-DD-task-name/` (3-5 kebab-case words from the question)
|
|
57
|
+
2. **Initialize State**: create `orchestrator-state.yml` from the research template — `task.title` / `task.description` from the question, `task.status: in_progress`, `orchestrator.task_path`, `orchestrator.entry_point: "research"` (template/bootstrap mechanic)
|
|
58
|
+
- **CRITICAL**: use the `verify_template` tool immediately after creation to check YAML validity against `orchestrator-state-research.yml`.
|
|
59
|
+
3. **Create Task Items**: use `TaskCreate` for the research steps (one item per subskill handoff), then set the execution order with `TaskUpdate addBlockedBy` (plan → gather → synthesize → optional chain (user choice) → finalize). On resume, refresh the already-evidenced items instead of re-creating them.
|
|
60
|
+
4. **Command flags**: `--type=TYPE` → `research_context.research_type`. Subskills read it from there.
|
|
61
|
+
|
|
62
|
+
**Output**:
|
|
63
|
+
|
|
64
|
+
```
|
|
65
|
+
🚀 Research Dispatcher
|
|
66
|
+
|
|
67
|
+
Task: [research question]
|
|
68
|
+
Directory: [task-path]
|
|
69
|
+
Next step: [step name]
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## When to Use
|
|
75
|
+
|
|
76
|
+
Use when:
|
|
77
|
+
|
|
78
|
+
- Need comprehensive research on a topic
|
|
79
|
+
- Exploring codebase patterns or architecture
|
|
80
|
+
- Gathering requirements or best practices
|
|
81
|
+
- Want systematic evidence-based answers
|
|
82
|
+
- Research will feed into development workflows
|
|
83
|
+
|
|
84
|
+
**DO NOT use for**: Development tasks, bug fixes, performance optimization.
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## Core Principles
|
|
89
|
+
|
|
90
|
+
1. **Evidence-Based**: Every finding must have source citation
|
|
91
|
+
2. **Systematic**: Follow structured methodology for consistent results
|
|
92
|
+
3. **Multi-Source**: Gather from codebase, docs, config, external sources
|
|
93
|
+
4. **Synthesized**: Cross-reference findings, identify patterns
|
|
94
|
+
5. **Actionable**: Produce outputs that enable next steps
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## Routing Table (completed_phases → next subskill)
|
|
99
|
+
|
|
100
|
+
Derive the FIRST step slug not in `completed_phases`, then print the matching command:
|
|
101
|
+
|
|
102
|
+
| Next step (slug) | Condition (from state) | Handoff command | Produces |
|
|
103
|
+
| ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | ---------------------------------------------------------- |
|
|
104
|
+
| Brief + plan (`brief-written`, `plan-created`) | Always (new task or partial foundation) | `/owflow:research-plan <task-path>` | `planning/research-brief.md`, `research-plan.md`, `sources.md` |
|
|
105
|
+
| Gather (`findings-gathered`) | `plan-created` completed (gather parses `## Gathering Strategy`, or falls back to 4 default categories) | `/owflow:research-gather <task-path>` | `analysis/findings/*.md` |
|
|
106
|
+
| Synthesize (`synthesis-complete`) | `findings-gathered` completed | `/owflow:research-synthesize <task-path>` | `analysis/synthesis.md`, `outputs/research-report.md` |
|
|
107
|
+
| Optional chain (user choice) | `synthesis-complete` completed — ask via `question` whether to brainstorm, design, or finalize; hand off to the chosen subskill | `/owflow:research-brainstorm` / `/owflow:research-design` / `/owflow:research-finalize <task-path>` | user's chain decision |
|
|
108
|
+
| Brainstorm (`alternatives-generated`) | User chose brainstorming (invoking the skill IS the decision) | `/owflow:research-brainstorm <task-path>` | `outputs/solution-exploration.md` |
|
|
109
|
+
| Converge (`approaches-chosen`) | `alternatives-generated` completed (brainstorm ran) | `/owflow:research-converge <task-path>` | per-area `chosen_approach` in state (`phase_summaries.converge`) |
|
|
110
|
+
| Design (`design-generated`) | User chose design — after `approaches-chosen`, or as the design-only branch (seeded from the research report) | `/owflow:research-design <task-path>` | `outputs/high-level-design.md`, `outputs/decision-log.md` |
|
|
111
|
+
| Finalization (`research-completed`) | Foundation complete + optional chain settled (every step the user chose to run is recorded) | `/owflow:research-finalize <task-path>` | task completed (`task.status: completed`) |
|
|
112
|
+
|
|
113
|
+
The optional chain is the user's choice — there is no enablement flag in state and no separate decision step. When the user invokes `research-brainstorm` or `research-design`, that invocation IS the decision to run it; when they skip to `research-finalize`, the chain is settled as skipped. After `synthesis-complete` the dispatcher asks which way to go (brainstorm → converge → design, design-only, or straight to finalize).
|
|
114
|
+
|
|
115
|
+
`research-completed` already in `completed_phases` → the task is TERMINAL: no handoff.
|
|
116
|
+
|
|
117
|
+
This dispatcher never starts or forwards quick runs. An interrupted quick task (`entry_point: "research-quick"`, `synthesis-complete` not yet recorded) resumes at full fidelity for the missing pieces via the matching subskills. To finish that pass condensed, the user runs `/owflow:research-quick <task-path>` directly.
|
|
118
|
+
|
|
119
|
+
Forking (utility, not a routing row): `/owflow:research-fork <task-path> ["<what this fork should explore>"] [--from=<slug>] [--name="..."]` copies a task with at least one completed step to a new task diverging at a chosen completed step — a bare path is enough, the skill asks for the intent, fork point, and name with suggestions drawn from that research; the directory is copied verbatim and the copied state is trimmed to continue from the fork point onwards; the source stays untouched. The fork is a plain research task from then on, routable by this dispatcher like any other.
|
|
120
|
+
|
|
121
|
+
References moved into their owning subskills (read there, not here): `research-methodologies.md` lives in `research-plan/references/`, `brainstorming-techniques.md` in `research-brainstorm/references/`, `design-techniques.md` in `research-design/references/`.
|
|
122
|
+
|
|
123
|
+
---
|
|
124
|
+
|
|
125
|
+
## Exit Gate (adapted for dispatch mode)
|
|
126
|
+
|
|
127
|
+
After deriving the handoff, present the results box, ask how to proceed, then hand off accordingly (see the [dispatcher exception](../orchestrator-framework/references/gate-contract.md)). Never auto-invoke the subskill.
|
|
128
|
+
|
|
129
|
+
### Results box
|
|
130
|
+
|
|
131
|
+
```markdown
|
|
132
|
+
## ✅ RESEARCH TASK READY — <task name>
|
|
133
|
+
|
|
134
|
+
**Task** — [research question]
|
|
135
|
+
**Directory** — `<task-path>`
|
|
136
|
+
**Next step** — [step name]
|
|
137
|
+
[Resume note: completed steps / fresh task]
|
|
138
|
+
|
|
139
|
+
**Next ▸** `/owflow:research-<subskill> <task-path>`
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
### Acceptance question
|
|
143
|
+
|
|
144
|
+
Use `question` — "Task ready. How would you like to proceed?" with options:
|
|
145
|
+
|
|
146
|
+
- **Hand off to /owflow:research-<subskill>** — the user invokes the suggested command (dispatcher copies it to chat for convenience). Execution starts in a fresh context.
|
|
147
|
+
- **Switch to autonomous mode** — illustrate with `/owflow:goal-research <task-path>` to run remaining steps in one session with gates.
|
|
148
|
+
- **Adjust** — task set-up is wrong (wrong flags, wrong question, wrong task); re-run the affected initialization step, re-present the results box.
|
|
149
|
+
- **Stop here** — print the resume command (`/owflow:research <task-path>`) and end.
|
|
150
|
+
|
|
151
|
+
### Handoff message
|
|
152
|
+
|
|
153
|
+
On Accept (hand off choice), print, then STOP:
|
|
154
|
+
|
|
155
|
+
```
|
|
156
|
+
✓ Research task ready at <task-path>
|
|
157
|
+
|
|
158
|
+
Next step:
|
|
159
|
+
→ /owflow:research-<subskill> <task-path>
|
|
160
|
+
|
|
161
|
+
Other options:
|
|
162
|
+
/owflow:goal-research <task-path> — run remaining steps in one loop
|
|
163
|
+
/owflow:research --from=<slug> <task-path> — jump to a specific step
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
---
|
|
167
|
+
|
|
168
|
+
## Task Structure
|
|
169
|
+
|
|
170
|
+
```
|
|
171
|
+
.owflow/tasks/research/YYYY-MM-DD-research-name/
|
|
172
|
+
├── orchestrator-state.yml
|
|
173
|
+
├── planning/
|
|
174
|
+
│ ├── research-brief.md # research-plan (brief step)
|
|
175
|
+
│ ├── research-plan.md # research-plan (plan step)
|
|
176
|
+
│ └── sources.md # research-plan (plan step)
|
|
177
|
+
├── analysis/
|
|
178
|
+
│ ├── findings/
|
|
179
|
+
│ │ ├── codebase-*.md # research-gather (per category)
|
|
180
|
+
│ │ ├── docs-*.md # research-gather
|
|
181
|
+
│ │ ├── config-*.md # research-gather
|
|
182
|
+
│ │ ├── external-*.md # research-gather
|
|
183
|
+
│ │ └── [custom-category]-*.md # research-gather (dynamic categories)
|
|
184
|
+
│ └── synthesis.md # research-synthesize (reasoning log)
|
|
185
|
+
├── outputs/
|
|
186
|
+
│ ├── research-report.md # research-synthesize (main deliverable)
|
|
187
|
+
│ ├── solution-exploration.md # research-brainstorm (conditional)
|
|
188
|
+
│ ├── high-level-design.md # research-design (conditional)
|
|
189
|
+
│ └── decision-log.md # research-design (conditional)
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
---
|
|
193
|
+
|
|
194
|
+
## Research Types
|
|
195
|
+
|
|
196
|
+
| Type | Keywords | Focus | Typical Outputs |
|
|
197
|
+
| ---------------- | ---------------------------------------- | --------------------------- | --------------------------------- |
|
|
198
|
+
| **Technical** | "how does", "where is", "implementation" | Codebase analysis | Knowledge base, architecture docs |
|
|
199
|
+
| **Requirements** | "what are requirements", "user needs" | User/business needs | Specifications, requirements doc |
|
|
200
|
+
| **Literature** | "best practices", "industry standards" | External research | Recommendations, comparisons |
|
|
201
|
+
| **Mixed** | Multiple keywords, broad questions | Comprehensive investigation | All output types |
|
|
202
|
+
|
|
203
|
+
---
|
|
204
|
+
|
|
205
|
+
## Integration with Other Workflows
|
|
206
|
+
|
|
207
|
+
### As Standalone Research
|
|
208
|
+
|
|
209
|
+
**Command**: `/owflow:research [research-question | task-path]` — the dispatcher hands off step by step; `/owflow:goal-research <task-path>` runs the complete workflow in one session with interactive gates.
|
|
210
|
+
|
|
211
|
+
### As Embedded Research Phase (documentation only — no wiring)
|
|
212
|
+
|
|
213
|
+
> This is documentation for parent-orchestrator authors, NOT an execution path of this dispatcher: nothing here auto-invokes a parent, and no research subskill chains into development or migration steps.
|
|
214
|
+
|
|
215
|
+
In the split family, a parent orchestrator (development, migration) that needs research sequences the research subskills directly via the Skill tool — plan → gather → synthesize → the optional chain as chosen by the user — and SKIPS `research-finalize`-style completion: the parent handles next steps and keeps control of the flow. Design artifacts feed the parent's specification phase; the research report is saved in the parent task's `analysis/research/` context per the parent's own state setup.
|
|
216
|
+
|
|
217
|
+
**Handoff fields the parent reads**: refer to `research_outputs.*` in the template [src/templates/orchestrator-state-research.yml](../../templates/orchestrator-state-research.yml).
|
|
218
|
+
|
|
219
|
+
Full autonomous research (research as its own goal, every gate honored) = `/owflow:goal-research`. A `--no-exit` flag for embedded runs is deferred — not part of this design.
|
|
220
|
+
|
|
221
|
+
---
|
|
222
|
+
|
|
223
|
+
## Auto-Recovery
|
|
224
|
+
|
|
225
|
+
Retries are owned by each subskill (each `/owflow:research-*` SKILL.md carries its own max attempts and strategy).
|
|
226
|
+
|
|
227
|
+
---
|
|
228
|
+
|
|
229
|
+
## Command Flags
|
|
230
|
+
|
|
231
|
+
| Flag | Effect |
|
|
232
|
+
| --------------------------------- | ------------------------------------------------------------------------------------ |
|
|
233
|
+
| `--from=<slug>` | Hand off (resume mode) from a specific step slug |
|
|
234
|
+
| `--type=<type>` | Force the research type classification ("technical \| requirements \| literature \| mixed") |
|
|
235
|
+
|
|
236
|
+
There is deliberately NO quick entry on this dispatcher — condensed quick starts go through `/owflow:research-quick`, whose artifacts this routing table honors on every row.
|
|
237
|
+
|
|
238
|
+
---
|
|
239
|
+
|
|
240
|
+
## Command Integration
|
|
241
|
+
|
|
242
|
+
Invoked via:
|
|
243
|
+
|
|
244
|
+
- `/owflow:research [question] [--type=TYPE]` (new)
|
|
245
|
+
- `/owflow:research [task-path] [--from=<slug>]` (resume)
|
|
246
|
+
|
|
247
|
+
Alternative: `/owflow:goal-research <task-path>` — same task lifecycle, all subskills invoked in one session with `question` gates.
|
|
248
|
+
|
|
249
|
+
Task directory: `.owflow/tasks/research/YYYY-MM-DD-task-name/`
|