ace-handbook 0.19.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.
Files changed (85) hide show
  1. checksums.yaml +7 -0
  2. data/.ace-defaults/handbook/config.yml +4 -0
  3. data/.ace-defaults/nav/protocols/guide-sources/ace-handbook.yml +19 -0
  4. data/.ace-defaults/nav/protocols/tmpl-sources/ace-handbook.yml +10 -0
  5. data/.ace-defaults/nav/protocols/wfi-sources/ace-handbook.yml +19 -0
  6. data/CHANGELOG.md +362 -0
  7. data/LICENSE +21 -0
  8. data/README.md +42 -0
  9. data/Rakefile +12 -0
  10. data/exe/ace-handbook +6 -0
  11. data/handbook/guides/ai-agent-integration.g.md +625 -0
  12. data/handbook/guides/atom-pattern.g.md +371 -0
  13. data/handbook/guides/changelog.g.md +333 -0
  14. data/handbook/guides/cli-dry-cli.g.md +276 -0
  15. data/handbook/guides/cli-support-cli.g.md +277 -0
  16. data/handbook/guides/coding-standards/ruby.md +41 -0
  17. data/handbook/guides/coding-standards/rust.md +19 -0
  18. data/handbook/guides/coding-standards/typescript.md +20 -0
  19. data/handbook/guides/coding-standards.g.md +134 -0
  20. data/handbook/guides/debug-troubleshooting.g.md +62 -0
  21. data/handbook/guides/error-handling/ruby.md +29 -0
  22. data/handbook/guides/error-handling/rust.md +59 -0
  23. data/handbook/guides/error-handling/typescript.md +38 -0
  24. data/handbook/guides/error-handling.g.md +207 -0
  25. data/handbook/guides/meta/agents-definition.g.md +823 -0
  26. data/handbook/guides/meta/guides-definition.g.md +322 -0
  27. data/handbook/guides/meta/markdown-definition.g.md +210 -0
  28. data/handbook/guides/meta/tools-definition.g.md +159 -0
  29. data/handbook/guides/meta/workflow-instructions-definition.g.md +367 -0
  30. data/handbook/guides/mono-repo-patterns.g.md +92 -0
  31. data/handbook/guides/multi-agent-research.g.md +251 -0
  32. data/handbook/guides/performance/ruby.md +25 -0
  33. data/handbook/guides/performance/rust.md +48 -0
  34. data/handbook/guides/performance/typescript.md +32 -0
  35. data/handbook/guides/performance.g.md +211 -0
  36. data/handbook/guides/prompt-caching.g.md +83 -0
  37. data/handbook/guides/quality-assurance/ruby.md +33 -0
  38. data/handbook/guides/quality-assurance/rust.md +41 -0
  39. data/handbook/guides/quality-assurance/typescript.md +49 -0
  40. data/handbook/guides/quality-assurance.g.md +222 -0
  41. data/handbook/guides/strategic-planning.g.md +69 -0
  42. data/handbook/guides/troubleshooting/ruby.md +21 -0
  43. data/handbook/guides/troubleshooting/rust.md +20 -0
  44. data/handbook/guides/troubleshooting/typescript.md +36 -0
  45. data/handbook/guides/workflow-context-embedding.g.md +286 -0
  46. data/handbook/skills/as-handbook-init-project/SKILL.md +34 -0
  47. data/handbook/skills/as-handbook-manage-agents/SKILL.md +35 -0
  48. data/handbook/skills/as-handbook-manage-guides/SKILL.md +35 -0
  49. data/handbook/skills/as-handbook-manage-workflows/SKILL.md +35 -0
  50. data/handbook/skills/as-handbook-parallel-research/SKILL.md +29 -0
  51. data/handbook/skills/as-handbook-perform-delivery/SKILL.md +35 -0
  52. data/handbook/skills/as-handbook-review-guides/SKILL.md +32 -0
  53. data/handbook/skills/as-handbook-review-workflows/SKILL.md +32 -0
  54. data/handbook/skills/as-handbook-synthesize-research/SKILL.md +29 -0
  55. data/handbook/skills/as-handbook-update-docs/SKILL.md +35 -0
  56. data/handbook/skills/as-release/SKILL.md +50 -0
  57. data/handbook/skills/as-release-bump-version/SKILL.md +28 -0
  58. data/handbook/skills/as-release-rubygems-publish/SKILL.md +58 -0
  59. data/handbook/skills/as-release-update-changelog/SKILL.md +28 -0
  60. data/handbook/templates/completed-work-documentation.md +59 -0
  61. data/handbook/templates/cookbooks/cookbook.template.md +237 -0
  62. data/handbook/templates/research-comparison.template.md +175 -0
  63. data/handbook/workflow-instructions/handbook/init-project.wf.md +629 -0
  64. data/handbook/workflow-instructions/handbook/manage-agents.wf.md +379 -0
  65. data/handbook/workflow-instructions/handbook/manage-guides.wf.md +294 -0
  66. data/handbook/workflow-instructions/handbook/manage-workflows.wf.md +292 -0
  67. data/handbook/workflow-instructions/handbook/parallel-research.wf.md +328 -0
  68. data/handbook/workflow-instructions/handbook/perform-delivery.wf.md +267 -0
  69. data/handbook/workflow-instructions/handbook/research.wf.md +247 -0
  70. data/handbook/workflow-instructions/handbook/review-guides.wf.md +348 -0
  71. data/handbook/workflow-instructions/handbook/review-workflows.wf.md +299 -0
  72. data/handbook/workflow-instructions/handbook/synthesize-research.wf.md +429 -0
  73. data/handbook/workflow-instructions/handbook/update-docs.wf.md +338 -0
  74. data/lib/ace/handbook/atoms/provider_registry.rb +70 -0
  75. data/lib/ace/handbook/cli/commands/status.rb +36 -0
  76. data/lib/ace/handbook/cli/commands/sync.rb +36 -0
  77. data/lib/ace/handbook/cli.rb +51 -0
  78. data/lib/ace/handbook/models/skill_document.rb +25 -0
  79. data/lib/ace/handbook/molecules/skill_projection.rb +54 -0
  80. data/lib/ace/handbook/organisms/provider_syncer.rb +106 -0
  81. data/lib/ace/handbook/organisms/skill_inventory.rb +54 -0
  82. data/lib/ace/handbook/organisms/status_collector.rb +181 -0
  83. data/lib/ace/handbook/version.rb +7 -0
  84. data/lib/ace/handbook.rb +28 -0
  85. metadata +227 -0
