owflow 0.2.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.
Files changed (111) hide show
  1. package/README.md +83 -28
  2. package/dist/agents/code-reviewer.md +1 -1
  3. package/dist/agents/information-gatherer.md +691 -691
  4. package/dist/agents/production-readiness-checker.md +1 -1
  5. package/dist/agents/project-analyzer.md +0 -1
  6. package/dist/agents/research-planner.md +450 -447
  7. package/dist/agents/research-synthesizer.md +403 -401
  8. package/dist/agents/solution-brainstormer.md +257 -257
  9. package/dist/agents/solution-designer.md +372 -372
  10. package/dist/agents/task-classifier.md +3 -3
  11. package/dist/commands/agents-md-generator.md +36 -0
  12. package/dist/commands/dev-analyze.md +33 -0
  13. package/dist/commands/dev-bugfix.md +37 -0
  14. package/dist/commands/dev-finalize.md +33 -0
  15. package/dist/commands/dev-implement.md +34 -0
  16. package/dist/commands/dev-plan.md +37 -0
  17. package/dist/commands/dev-spec.md +37 -0
  18. package/dist/commands/dev-tdd-red.md +33 -0
  19. package/dist/commands/dev-verify.md +33 -0
  20. package/dist/commands/development.md +11 -12
  21. package/dist/commands/diagrams-mermaid.md +3 -4
  22. package/dist/commands/flow-init.md +3 -4
  23. package/dist/commands/goal-development.md +32 -0
  24. package/dist/commands/goal-research.md +33 -0
  25. package/dist/commands/html-renderer.md +3 -4
  26. package/dist/commands/migration.md +3 -4
  27. package/dist/commands/performance.md +3 -4
  28. package/dist/commands/research-brainstorm.md +33 -0
  29. package/dist/commands/research-converge.md +33 -0
  30. package/dist/commands/research-design.md +33 -0
  31. package/dist/commands/research-finalize.md +33 -0
  32. package/dist/commands/research-fork.md +40 -0
  33. package/dist/commands/research-gather.md +33 -0
  34. package/dist/commands/research-plan.md +37 -0
  35. package/dist/commands/research-quick.md +37 -0
  36. package/dist/commands/research-synthesize.md +33 -0
  37. package/dist/commands/research.md +55 -37
  38. package/dist/commands/reviews-code.md +4 -4
  39. package/dist/commands/reviews-pragmatic.md +4 -4
  40. package/dist/commands/reviews-production-readiness.md +4 -4
  41. package/dist/commands/reviews-reality-check.md +4 -4
  42. package/dist/commands/reviews-spec-audit.md +4 -4
  43. package/dist/commands/rule-reviewer.md +38 -0
  44. package/dist/commands/standards-discover.md +3 -4
  45. package/dist/commands/standards-update.md +3 -4
  46. package/dist/commands/work.md +21 -21
  47. package/dist/configuration/skills-config.js +1 -1
  48. package/dist/index.js +5 -2
  49. package/dist/skills/agents-md-generator/SKILL.md +223 -0
  50. package/dist/skills/codebase-analyzer/SKILL.md +1 -1
  51. package/dist/skills/dev-analyze/SKILL.md +115 -0
  52. package/dist/skills/dev-bugfix/SKILL.md +452 -0
  53. package/dist/skills/dev-finalize/SKILL.md +118 -0
  54. package/dist/skills/dev-implement/SKILL.md +167 -0
  55. package/dist/skills/dev-plan/SKILL.md +147 -0
  56. package/dist/skills/dev-spec/SKILL.md +182 -0
  57. package/dist/skills/dev-tdd-red/SKILL.md +94 -0
  58. package/dist/skills/dev-verify/SKILL.md +160 -0
  59. package/dist/skills/development/SKILL.md +130 -522
  60. package/dist/skills/diagrams-mermaid/SKILL.md +3 -1
  61. package/dist/skills/docs-manager/SKILL.md +4 -4
  62. package/dist/skills/docs-manager/references/agents-md-template.md +1 -1
  63. package/dist/skills/flow-init/SKILL.md +34 -13
  64. package/dist/skills/goal-development/SKILL.md +96 -0
  65. package/dist/skills/goal-research/SKILL.md +118 -0
  66. package/dist/skills/html-renderer/SKILL.md +14 -1
  67. package/dist/skills/implementation-plan-executor/SKILL.md +1 -1
  68. package/dist/skills/implementation-verifier/SKILL.md +1 -1
  69. package/dist/skills/migration/SKILL.md +63 -18
  70. package/dist/skills/orchestrator-framework/SKILL.md +1 -1
  71. package/dist/skills/orchestrator-framework/references/command-namespacing.md +7 -0
  72. package/dist/skills/orchestrator-framework/references/confirm-or-revise-exception.md +20 -0
  73. package/dist/skills/orchestrator-framework/references/delegation-rules.md +54 -0
  74. package/dist/skills/orchestrator-framework/references/dispatcher-handoff.md +27 -0
  75. package/dist/skills/orchestrator-framework/references/gate-contract.md +112 -0
  76. package/dist/skills/orchestrator-framework/references/orchestrator-creation-checklist.md +3 -0
  77. package/dist/skills/orchestrator-framework/references/orchestrator-patterns.md +8 -50
  78. package/dist/skills/performance/SKILL.md +52 -18
  79. package/dist/skills/research/SKILL.md +249 -462
  80. package/dist/skills/research-brainstorm/SKILL.md +120 -0
  81. package/dist/skills/{research → research-brainstorm}/references/brainstorming-techniques.md +1 -1
  82. package/dist/skills/research-converge/SKILL.md +130 -0
  83. package/dist/skills/research-design/SKILL.md +146 -0
  84. package/dist/skills/{research → research-design}/references/design-techniques.md +1 -1
  85. package/dist/skills/research-finalize/SKILL.md +125 -0
  86. package/dist/skills/research-fork/SKILL.md +190 -0
  87. package/dist/skills/research-gather/SKILL.md +133 -0
  88. package/dist/skills/research-plan/SKILL.md +141 -0
  89. package/dist/skills/research-quick/SKILL.md +139 -0
  90. package/dist/skills/research-synthesize/SKILL.md +127 -0
  91. package/dist/skills/rule-reviewer/SKILL.md +334 -0
  92. package/dist/skills/standards-discover/SKILL.md +37 -14
  93. package/dist/skills/standards-update/SKILL.md +58 -10
  94. package/dist/templates/orchestrator-state-development.yml +14 -13
  95. package/dist/templates/orchestrator-state-research.yml +19 -13
  96. package/dist/tools/fork_task.js +36 -0
  97. package/dist/tools/verify_template.js +10 -31
  98. package/dist/utils/file-util.js +14 -8
  99. package/dist/utils/fork-task.js +74 -0
  100. package/dist/utils/plugin-info.js +20 -0
  101. package/dist/utils/yaml-structure.js +32 -0
  102. package/package.json +1 -1
  103. package/dist/commands/quick-bugfix.md +0 -37
  104. package/dist/commands/quick-dev.md +0 -182
  105. package/dist/commands/quick-plan.md +0 -167
  106. package/dist/constants.js +0 -4
  107. package/dist/skills/quick-bugfix/SKILL.md +0 -311
  108. package/dist/templates/quick-bugfix-task.yml +0 -10
  109. package/dist/templates/quick-dev-task.yml +0 -10
  110. package/dist/templates/quick-plan-task.yml +0 -11
  111. /package/dist/skills/{research → research-plan}/references/research-methodologies.md +0 -0
@@ -1,462 +1,249 @@
1
- ---
2
- name: research
3
- description: Orchestrates comprehensive research workflows from question definition through findings documentation. Handles technical, requirements, literature, and mixed research types with adaptive methodology, multi-source gathering, pattern synthesis, and evidence-based reporting. Supports standalone research tasks and embedded research phase in other workflows.
4
- user-invocable: true
5
- ---
6
-
7
- # Research Orchestrator
8
-
9
- Systematic research workflow from question definition to evidence-based documentation.
10
-
11
- ## Initialization
12
-
13
- **BEFORE executing any phase, you MUST complete these steps:**
14
-
15
- ### Step 1: Load Framework Patterns
16
-
17
- **Read the framework reference file NOW using the Read tool:**
18
-
19
- 1. `../orchestrator-framework/references/orchestrator-patterns.md` - Delegation rules, interactive mode, state schema, initialization, context passing, issue resolution
20
-
21
- ### Step 2: Initialize Workflow
22
-
23
- 1. **Create Task Items**: Use `TaskCreate` for all phases (see Phase Configuration), then set dependencies with `TaskUpdate addBlockedBy`
24
- 2. **Create Task Directory**: `.owflow/tasks/research/YYYY-MM-DD-task-name/`
25
- 3. **Initialize State**: Create `orchestrator-state.yml` with research context
26
- - **CRITICAL**: Use the `verify_template` tool immediately after creation to check YAML validity against `orchestrator-state-research.yml`.
27
-
28
- **Output**:
29
-
30
- ```
31
- 🚀 Research Orchestrator Started
32
-
33
- Task: [research question]
34
- Directory: [task-path]
35
-
36
- Starting Phase 1: Initialize research...
37
- ```
38
-
39
- ---
40
-
41
- ## When to Use
42
-
43
- Use when:
44
-
45
- - Need comprehensive research on a topic
46
- - Exploring codebase patterns or architecture
47
- - Gathering requirements or best practices
48
- - Want systematic evidence-based answers
49
- - Research will feed into development workflows
50
-
51
- **DO NOT use for**: Development tasks, bug fixes, performance optimization.
52
-
53
- ---
54
-
55
- ## Core Principles
56
-
57
- 1. **Evidence-Based**: Every finding must have source citation
58
- 2. **Systematic**: Follow structured methodology for consistent results
59
- 3. **Multi-Source**: Gather from codebase, docs, config, external sources
60
- 4. **Synthesized**: Cross-reference findings, identify patterns
61
- 5. **Actionable**: Produce outputs that enable next steps
62
-
63
- ---
64
-
65
- ## Local References
66
-
67
- | File | When to Use | Purpose |
68
- | ---------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------- |
69
- | `references/research-methodologies.md` | Phase 1 | Research type classification, methodology selection, gathering strategies, analysis frameworks |
70
- | `references/brainstorming-techniques.md` | Phase 3 | Divergent/convergent thinking, interactive exploration, scope guardrails |
71
- | `references/design-techniques.md` | Phase 5 | Decision documentation (MADR), ADR guidance, decision linking |
72
-
73
- ---
74
-
75
- ## Phase Configuration
76
-
77
- | Phase | content | activeForm | Agent/Skill |
78
- | ----- | ------------------------------------------------------ | --------------------------------------- | ---------------------------------------------------------------------------- |
79
- | 1 | "Research foundation (init, plan, gather, synthesize)" | "Executing research foundation" | Direct + research-planner + information-gatherer (xN) + research-synthesizer |
80
- | 2 | "Evaluate brainstorming value" | "Evaluating brainstorming value" | Direct |
81
- | 3 | "Generate solution alternatives" | "Generating solution alternatives" | solution-brainstormer |
82
- | 4 | "Evaluate brainstorming alternatives" | "Evaluating brainstorming alternatives" | Direct (interactive) |
83
- | 5 | "Design high-level architecture" | "Designing high-level architecture" | Direct + solution-designer |
84
- | 6 | "Summarize research and suggest next steps" | "Completing research" | Direct |
85
-
86
- ---
87
-
88
- ## Research Types
89
-
90
- | Type | Keywords | Focus | Typical Outputs |
91
- | ---------------- | ---------------------------------------- | --------------------------- | --------------------------------- |
92
- | **Technical** | "how does", "where is", "implementation" | Codebase analysis | Knowledge base, architecture docs |
93
- | **Requirements** | "what are requirements", "user needs" | User/business needs | Specifications, requirements doc |
94
- | **Literature** | "best practices", "industry standards" | External research | Recommendations, comparisons |
95
- | **Mixed** | Multiple keywords, broad questions | Comprehensive investigation | All output types |
96
-
97
- ---
98
-
99
- ## Workflow Phases
100
-
101
- ### Phase 1: Research Foundation
102
-
103
- **Purpose**: Initialize research, plan methodology, gather information from all sources, and synthesize findings into a research report
104
- **Execute**: Multi-step: Direct + research-planner + information-gatherer (xN) + research-synthesizer
105
- **Output**: `planning/research-brief.md`, `planning/research-plan.md`, `planning/sources.md`, `analysis/findings/*.md`, `analysis/synthesis.md`, `outputs/research-report.md`
106
- **State**: Set `research_context.research_type`, `research_question`, `scope`, `methodology`, `sources`, `confidence_level`, `gathering_strategy`
107
-
108
- This phase executes 4 sequential steps. On resume, check existing artifacts to skip completed steps.
109
-
110
- #### Step 1: Initialize (Direct)
111
-
112
- **Artifacts**: `planning/research-brief.md`
113
- **Resume check**: If `planning/research-brief.md` exists, skip to Step 2
114
-
115
- 1. Parse research question (from command or prompt user)
116
- 2. Classify research type (auto-detect from keywords or use `--type` flag)
117
- 3. Determine scope (included, excluded, constraints)
118
- 4. Define success criteria
119
- 5. Create research brief
120
- 6. Update state: set `research_context.research_type`, `research_question`, `scope`
121
- 7. **Discover project documentation**: Read `.owflow/docs/INDEX.md` (if exists), extract ALL file paths from the "Project Documentation" section — includes predefined docs AND any user-added project docs. Store as `research_context.project_doc_paths` in state.
122
-
123
- #### Step 2: Plan (Subagent)
124
-
125
- **Artifacts**: `planning/research-plan.md`, `planning/sources.md`
126
- **Resume check**: If `planning/research-plan.md` AND `planning/sources.md` exist, skip to Step 3
127
-
128
- **Read `references/research-methodologies.md` NOW using the Read tool** — research type classification, methodology selection, gathering strategies
129
-
130
- **INVOKE NOW**: Use Task tool with `subagent_type: research-planner`
131
-
132
- **Context to pass**: task_path, research_brief_path, research_type, research_question, scope, project_doc_paths (from state)
133
-
134
- Update state: `research_context.methodology`, `sources`
135
-
136
- #### Step 3: Gather + Merge (Parallel Subagents + Direct)
137
-
138
- **Artifacts**: `analysis/findings/*.md` (category-specific)
139
- **Resume check**: If any `analysis/findings/*.md` files exist, skip to Step 4
140
-
141
- **Determine gatherer count and categories**:
142
-
143
- 1. Read `planning/research-plan.md` for **Gathering Strategy** section
144
- 2. If gathering strategy found: use specified categories and count (cap at 8 max)
145
- 3. If no gathering strategy: fall back to default 4 categories (codebase, documentation, configuration, external)
146
- 4. Update state: `research_context.gathering_strategy`
147
-
148
- **CRITICAL: Launch all N agents in ONE message for parallel execution.**
149
-
150
- **Parallel Execution Pattern**:
151
-
152
- ```
153
- Read gathering strategy from research-plan.md
154
- For each category in strategy:
155
- Use Task tool: source_category=[category_id] → analysis/findings/[prefix]-*.md
156
- ```
157
-
158
- #### Step 4: Synthesize (Subagent)
159
-
160
- **Artifacts**: `analysis/synthesis.md`, `outputs/research-report.md`
161
- **Resume check**: If `analysis/synthesis.md` AND `outputs/research-report.md` exist, skip (Phase 1 complete)
162
-
163
- **INVOKE NOW**: Use Task tool with `subagent_type: research-synthesizer`
164
-
165
- **Context to pass**: task_path, findings_directory_path, research_question, research_type, methodology
166
-
167
- **Synthesizer produces**:
168
-
169
- - Pattern analysis and cross-references (`analysis/synthesis.md`)
170
- - Comprehensive research report answering research question (`outputs/research-report.md`)
171
- - Confidence levels for each finding
172
- - Documented gaps and uncertainties
173
-
174
- Update state: `research_context.confidence_level`
175
-
176
- ---
177
-
178
- → Pause
179
-
180
- question - "Research foundation complete (initialized, planned, gathered, synthesized). Continue to brainstorming evaluation?"
181
-
182
- ---
183
-
184
- ### Phase 2: Optional Phases Decision
185
-
186
- > **Phase gate**: Requires `question` confirmation from Phase 1 before executing.
187
-
188
- **Purpose**: Evaluate whether brainstorming and/or design phases would be valuable (independently)
189
- **Execute**: Direct
190
- **Output**: Updated `orchestrator-state.yml`
191
- **State**: Set `options.brainstorming_enabled`, `options.design_enabled`
192
-
193
- **Auto-resolve if**: `--brainstorm`/`--no-brainstorm` flags (brainstorming only), `--design`/`--no-design` flags (design only)
194
-
195
- **Process**:
196
-
197
- 1. Read `analysis/synthesis.md` summary and `research_type` from state
198
- 2. Evaluate brainstorming value based on:
199
- - Number of viable approaches identified in synthesis (multiple → valuable)
200
- - Problem novelty (new domain → valuable; well-understood → less so)
201
- - Whether synthesis identified competing trade-offs (yes → valuable)
202
- 3. Evaluate design value based on:
203
- - Whether research suggests architectural decisions (yes → valuable)
204
- - Research type (requirements/mixed → likely valuable; technical → depends)
205
- - Whether design artifacts would feed into development workflow
206
- 4. If `brainstorming_enabled` not already set by flag, question:
207
- - "[Brainstorming recommendation]. Would you like to explore solution alternatives?"
208
- - Options: "Yes, explore alternatives" / "No, skip brainstorming"
209
- 5. If `design_enabled` not already set by flag, question:
210
- - "[Design recommendation]. Would you like to generate a high-level design?"
211
- - Options: "Yes, generate design" / "No, skip design"
212
- 6. Update state: set `brainstorming_enabled` and `design_enabled`
213
-
214
- → If brainstorming enabled: continue to Phase 3
215
- → If brainstorming disabled AND design enabled: skip to Phase 5
216
- → If both disabled: skip to Phase 6
217
-
218
- ---
219
-
220
- ### Phase 3: Solution Generation
221
-
222
- **Purpose**: Generate solution alternatives from research evidence using specialized brainstormer subagent
223
- **Execute**: solution-brainstormer subagent
224
- **Output**: `outputs/solution-exploration.md`
225
- **State**: Update `phase_summaries.phase-3`
226
-
227
- **Skip if**: `brainstorming_enabled = false` (user chose to skip in Phase 2, or `--no-brainstorm` flag)
228
-
229
- **Read `references/brainstorming-techniques.md` NOW using the Read tool** — divergent/convergent thinking techniques, scope guardrails
230
-
231
- > **ANTI-PATTERN**: Do NOT generate solution alternatives inline. The solution-brainstormer agent has specialized multi-perspective analysis capabilities.
232
-
233
- **INVOKE NOW**: Use Task tool with `subagent_type: solution-brainstormer`
234
-
235
- **Context to pass** (Pattern 7):
236
-
237
- - `task_path`, `synthesis_path`, `research_report_path`
238
- - `output_path`: `outputs/solution-exploration.md` — brainstormer MUST write to this exact path
239
- - Accumulated context: `research_type`, `research_question`, `confidence_level`, `phase_summaries` (Phase 1)
240
- - `project_doc_paths` (from state)
241
-
242
- > **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.
243
-
244
- → **AUTO-CONTINUE**
245
-
246
- ---
247
-
248
- ### Phase 4: Solution Convergence
249
-
250
- **Purpose**: Present brainstorming alternatives to user for decision-making on each decision area
251
- **Execute**: Direct (interactive)
252
- **Output**: Updated `orchestrator-state.yml` with chosen approaches
253
- **State**: Update `phase_summaries.phase-4` with `decision_areas` and `deferred_ideas`
254
-
255
- **Skip if**: `brainstorming_enabled = false`
256
- **Resume check**: If `phase_summaries.phase-4.decision_areas` has entries with `chosen_approach` set, skip already-resolved areas
257
-
258
- > **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.
259
- >
260
- > **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.
261
-
262
- 1. Read `outputs/solution-exploration.md`
263
- 2. For each decision area sequentially, output ALL of the following (steps a-d) BEFORE calling question:
264
- a. **Area header**: area name and why this decision matters (1-2 sentences of context)
265
- b. **Alternatives detail**: For EVERY alternative in this area, show:
266
- - Name and description (2-3 sentences)
267
- - Pros (bullet list)
268
- - Cons (bullet list)
269
- c. **Recommendation**: which alternative is recommended and why (1 sentence)
270
- d. **question**: this area's alternatives as options (mark recommended with "(Recommended)") + "Need more info" option
271
- e. If user picks → record choice, move to next area
272
- f. If "Need more info" → present the detailed trade-off analysis for the requested alternative, then re-ask
273
-
274
- > **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.
275
-
276
- 3. After all areas resolved, present a brief summary of the chosen combination
277
- 4. Update state with chosen approaches per decision area
278
-
279
- > **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.
280
-
281
- → Pause
282
-
283
- question - "Brainstorming complete. Continue to high-level design?"
284
-
285
- ---
286
-
287
- ### Phase 5: High-Level Design
288
-
289
- > **Phase gate**: Requires `question` confirmation from the preceding phase before executing.
290
-
291
- **Purpose**: Create architecture design from selected solution approach
292
- **Execute**: Orchestrator-Direct Hybrid
293
- **Output**: `outputs/high-level-design.md`, `outputs/decision-log.md`
294
- **State**: Update `phase_summaries.phase-5`
295
-
296
- **Skip if**: `design_enabled = false`
297
-
298
- **Read `references/design-techniques.md` NOW using the Read tool** — MADR format, ADR guidance, decision documentation patterns
299
-
300
- **Part A — Design Direction (Direct)**:
301
-
302
- 1. If Phase 4 ran: confirm selected approaches from convergence
303
- 2. If Phase 4 was skipped: use research report recommendations as design input
304
- 3. question for any design preferences or constraints (e.g., "Any architectural constraints or preferences?")
305
-
306
- **Part B — Design Generation (Subagent)**:
307
-
308
- > **ANTI-PATTERN**: Do NOT generate C4 architecture diagrams or ADRs inline. The solution-designer agent has specialized architecture and MADR documentation capabilities.
309
-
310
- **INVOKE NOW**: Use Task tool with `subagent_type: solution-designer`
311
-
312
- **Context to pass** (Pattern 7):
313
-
314
- - `task_path`, `synthesis_path`, `research_report_path`
315
- - `solution_exploration_path` (only if Phase 3-4 ran)
316
- - `selected_approach` (from Phase 4 convergence if ran, or from research report recommendations)
317
- - `design_preferences` (from Part A)
318
- - Accumulated context: `research_type`, `research_question`, `confidence_level`, `phase_summaries`
319
- - `project_doc_paths` (from state)
320
-
321
- > **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.
322
-
323
- **Part C — Summary (Direct)**: 3. Read `outputs/high-level-design.md` and `outputs/decision-log.md` 4. Present executive summary to user:
324
-
325
- - Architecture style and key components
326
- - Number of architectural decisions recorded
327
- - Key decision highlights (1 line each)
328
- - Integration points with existing system (if applicable)
329
-
330
- **Part D — Diagram Refinement (Skill, content-preserving)**:
331
-
332
- 5. Invoke Skill tool: `diagrams-mermaid` to refine visual communication in `outputs/high-level-design.md`
333
- 6. Add diagrams that supplement (not replace) existing architecture content:
334
- - one architecture view (`C4Container` preferred, `C4Component` only if needed),
335
- - one interaction/state view (`sequenceDiagram` or `flowchart`) for the critical flow.
336
- 7. If minimum context for a diagram is missing, record explicit gaps in the document and avoid speculative components/relationships.
337
-
338
- → Pause
339
-
340
- question - "Design complete. Continue to output generation?"
341
-
342
- ---
343
-
344
- ### Phase 6: Completion
345
-
346
- > **Phase gate**: Requires `question` confirmation from the preceding phase before executing.
347
-
348
- **Purpose**: Summarize research results and suggest next steps
349
- **Execute**: Direct
350
- **Output**: No new files — summarizes existing outputs
351
-
352
- **Process**:
353
-
354
- 1. Inventory all generated outputs: `outputs/research-report.md` (always), plus conditional: `solution-exploration.md`, `high-level-design.md`, `decision-log.md`
355
- 2. Present executive summary to user:
356
- - Key findings and confidence level
357
- - Which optional phases ran (brainstorming, design)
358
- - Key decision highlights (if brainstorming/design ran)
359
- 3. If design artifacts exist, suggest starting development in a fresh session:
360
- ```
361
- To start development based on this research, clear context first or start a new session, then run:
362
- /development [task-path]
363
- ```
364
-
365
- → End of workflow
366
-
367
- ---
368
-
369
- ## Domain Context (State Extensions)
370
-
371
- Research-specific fields in `orchestrator-state.yml`:
372
-
373
- Refer to the template [src/templates/orchestrator-state-research.yml](../../templates/orchestrator-state-research.yml).
374
-
375
- ---
376
-
377
- ## Task Structure
378
-
379
- ```
380
- .owflow/tasks/research/YYYY-MM-DD-research-name/
381
- ├── orchestrator-state.yml
382
- ├── planning/
383
- │ ├── research-brief.md # Phase 1, Step 1
384
- │ ├── research-plan.md # Phase 1, Step 2
385
- │ └── sources.md # Phase 1, Step 2
386
- ├── analysis/
387
- │ ├── findings/
388
- │ │ ├── codebase-*.md # Phase 1, Step 3
389
- │ │ ├── docs-*.md # Phase 1, Step 3
390
- │ │ ├── config-*.md # Phase 1, Step 3
391
- │ │ ├── external-*.md # Phase 1, Step 3
392
- │ │ └── [custom-category]-*.md # Phase 1, Step 3 (dynamic categories)
393
- │ └── synthesis.md # Phase 1, Step 4 (reasoning log)
394
- ├── outputs/
395
- │ ├── research-report.md # Phase 1, Step 4 (main deliverable)
396
- │ ├── solution-exploration.md # Phase 3 (conditional)
397
- │ ├── high-level-design.md # Phase 5 (conditional)
398
- │ └── decision-log.md # Phase 5 (conditional)
399
- ```
400
-
401
- ---
402
-
403
- ## Auto-Recovery
404
-
405
- | Phase | Max Attempts | Strategy |
406
- | ---------- | ------------ | ------------------------------------------------------------- |
407
- | 1 (Step 1) | 1 | Prompt user for clarification if question unclear |
408
- | 1 (Step 2) | 2 | Expand search patterns, use fallback mixed methodology |
409
- | 1 (Step 3) | 3 | Retry failed agents only, continue with successful categories |
410
- | 1 (Step 4) | 2 | Request targeted re-gathering for gaps |
411
- | 2 | 1 | Re-evaluate recommendation if synthesis unclear |
412
- | 3 | 2 | Re-invoke solution-brainstormer with adjusted context |
413
- | 4 | 1 | Re-read exploration file, re-present decision areas |
414
- | 5 | 2 | Re-invoke solution-designer with adjusted context |
415
- | 6 | 0 | Summary only |
416
-
417
- ---
418
-
419
- ## Integration with Other Workflows
420
-
421
- ### As Standalone Research
422
-
423
- **Command**: `/research [research-question]`
424
- **Flow**: Complete all phases, save outputs in task directory
425
-
426
- ### As Embedded Research Phase
427
-
428
- **Invoked by**: development orchestrator, migration orchestrator
429
-
430
- **Integration**:
431
-
432
- 1. Parent orchestrator invokes research skill
433
- 2. Research executes phases 1-5 (skip Phase 6 completion — parent orchestrator handles next steps)
434
- 3. Design outputs fed into parent's specification phase
435
- 4. Research report saved in parent task's `analysis/research/` directory
436
-
437
- **Handoff**:
438
-
439
- Refer to `research_outputs` in the template [src/templates/orchestrator-state-research.yml](../../templates/orchestrator-state-research.yml).
440
-
441
- ---
442
-
443
- ## Command Integration
444
-
445
- Invoked via:
446
-
447
- - `/research [question] [--type=TYPE] [--brainstorm] [--no-brainstorm] [--design] [--no-design]` (new)
448
- - `/research [task-path] [--from=PHASE]` (resume)
449
-
450
- **Brainstorming flags**:
451
-
452
- - `--brainstorm`: Force brainstorming phase (auto-resolves Phase 2 brainstorming decision to "enable")
453
- - `--no-brainstorm`: Skip brainstorming phase
454
- - Neither: Phase 2 presents recommendation and asks user
455
-
456
- **Design flags**:
457
-
458
- - `--design`: Force high-level design phase (auto-resolves Phase 2 design decision to "enable")
459
- - `--no-design`: Skip high-level design phase
460
- - Neither: Phase 2 presents recommendation and asks user
461
-
462
- 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/`