@@ -0,0 +1,429 @@
1
+ ---
2
+ doc-type: workflow
3
+ title: Synthesize Research Workflow
4
+ purpose: Documentation for ace-handbook/handbook/workflow-instructions/handbook/synthesize-research.wf.md
5
+ ace-docs:
6
+ last-updated: 2026-03-12
7
+ last-checked: 2026-03-21
8
+ ---
9
+
10
+ # Synthesize Research Workflow
11
+
12
+ ## Goal
13
+
14
+ Combine parallel agent research outputs into a unified, high-quality result through structured comparison, conflict resolution, and synthesis.
15
+
16
+ ## Prerequisites
17
+
18
+ - Research folder containing outputs from multiple agents
19
+ - Completed parallel research phase (see `wfi://handbook/parallel-research`)
20
+ - Understanding of multi-agent research principles (see `guide://multi-agent-research`)
21
+
22
+ ## Project Context Loading
23
+
24
+ - Load multi-agent research guide: `ace-bundle guide://multi-agent-research`
25
+ - Load comparison template: `ace-bundle tmpl://research-comparison`
26
+ - List research folder contents to identify agent outputs
27
+
28
+ ## High-Level Execution Plan
29
+
30
+ ### Phase 1: Inventory
31
+ - [ ] List all agent outputs (reports and supplementary artifacts)
32
+ - [ ] Create comparison matrix from template
33
+ - [ ] Mark artifact presence and initial quality assessment
34
+
35
+ ### Phase 2: Compare
36
+ - [ ] Side-by-side analysis by artifact type
37
+ - [ ] Note conflicts and disagreements
38
+ - [ ] Rate depth, accuracy, actionability (1-5 scale)
39
+
40
+ ### Phase 3: Resolve
41
+ - [ ] Document each conflict with both positions
42
+ - [ ] Research/verify factual disagreements
43
+ - [ ] Make decisions with documented rationale
44
+
45
+ ### Phase 4: Synthesize
46
+ - [ ] Select base for each artifact (most comprehensive)
47
+ - [ ] Merge unique contributions from other agents
48
+ - [ ] Ensure consistent terminology
49
+ - [ ] Credit source reports
50
+
51
+ ### Phase 5: Validate
52
+ - [ ] Completeness check (nothing valuable lost)
53
+ - [ ] Consistency check (no contradictions)
54
+ - [ ] Gap identification (for future work)
55
+
56
+ ## Process Steps
57
+
58
+ ### Phase 1: Inventory
59
+
60
+ 1. **List All Agent Outputs**
61
+
62
+ Scan the research folder to identify all outputs:
63
+ ```bash
64
+ ls -la {research_folder}/
65
+ ```
66
+
67
+ Expected pattern:
68
+ ```
69
+ {ts1}-{agent1}-report.md
70
+ {ts1}-{agent1}-report-enhanced.md (if cross-review done)
71
+ {ts1}-{agent1}-supplementary/
72
+ {ts2}-{agent2}-report.md
73
+ ...
74
+ ```
75
+
76
+ 2. **Create Comparison Matrix**
77
+
78
+ Copy the comparison template to synthesis folder:
79
+ ```
80
+ {research_folder}/synthesis/comparison-matrix.md
81
+ ```
82
+
83
+ Fill in the Overview section:
84
+ - Task description
85
+ - Agent list with models
86
+ - Timestamp range
87
+ - Research folder path
88
+
89
+ 3. **Catalog All Artifacts**
90
+
91
+ For each agent, list:
92
+ - Main report (and enhanced version if exists)
93
+ - Guides (`.g.md` files)
94
+ - Workflows (`.wf.md` files)
95
+ - Templates (`.template.md` files)
96
+ - Skills (if any)
97
+
98
+ Record in the Artifact Inventory section of the matrix.
99
+
100
+ 4. **Initial Quality Assessment**
101
+
102
+ For each artifact, provide initial rating (1-5):
103
+ - 5: Comprehensive, thorough, actionable
104
+ - 4: Good coverage with useful detail
105
+ - 3: Adequate, covers basics
106
+ - 2: Basic, some gaps
107
+ - 1: Minimal, significant issues
108
+
109
+ ### Phase 2: Compare
110
+
111
+ 1. **Reports Comparison**
112
+
113
+ For main reports, analyze:
114
+
115
+ | Dimension | What to Compare |
116
+ |-----------|-----------------|
117
+ | Coverage | Which topics each report addresses |
118
+ | Depth | Level of detail on key topics |
119
+ | Structure | Organization and readability |
120
+ | Evidence | Use of sources and citations |
121
+ | Actionability | Practical recommendations |
122
+
123
+ Fill in the "Reports Comparison" section of the matrix.
124
+
125
+ 2. **Artifacts Comparison**
126
+
127
+ For each artifact type (guides, workflows, templates):
128
+ - Identify overlapping artifacts (same purpose, different implementations)
129
+ - Note unique artifacts (only one agent produced)
130
+ - Compare quality of overlapping artifacts
131
+
132
+ Fill in comparison tables for each type.
133
+
134
+ 3. **Document Disagreements**
135
+
136
+ When agents disagree on facts, recommendations, or approaches:
137
+ - Record in the Conflict Log section
138
+ - Note the topic and each agent's position
139
+ - Mark for resolution in Phase 3
140
+
141
+ ### Phase 3: Resolve
142
+
143
+ 1. **Process Each Conflict**
144
+
145
+ For each entry in the Conflict Log:
146
+
147
+ a. **Document Both Positions**
148
+ - What does Agent A claim/recommend?
149
+ - What does Agent B claim/recommend?
150
+ - Are there more positions from other agents?
151
+
152
+ b. **Research/Verify**
153
+ - If factual disagreement: check authoritative sources
154
+ - If recommendation disagreement: evaluate trade-offs
155
+ - If approach disagreement: consider context and use cases
156
+
157
+ c. **Make Decision**
158
+ - Choose the stronger position OR
159
+ - Synthesize a combined approach OR
160
+ - Note as "context-dependent" with guidance
161
+
162
+ d. **Record Rationale**
163
+ - Why was this resolution chosen?
164
+ - What evidence supports it?
165
+ - What are the trade-offs?
166
+
167
+ 2. **Update Conflict Log**
168
+
169
+ Complete the Resolution and Rationale fields for each conflict.
170
+
171
+ ### Phase 4: Synthesize
172
+
173
+ 1. **Create Synthesis Folder Structure**
174
+ ```
175
+ {research_folder}/synthesis/
176
+ ├── report.md # Unified report
177
+ ├── comparison-matrix.md # Decisions documented
178
+ ├── sources.md # Attribution
179
+ └── artifacts/
180
+ ├── guides/
181
+ ├── workflows/
182
+ ├── templates/
183
+ └── skills/
184
+ ```
185
+
186
+ 2. **Synthesize Main Report**
187
+
188
+ a. **Select Base**
189
+ - Choose the most comprehensive report as starting point
190
+ - Usually the highest-rated report from Phase 2
191
+
192
+ b. **Merge Unique Content**
193
+ - From each other report, identify unique valuable content
194
+ - Add to the base report with attribution
195
+ - Example: "As noted in the Gemini analysis..."
196
+
197
+ c. **Integrate Resolved Conflicts**
198
+ - Replace conflicting sections with resolved positions
199
+ - Include rationale where helpful
200
+
201
+ d. **Ensure Consistency**
202
+ - Standardize terminology across merged content
203
+ - Smooth transitions between sections
204
+ - Remove redundancy
205
+
206
+ 3. **Synthesize Artifacts**
207
+
208
+ For each artifact type:
209
+
210
+ | Scenario | Action |
211
+ |----------|--------|
212
+ | One agent only | Use as-is with attribution |
213
+ | Multiple similar | Merge best elements |
214
+ | Multiple different | Keep both if distinct purposes |
215
+ | Low quality only | Improve or note gap |
216
+
217
+ Apply decisions from comparison matrix.
218
+
219
+ 4. **Create Attribution Document**
220
+
221
+ In `synthesis/sources.md`:
222
+ ```markdown
223
+ # Synthesis Sources
224
+
225
+ ## Agent Contributions
226
+
227
+ ### Agent A (Claude, 8ous1t)
228
+ - Base for main report structure
229
+ - Guides: multi-agent-research.g.md
230
+ - Workflows: synthesize-research.wf.md
231
+
232
+ ### Agent B (Gemini, 8ous2a)
233
+ - Examples section in main report
234
+ - Templates: research-comparison.template.md
235
+
236
+ ### Agent C (Codex, 8ous3b)
237
+ - Edge cases analysis
238
+ - Skills: parallel-research skill
239
+ ```
240
+
241
+ ### Phase 5: Validate
242
+
243
+ 1. **Completeness Check**
244
+
245
+ Review against original agent outputs:
246
+ - [ ] All key findings from each report are represented
247
+ - [ ] No valuable artifacts were accidentally dropped
248
+ - [ ] Unique contributions from each agent preserved
249
+ - [ ] All conflicts have documented resolutions
250
+
251
+ 2. **Consistency Check**
252
+
253
+ Review the synthesized output:
254
+ - [ ] No contradictions within the report
255
+ - [ ] Terminology is consistent throughout
256
+ - [ ] Recommendations align with findings
257
+ - [ ] Cross-references are accurate
258
+
259
+ 3. **Gap Identification**
260
+
261
+ Document any gaps discovered:
262
+ - Topics no agent covered adequately
263
+ - Questions raised but not answered
264
+ - Areas needing future research
265
+
266
+ Record in the Gaps Identified section of the matrix.
267
+
268
+ 4. **Final Quality Assessment**
269
+
270
+ Rate the synthesis overall:
271
+ - Does it exceed the quality of individual reports?
272
+ - Are the best insights from each agent preserved?
273
+ - Is it actionable and well-organized?
274
+
275
+ ## Embedded Templates
276
+
277
+ ### Synthesis Report Template
278
+
279
+ ```markdown
280
+ # {Topic} - Synthesis Report
281
+
282
+ **Synthesized**: {date}
283
+ **Sources**: {agent1} ({model}), {agent2} ({model}), {agent3} ({model})
284
+ **Research Folder**: {path}
285
+
286
+ ## Executive Summary
287
+
288
+ [Combined key findings and recommendations]
289
+
290
+ ## Methodology
291
+
292
+ This report synthesizes parallel research from {N} AI agents:
293
+ - {Agent1}: {brief contribution description}
294
+ - {Agent2}: {brief contribution description}
295
+ - {Agent3}: {brief contribution description}
296
+
297
+ Synthesis followed the multi-agent research workflow with:
298
+ - {N} artifacts compared
299
+ - {N} conflicts resolved
300
+ - {N} gaps identified
301
+
302
+ ## Findings
303
+
304
+ ### {Topic 1}
305
+
306
+ [Synthesized content with attribution where relevant]
307
+
308
+ ### {Topic 2}
309
+
310
+ [Synthesized content]
311
+
312
+ ## Recommendations
313
+
314
+ 1. **{Recommendation 1}**
315
+ - Rationale: [why]
316
+ - Source: [which agent(s) proposed]
317
+
318
+ 2. **{Recommendation 2}**
319
+ - Rationale: [why]
320
+ - Source: [which agent(s) proposed]
321
+
322
+ ## Artifacts Produced
323
+
324
+ | Artifact | Type | Description |
325
+ |----------|------|-------------|
326
+ | [name] | guide | [description] |
327
+ | [name] | workflow | [description] |
328
+
329
+ ## Gaps for Future Work
330
+
331
+ - [Gap 1]: [description and suggested follow-up]
332
+ - [Gap 2]: [description and suggested follow-up]
333
+
334
+ ## References
335
+
336
+ [Combined references from all agents]
337
+
338
+ ## Attribution
339
+
340
+ See `sources.md` for detailed contribution breakdown.
341
+ ```
342
+
343
+ ### Sources Template
344
+
345
+ ```markdown
346
+ # Synthesis Sources
347
+
348
+ ## Overview
349
+
350
+ | Agent | Model | Timestamp | Primary Contributions |
351
+ |-------|-------|-----------|----------------------|
352
+ | {agent1} | {model} | {ts} | {contributions} |
353
+ | {agent2} | {model} | {ts} | {contributions} |
354
+ | {agent3} | {model} | {ts} | {contributions} |
355
+
356
+ ## Detailed Contributions
357
+
358
+ ### {Agent 1}
359
+
360
+ **Report**: {ts}-{agent}-report.md
361
+
362
+ **Sections Used**:
363
+ - {Section name}: [how it was used]
364
+
365
+ **Artifacts Used**:
366
+ - {artifact}: [how it was used]
367
+
368
+ ### {Agent 2}
369
+
370
+ [Similar structure]
371
+
372
+ ## Conflict Resolutions
373
+
374
+ | Conflict | Resolution | Source |
375
+ |----------|------------|--------|
376
+ | {topic} | {decision} | {which agent's position} |
377
+
378
+ ## Synthesis Decisions
379
+
380
+ | Decision | Rationale |
381
+ |----------|-----------|
382
+ | Used {agent} as base | Most comprehensive structure |
383
+ | Merged {agent}'s examples | Clearer practical guidance |
384
+ ```
385
+
386
+ ## Success Criteria
387
+
388
+ - Comparison matrix is complete with all artifacts
389
+ - All conflicts have documented resolutions with rationale
390
+ - Unified report covers all key findings from source reports
391
+ - No contradictions in final output
392
+ - Gaps identified for future work
393
+ - All sources properly credited
394
+ - Synthesis quality exceeds individual agent outputs
395
+
396
+ ## Error Handling
397
+
398
+ **Missing Agent Output:**
399
+ - Document which agent output is missing
400
+ - Proceed with available outputs
401
+ - Note reduced coverage in validation
402
+
403
+ **Irreconcilable Conflict:**
404
+ - If no clear resolution, document both positions
405
+ - Mark as "context-dependent" with guidance
406
+ - Let users choose based on their context
407
+
408
+ **Quality Concerns:**
409
+ - If synthesis quality is lower than expected, iterate
410
+ - Consider re-running Phase 4 with different base selection
411
+ - Document any compromises made
412
+
413
+ ## Usage Examples
414
+
415
+ ### Basic Usage
416
+ ```bash
417
+ ace-bundle wfi://handbook/synthesize-research
418
+ ```
419
+
420
+ ### With Custom Output
421
+ ```bash
422
+ ace-bundle wfi://handbook/synthesize-research
423
+ ```
424
+
425
+ ## Related Resources
426
+
427
+ - [Multi-Agent Research Guide](guide://multi-agent-research) - Principles and best practices
428
+ - [Parallel Research Workflow](wfi://handbook/parallel-research) - Previous phase in the process
429
+ - [Research Comparison Template](tmpl://research-comparison) - Template for comparison matrix