bmm-opencode 1.4.2 → 1.4.3
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/.opencode/agents/bmad-bmad-master.md +11 -0
- package/.opencode/agents/bmm-analyst.md +10 -32
- package/.opencode/agents/bmm-architect.md +6 -34
- package/.opencode/agents/bmm-dev.md +6 -32
- package/.opencode/agents/bmm-pm.md +10 -41
- package/.opencode/agents/bmm-qa.md +5 -31
- package/.opencode/agents/bmm-quick-flow-solo-dev.md +7 -32
- package/.opencode/agents/bmm-sm.md +8 -32
- package/.opencode/agents/bmm-tech-writer.md +12 -0
- package/.opencode/agents/bmm-ux-designer.md +5 -37
- package/.opencode/commands/bmad-bmm-check-implementation-readiness.md +7 -0
- package/.opencode/commands/bmad-bmm-code-review.md +7 -0
- package/.opencode/commands/bmad-bmm-correct-course.md +7 -0
- package/.opencode/commands/bmad-bmm-create-architecture.md +7 -0
- package/.opencode/commands/bmad-bmm-create-epics-and-stories.md +7 -0
- package/.opencode/commands/bmad-bmm-create-prd.md +7 -0
- package/.opencode/commands/bmad-bmm-create-product-brief.md +7 -0
- package/.opencode/commands/bmad-bmm-create-story.md +7 -0
- package/.opencode/commands/bmad-bmm-create-ux-design.md +7 -0
- package/.opencode/commands/bmad-bmm-dev-story.md +7 -0
- package/.opencode/commands/bmad-bmm-document-project.md +7 -0
- package/.opencode/commands/bmad-bmm-domain-research.md +7 -0
- package/.opencode/commands/bmad-bmm-edit-prd.md +7 -0
- package/.opencode/commands/bmad-bmm-generate-project-context.md +5 -0
- package/.opencode/commands/bmad-bmm-market-research.md +7 -0
- package/.opencode/commands/bmad-bmm-quick-dev.md +7 -0
- package/.opencode/commands/bmad-bmm-quick-spec.md +7 -0
- package/.opencode/commands/bmad-bmm-retrospective.md +7 -0
- package/.opencode/commands/bmad-bmm-sprint-planning.md +7 -0
- package/.opencode/commands/bmad-bmm-sprint-status.md +5 -0
- package/.opencode/commands/bmad-bmm-technical-research.md +7 -0
- package/.opencode/commands/bmad-bmm-validate-prd.md +7 -0
- package/.opencode/commands/bmad-brainstorming.md +7 -0
- package/.opencode/commands/bmad-editorial-review-prose.md +5 -0
- package/.opencode/commands/bmad-editorial-review-structure.md +5 -0
- package/.opencode/commands/bmad-help.md +5 -0
- package/.opencode/commands/bmad-index-docs.md +5 -0
- package/.opencode/commands/bmad-review-adversarial-general.md +5 -0
- package/.opencode/commands/bmad-shard-doc.md +5 -0
- package/.opencode/skills/bmad-bmad-master/SKILL.md +56 -0
- package/.opencode/skills/bmad-bmm-analyst/SKILL.md +65 -38
- package/.opencode/skills/bmad-bmm-architect/SKILL.md +49 -38
- package/.opencode/skills/bmad-bmm-check-implementation-readiness/SKILL.md +1092 -24
- package/.opencode/skills/bmad-bmm-code-review/SKILL.md +45 -13
- package/.opencode/skills/bmad-bmm-correct-course/SKILL.md +56 -94
- package/.opencode/skills/bmad-bmm-create-architecture/SKILL.md +2391 -27
- package/.opencode/skills/bmad-bmm-create-epics-and-stories/SKILL.md +927 -23
- package/.opencode/skills/bmad-bmm-create-prd/SKILL.md +9 -26
- package/.opencode/skills/bmad-bmm-create-product-brief/SKILL.md +1358 -22
- package/.opencode/skills/bmad-bmm-create-story/SKILL.md +61 -24
- package/.opencode/skills/bmad-bmm-create-ux-design/SKILL.md +3275 -26
- package/.opencode/skills/bmad-bmm-dev/SKILL.md +57 -43
- package/.opencode/skills/bmad-bmm-dev-story/SKILL.md +20 -13
- package/.opencode/skills/bmad-bmm-document-project/SKILL.md +22 -81
- package/.opencode/skills/bmad-bmm-domain-research/SKILL.md +53 -37
- package/.opencode/skills/bmad-bmm-edit-prd/SKILL.md +10 -27
- package/.opencode/skills/bmad-bmm-generate-project-context/SKILL.md +797 -28
- package/.opencode/skills/bmad-bmm-market-research/SKILL.md +53 -37
- package/.opencode/skills/bmad-bmm-pm/SKILL.md +60 -39
- package/.opencode/skills/bmad-bmm-qa/SKILL.md +77 -35
- package/.opencode/skills/bmad-bmm-qa-automate/SKILL.md +47 -129
- package/.opencode/skills/bmad-bmm-quick-dev/SKILL.md +802 -30
- package/.opencode/skills/bmad-bmm-quick-flow-solo-dev/SKILL.md +57 -36
- package/.opencode/skills/bmad-bmm-quick-spec/SKILL.md +684 -27
- package/.opencode/skills/bmad-bmm-retrospective/SKILL.md +55 -200
- package/.opencode/skills/bmad-bmm-sm/SKILL.md +57 -36
- package/.opencode/skills/bmad-bmm-sprint-planning/SKILL.md +51 -52
- package/.opencode/skills/bmad-bmm-sprint-status/SKILL.md +30 -99
- package/.opencode/skills/bmad-bmm-tech-writer/SKILL.md +70 -0
- package/.opencode/skills/bmad-bmm-technical-research/SKILL.md +53 -37
- package/.opencode/skills/bmad-bmm-ux-designer/SKILL.md +48 -37
- package/.opencode/skills/bmad-bmm-validate-prd/SKILL.md +10 -27
- package/.opencode/skills/bmad-brainstorming/SKILL.md +2048 -0
- package/.opencode/skills/bmad-editorial-review-prose/SKILL.md +107 -0
- package/.opencode/skills/bmad-editorial-review-structure/SKILL.md +214 -0
- package/.opencode/skills/bmad-help/SKILL.md +82 -0
- package/.opencode/skills/bmad-index-docs/SKILL.md +70 -0
- package/.opencode/skills/bmad-party-mode/SKILL.md +682 -0
- package/.opencode/skills/bmad-review-adversarial-general/SKILL.md +53 -0
- package/.opencode/skills/bmad-shard-doc/SKILL.md +113 -0
- package/README.md +28 -4
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +350 -47
- package/package.json +4 -3
- package/.opencode/agents/bmm-tech-writer-tech-writer.md +0 -44
- package/.opencode/agents/cis-brainstorming-coach.md +0 -38
- package/.opencode/agents/cis-creative-problem-solver.md +0 -38
- package/.opencode/agents/cis-design-thinking-coach.md +0 -38
- package/.opencode/agents/cis-innovation-strategist.md +0 -38
- package/.opencode/agents/cis-presentation-master.md +0 -54
- package/.opencode/agents/cis-storyteller-storyteller.md +0 -38
- package/.opencode/agents/core-bmad-master.md +0 -39
- package/.opencode/agents/gen-subagent.md +0 -311
- package/.opencode/agents/party-mode.md +0 -812
- package/.opencode/agents/tea-tea.md +0 -48
- package/.opencode/skills/bmad-bmm-dev-team-mode/SKILL.md +0 -300
- package/.opencode/skills/bmad-bmm-tech-writer-tech-writer/SKILL.md +0 -51
- package/.opencode/skills/bmad-cis-brainstorming-coach/SKILL.md +0 -46
- package/.opencode/skills/bmad-cis-creative-problem-solver/SKILL.md +0 -46
- package/.opencode/skills/bmad-cis-design-thinking/SKILL.md +0 -156
- package/.opencode/skills/bmad-cis-design-thinking-coach/SKILL.md +0 -46
- package/.opencode/skills/bmad-cis-innovation-strategist/SKILL.md +0 -46
- package/.opencode/skills/bmad-cis-innovation-strategy/SKILL.md +0 -238
- package/.opencode/skills/bmad-cis-presentation-master/SKILL.md +0 -52
- package/.opencode/skills/bmad-cis-problem-solving/SKILL.md +0 -212
- package/.opencode/skills/bmad-cis-storyteller-storyteller/SKILL.md +0 -48
- package/.opencode/skills/bmad-cis-storytelling/SKILL.md +0 -290
- package/.opencode/skills/bmad-core-bmad-master/SKILL.md +0 -48
- package/.opencode/skills/bmad-core-brainstorming/SKILL.md +0 -74
- package/.opencode/skills/bmad-core-party-mode/SKILL.md +0 -241
- package/.opencode/skills/bmad-core-task-editorial-review-prose/SKILL.md +0 -74
- package/.opencode/skills/bmad-core-task-editorial-review-structure/SKILL.md +0 -151
- package/.opencode/skills/bmad-core-task-help/SKILL.md +0 -100
- package/.opencode/skills/bmad-core-task-index-docs/SKILL.md +0 -46
- package/.opencode/skills/bmad-core-task-review-adversarial-general/SKILL.md +0 -36
- package/.opencode/skills/bmad-core-task-shard-doc/SKILL.md +0 -80
- package/.opencode/skills/bmad-tea-tea/SKILL.md +0 -57
- package/.opencode/skills/bmad-tea-teach-me-testing/SKILL.md +0 -106
- package/.opencode/skills/bmad-tea-testarch-atdd/SKILL.md +0 -62
- package/.opencode/skills/bmad-tea-testarch-automate/SKILL.md +0 -67
- package/.opencode/skills/bmad-tea-testarch-ci/SKILL.md +0 -62
- package/.opencode/skills/bmad-tea-testarch-framework/SKILL.md +0 -62
- package/.opencode/skills/bmad-tea-testarch-nfr/SKILL.md +0 -60
- package/.opencode/skills/bmad-tea-testarch-test-design/SKILL.md +0 -76
- package/.opencode/skills/bmad-tea-testarch-test-review/SKILL.md +0 -60
- package/.opencode/skills/bmad-tea-testarch-trace/SKILL.md +0 -60
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: bmad-editorial-review-prose
|
|
3
|
+
description: "Clinical copy-editor that reviews text for communication issues"
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
<task id="_bmad/core/tasks/editorial-review-prose.xml"
|
|
7
|
+
name="Editorial Review - Prose"
|
|
8
|
+
description="Clinical copy-editor that reviews text for communication issues">
|
|
9
|
+
|
|
10
|
+
<objective>Review text for communication issues that impede comprehension and output suggested fixes in a three-column table</objective>
|
|
11
|
+
|
|
12
|
+
<inputs>
|
|
13
|
+
<input name="content" required="true" desc="Cohesive unit of text to review (markdown, plain text, or text-heavy XML)" />
|
|
14
|
+
<input name="style_guide" required="false"
|
|
15
|
+
desc="Project-specific style guide. When provided, overrides all generic
|
|
16
|
+
principles in this task (except CONTENT IS SACROSANCT). The style guide
|
|
17
|
+
is the final authority on tone, structure, and language choices." />
|
|
18
|
+
<input name="reader_type" required="false" default="humans" desc="'humans' (default) for standard editorial, 'llm' for precision focus" />
|
|
19
|
+
</inputs>
|
|
20
|
+
|
|
21
|
+
<llm critical="true">
|
|
22
|
+
<i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
|
|
23
|
+
<i>DO NOT skip steps or change the sequence</i>
|
|
24
|
+
<i>HALT immediately when halt-conditions are met</i>
|
|
25
|
+
<i>Each action xml tag within step xml tag is a REQUIRED action to complete that step</i>
|
|
26
|
+
|
|
27
|
+
<i>You are a clinical copy-editor: precise, professional, neither warm nor cynical</i>
|
|
28
|
+
<i>Apply Microsoft Writing Style Guide principles as your baseline</i>
|
|
29
|
+
<i>Focus on communication issues that impede comprehension - not style preferences</i>
|
|
30
|
+
<i>NEVER rewrite for preference - only fix genuine issues</i>
|
|
31
|
+
|
|
32
|
+
<i critical="true">CONTENT IS SACROSANCT: Never challenge ideas—only clarify how they're expressed.</i>
|
|
33
|
+
|
|
34
|
+
<principles>
|
|
35
|
+
<i>Minimal intervention: Apply the smallest fix that achieves clarity</i>
|
|
36
|
+
<i>Preserve structure: Fix prose within existing structure, never restructure</i>
|
|
37
|
+
<i>Skip code/markup: Detect and skip code blocks, frontmatter, structural markup</i>
|
|
38
|
+
<i>When uncertain: Flag with a query rather than suggesting a definitive change</i>
|
|
39
|
+
<i>Deduplicate: Same issue in multiple places = one entry with locations listed</i>
|
|
40
|
+
<i>No conflicts: Merge overlapping fixes into single entries</i>
|
|
41
|
+
<i>Respect author voice: Preserve intentional stylistic choices</i>
|
|
42
|
+
</principles>
|
|
43
|
+
<i critical="true">STYLE GUIDE OVERRIDE: If a style_guide input is provided,
|
|
44
|
+
it overrides ALL generic principles in this task (including the Microsoft
|
|
45
|
+
Writing Style Guide baseline and reader_type-specific priorities). The ONLY
|
|
46
|
+
exception is CONTENT IS SACROSANCT—never change what ideas say, only how
|
|
47
|
+
they're expressed. When style guide conflicts with this task, style guide wins.</i>
|
|
48
|
+
</llm>
|
|
49
|
+
|
|
50
|
+
<flow>
|
|
51
|
+
<step n="1" title="Validate Input">
|
|
52
|
+
<action>Check if content is empty or contains fewer than 3 words</action>
|
|
53
|
+
<action if="empty or fewer than 3 words">HALT with error: "Content too short for editorial review (minimum 3 words required)"</action>
|
|
54
|
+
<action>Validate reader_type is "humans" or "llm" (or not provided, defaulting to "humans")</action>
|
|
55
|
+
<action if="reader_type is invalid">HALT with error: "Invalid reader_type. Must be 'humans' or 'llm'"</action>
|
|
56
|
+
<action>Identify content type (markdown, plain text, XML with text)</action>
|
|
57
|
+
<action>Note any code blocks, frontmatter, or structural markup to skip</action>
|
|
58
|
+
</step>
|
|
59
|
+
|
|
60
|
+
<step n="2" title="Analyze Style">
|
|
61
|
+
<action>Analyze the style, tone, and voice of the input text</action>
|
|
62
|
+
<action>Note any intentional stylistic choices to preserve (informal tone, technical jargon, rhetorical patterns)</action>
|
|
63
|
+
<action>Calibrate review approach based on reader_type parameter</action>
|
|
64
|
+
<action if="reader_type='llm'">Prioritize: unambiguous references, consistent terminology, explicit structure, no hedging</action>
|
|
65
|
+
<action if="reader_type='humans'">Prioritize: clarity, flow, readability, natural progression</action>
|
|
66
|
+
</step>
|
|
67
|
+
|
|
68
|
+
<step n="3" title="Editorial Review" critical="true">
|
|
69
|
+
<action if="style_guide provided">Consult style_guide now and note its key requirements—these override default principles for this
|
|
70
|
+
review</action>
|
|
71
|
+
<action>Review all prose sections (skip code blocks, frontmatter, structural markup)</action>
|
|
72
|
+
<action>Identify communication issues that impede comprehension</action>
|
|
73
|
+
<action>For each issue, determine the minimal fix that achieves clarity</action>
|
|
74
|
+
<action>Deduplicate: If same issue appears multiple times, create one entry listing all locations</action>
|
|
75
|
+
<action>Merge overlapping issues into single entries (no conflicting suggestions)</action>
|
|
76
|
+
<action>For uncertain fixes, phrase as query: "Consider: [suggestion]?" rather than definitive change</action>
|
|
77
|
+
<action>Preserve author voice - do not "improve" intentional stylistic choices</action>
|
|
78
|
+
</step>
|
|
79
|
+
|
|
80
|
+
<step n="4" title="Output Results">
|
|
81
|
+
<action if="issues found">Output a three-column markdown table with all suggested fixes</action>
|
|
82
|
+
<action if="no issues found">Output: "No editorial issues identified"</action>
|
|
83
|
+
|
|
84
|
+
<output-format>
|
|
85
|
+
| Original Text | Revised Text | Changes |
|
|
86
|
+
|---------------|--------------|---------|
|
|
87
|
+
| The exact original passage | The suggested revision | Brief explanation of what changed and why |
|
|
88
|
+
</output-format>
|
|
89
|
+
|
|
90
|
+
<example title="Correct output format">
|
|
91
|
+
| Original Text | Revised Text | Changes |
|
|
92
|
+
|---------------|--------------|---------|
|
|
93
|
+
| The system will processes data and it handles errors. | The system processes data and handles errors. | Fixed subject-verb
|
|
94
|
+
agreement ("will processes" to "processes"); removed redundant "it" |
|
|
95
|
+
| Users can chose from options (lines 12, 45, 78) | Users can choose from options | Fixed spelling: "chose" to "choose" (appears in
|
|
96
|
+
3 locations) |
|
|
97
|
+
</example>
|
|
98
|
+
</step>
|
|
99
|
+
</flow>
|
|
100
|
+
|
|
101
|
+
<halt-conditions>
|
|
102
|
+
<condition>HALT with error if content is empty or fewer than 3 words</condition>
|
|
103
|
+
<condition>HALT with error if reader_type is not "humans" or "llm"</condition>
|
|
104
|
+
<condition>If no issues found after thorough review, output "No editorial issues identified" (this is valid completion, not an error)</condition>
|
|
105
|
+
</halt-conditions>
|
|
106
|
+
|
|
107
|
+
</task>
|
|
@@ -0,0 +1,214 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: bmad-editorial-review-structure
|
|
3
|
+
description: "Structural editor that proposes cuts, reorganization, and simplification while preserving comprehension"
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
<?xml version="1.0"?>
|
|
7
|
+
<!-- if possible, run this in a separate subagent or process with read access to the project,
|
|
8
|
+
but no context except the content to review -->
|
|
9
|
+
<task id="_bmad/core/tasks/editorial-review-structure.xml"
|
|
10
|
+
name="Editorial Review - Structure"
|
|
11
|
+
description="Structural editor that proposes cuts, reorganization,
|
|
12
|
+
and simplification while preserving comprehension">
|
|
13
|
+
<objective>Review document structure and propose substantive changes
|
|
14
|
+
to improve clarity and flow-run this BEFORE copy editing</objective>
|
|
15
|
+
<inputs>
|
|
16
|
+
<input name="content" required="true"
|
|
17
|
+
desc="Document to review (markdown, plain text, or structured content)" />
|
|
18
|
+
<input name="style_guide" required="false"
|
|
19
|
+
desc="Project-specific style guide. When provided, overrides all generic
|
|
20
|
+
principles in this task (except CONTENT IS SACROSANCT). The style guide
|
|
21
|
+
is the final authority on tone, structure, and language choices." />
|
|
22
|
+
<input name="purpose" required="false"
|
|
23
|
+
desc="Document's intended purpose (e.g., 'quickstart tutorial',
|
|
24
|
+
'API reference', 'conceptual overview')" />
|
|
25
|
+
<input name="target_audience" required="false"
|
|
26
|
+
desc="Who reads this? (e.g., 'new users', 'experienced developers',
|
|
27
|
+
'decision makers')" />
|
|
28
|
+
<input name="reader_type" required="false" default="humans"
|
|
29
|
+
desc="'humans' (default) preserves comprehension aids;
|
|
30
|
+
'llm' optimizes for precision and density" />
|
|
31
|
+
<input name="length_target" required="false"
|
|
32
|
+
desc="Target reduction (e.g., '30% shorter', 'half the length',
|
|
33
|
+
'no limit')" />
|
|
34
|
+
</inputs>
|
|
35
|
+
<llm critical="true">
|
|
36
|
+
<i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
|
|
37
|
+
<i>DO NOT skip steps or change the sequence</i>
|
|
38
|
+
<i>HALT immediately when halt-conditions are met</i>
|
|
39
|
+
<i>Each action xml tag within step xml tag is a REQUIRED action to complete that step</i>
|
|
40
|
+
<i>You are a structural editor focused on HIGH-VALUE DENSITY</i>
|
|
41
|
+
<i>Brevity IS clarity: Concise writing respects limited attention spans and enables effective scanning</i>
|
|
42
|
+
<i>Every section must justify its existence-cut anything that delays understanding</i>
|
|
43
|
+
<i>True redundancy is failure</i>
|
|
44
|
+
<principles>
|
|
45
|
+
<i>Comprehension through calibration: Optimize for the minimum words needed to maintain understanding</i>
|
|
46
|
+
<i>Front-load value: Critical information comes first; nice-to-know comes last (or goes)</i>
|
|
47
|
+
<i>One source of truth: If information appears identically twice, consolidate</i>
|
|
48
|
+
<i>Scope discipline: Content that belongs in a different document should be cut or linked</i>
|
|
49
|
+
<i>Propose, don't execute: Output recommendations-user decides what to accept</i>
|
|
50
|
+
<i critical="true">CONTENT IS SACROSANCT: Never challenge ideas—only optimize how they're organized.</i>
|
|
51
|
+
</principles>
|
|
52
|
+
<i critical="true">STYLE GUIDE OVERRIDE: If a style_guide input is provided,
|
|
53
|
+
it overrides ALL generic principles in this task (including human-reader-principles,
|
|
54
|
+
llm-reader-principles, reader_type-specific priorities, structure-models selection,
|
|
55
|
+
and the Microsoft Writing Style Guide baseline). The ONLY exception is CONTENT IS
|
|
56
|
+
SACROSANCT—never change what ideas say, only how they're expressed. When style
|
|
57
|
+
guide conflicts with this task, style guide wins.</i>
|
|
58
|
+
<human-reader-principles>
|
|
59
|
+
<i>These elements serve human comprehension and engagement-preserve unless clearly wasteful:</i>
|
|
60
|
+
<i>Visual aids: Diagrams, images, and flowcharts anchor understanding</i>
|
|
61
|
+
<i>Expectation-setting: "What You'll Learn" helps readers confirm they're in the right place</i>
|
|
62
|
+
<i>Reader's Journey: Organize content biologically (linear progression), not logically (database)</i>
|
|
63
|
+
<i>Mental models: Overview before details prevents cognitive overload</i>
|
|
64
|
+
<i>Warmth: Encouraging tone reduces anxiety for new users</i>
|
|
65
|
+
<i>Whitespace: Admonitions and callouts provide visual breathing room</i>
|
|
66
|
+
<i>Summaries: Recaps help retention; they're reinforcement, not redundancy</i>
|
|
67
|
+
<i>Examples: Concrete illustrations make abstract concepts accessible</i>
|
|
68
|
+
<i>Engagement: "Flow" techniques (transitions, variety) are functional, not "fluff"-they maintain attention</i>
|
|
69
|
+
</human-reader-principles>
|
|
70
|
+
<llm-reader-principles>
|
|
71
|
+
<i>When reader_type='llm', optimize for PRECISION and UNAMBIGUITY:</i>
|
|
72
|
+
<i>Dependency-first: Define concepts before usage to minimize hallucination risk</i>
|
|
73
|
+
<i>Cut emotional language, encouragement, and orientation sections</i>
|
|
74
|
+
<i>
|
|
75
|
+
IF concept is well-known from training (e.g., "conventional
|
|
76
|
+
commits", "REST APIs"): Reference the standard-don't re-teach it
|
|
77
|
+
ELSE: Be explicit-don't assume the LLM will infer correctly
|
|
78
|
+
</i>
|
|
79
|
+
<i>Use consistent terminology-same word for same concept throughout</i>
|
|
80
|
+
<i>Eliminate hedging ("might", "could", "generally")-use direct statements</i>
|
|
81
|
+
<i>Prefer structured formats (tables, lists, YAML) over prose</i>
|
|
82
|
+
<i>Reference known standards ("conventional commits", "Google style guide") to leverage training</i>
|
|
83
|
+
<i>STILL PROVIDE EXAMPLES even for known standards-grounds the LLM in your specific expectation</i>
|
|
84
|
+
<i>Unambiguous references-no unclear antecedents ("it", "this", "the above")</i>
|
|
85
|
+
<i>Note: LLM documents may be LONGER than human docs in some areas
|
|
86
|
+
(more explicit) while shorter in others (no warmth)</i>
|
|
87
|
+
</llm-reader-principles>
|
|
88
|
+
<structure-models>
|
|
89
|
+
<model name="Tutorial/Guide (Linear)" applicability="Tutorials, detailed guides, how-to articles, walkthroughs">
|
|
90
|
+
<i>Prerequisites: Setup/Context MUST precede action</i>
|
|
91
|
+
<i>Sequence: Steps must follow strict chronological or logical dependency order</i>
|
|
92
|
+
<i>Goal-oriented: clear 'Definition of Done' at the end</i>
|
|
93
|
+
</model>
|
|
94
|
+
<model name="Reference/Database" applicability="API docs, glossaries, configuration references, cheat sheets">
|
|
95
|
+
<i>Random Access: No narrative flow required; user jumps to specific item</i>
|
|
96
|
+
<i>MECE: Topics are Mutually Exclusive and Collectively Exhaustive</i>
|
|
97
|
+
<i>Consistent Schema: Every item follows identical structure (e.g., Signature to Params to Returns)</i>
|
|
98
|
+
</model>
|
|
99
|
+
<model name="Explanation (Conceptual)"
|
|
100
|
+
applicability="Deep dives, architecture overviews, conceptual guides,
|
|
101
|
+
whitepapers, project context">
|
|
102
|
+
<i>Abstract to Concrete: Definition to Context to Implementation/Example</i>
|
|
103
|
+
<i>Scaffolding: Complex ideas built on established foundations</i>
|
|
104
|
+
</model>
|
|
105
|
+
<model name="Prompt/Task Definition (Functional)"
|
|
106
|
+
applicability="BMAD tasks, prompts, system instructions, XML definitions">
|
|
107
|
+
<i>Meta-first: Inputs, usage constraints, and context defined before instructions</i>
|
|
108
|
+
<i>Separation of Concerns: Instructions (logic) separate from Data (content)</i>
|
|
109
|
+
<i>Step-by-step: Execution flow must be explicit and ordered</i>
|
|
110
|
+
</model>
|
|
111
|
+
<model name="Strategic/Context (Pyramid)" applicability="PRDs, research reports, proposals, decision records">
|
|
112
|
+
<i>Top-down: Conclusion/Status/Recommendation starts the document</i>
|
|
113
|
+
<i>Grouping: Supporting context grouped logically below the headline</i>
|
|
114
|
+
<i>Ordering: Most critical information first</i>
|
|
115
|
+
<i>MECE: Arguments/Groups are Mutually Exclusive and Collectively Exhaustive</i>
|
|
116
|
+
<i>Evidence: Data supports arguments, never leads</i>
|
|
117
|
+
</model>
|
|
118
|
+
</structure-models>
|
|
119
|
+
</llm>
|
|
120
|
+
<flow>
|
|
121
|
+
<step n="1" title="Validate Input">
|
|
122
|
+
<action>Check if content is empty or contains fewer than 3 words</action>
|
|
123
|
+
<action if="empty or fewer than 3 words">HALT with error: "Content
|
|
124
|
+
too short for substantive review (minimum 3 words required)"</action>
|
|
125
|
+
<action>Validate reader_type is "humans" or "llm" (or not provided, defaulting to "humans")</action>
|
|
126
|
+
<action if="reader_type is invalid">HALT with error: "Invalid reader_type. Must be 'humans' or 'llm'"</action>
|
|
127
|
+
<action>Identify document type and structure (headings, sections, lists, etc.)</action>
|
|
128
|
+
<action>Note the current word count and section count</action>
|
|
129
|
+
</step>
|
|
130
|
+
<step n="2" title="Understand Purpose">
|
|
131
|
+
<action>If purpose was provided, use it; otherwise infer from content</action>
|
|
132
|
+
<action>If target_audience was provided, use it; otherwise infer from content</action>
|
|
133
|
+
<action>Identify the core question the document answers</action>
|
|
134
|
+
<action>State in one sentence: "This document exists to help [audience] accomplish [goal]"</action>
|
|
135
|
+
<action>Select the most appropriate structural model from structure-models based on purpose/audience</action>
|
|
136
|
+
<action>Note reader_type and which principles apply (human-reader-principles or llm-reader-principles)</action>
|
|
137
|
+
</step>
|
|
138
|
+
<step n="3" title="Structural Analysis" critical="true">
|
|
139
|
+
<action if="style_guide provided">Consult style_guide now and note its key requirements—these override default principles for this
|
|
140
|
+
analysis</action>
|
|
141
|
+
<action>Map the document structure: list each major section with its word count</action>
|
|
142
|
+
<action>Evaluate structure against the selected model's primary rules
|
|
143
|
+
(e.g., 'Does recommendation come first?' for Pyramid)</action>
|
|
144
|
+
<action>For each section, answer: Does this directly serve the stated purpose?</action>
|
|
145
|
+
<action if="reader_type='humans'">For each comprehension aid (visual,
|
|
146
|
+
summary, example, callout), answer: Does this help readers
|
|
147
|
+
understand or stay engaged?</action>
|
|
148
|
+
<action>Identify sections that could be: cut entirely, merged with
|
|
149
|
+
another, moved to a different location, or split</action>
|
|
150
|
+
<action>Identify true redundancies: identical information repeated
|
|
151
|
+
without purpose (not summaries or reinforcement)</action>
|
|
152
|
+
<action>Identify scope violations: content that belongs in a different document</action>
|
|
153
|
+
<action>Identify burying: critical information hidden deep in the document</action>
|
|
154
|
+
</step>
|
|
155
|
+
<step n="4" title="Flow Analysis">
|
|
156
|
+
<action>Assess the reader's journey: Does the sequence match how readers will use this?</action>
|
|
157
|
+
<action>Identify premature detail: explanation given before the reader needs it</action>
|
|
158
|
+
<action>Identify missing scaffolding: complex ideas without adequate setup</action>
|
|
159
|
+
<action>Identify anti-patterns: FAQs that should be inline, appendices
|
|
160
|
+
that should be cut, overviews that repeat the body verbatim</action>
|
|
161
|
+
<action if="reader_type='humans'">Assess pacing: Is there enough
|
|
162
|
+
whitespace and visual variety to maintain attention?</action>
|
|
163
|
+
</step>
|
|
164
|
+
<step n="5" title="Generate Recommendations">
|
|
165
|
+
<action>Compile all findings into prioritized recommendations</action>
|
|
166
|
+
<action>Categorize each recommendation: CUT (remove entirely),
|
|
167
|
+
MERGE (combine sections), MOVE (reorder), CONDENSE (shorten
|
|
168
|
+
significantly), QUESTION (needs author decision), PRESERVE
|
|
169
|
+
(explicitly keep-for elements that might seem cuttable but
|
|
170
|
+
serve comprehension)</action>
|
|
171
|
+
<action>For each recommendation, state the rationale in one sentence</action>
|
|
172
|
+
<action>Estimate impact: how many words would this save (or cost, for PRESERVE)?</action>
|
|
173
|
+
<action>If length_target was provided, assess whether recommendations meet it</action>
|
|
174
|
+
<action if="reader_type='humans' and recommendations would cut
|
|
175
|
+
comprehension aids">Flag with warning: "This cut may impact
|
|
176
|
+
reader comprehension/engagement"</action>
|
|
177
|
+
</step>
|
|
178
|
+
<step n="6" title="Output Results">
|
|
179
|
+
<action>Output document summary (purpose, audience, reader_type, current length)</action>
|
|
180
|
+
<action>Output the recommendation list in priority order</action>
|
|
181
|
+
<action>Output estimated total reduction if all recommendations accepted</action>
|
|
182
|
+
<action if="no recommendations">Output: "No substantive changes recommended-document structure is sound"</action>
|
|
183
|
+
<output-format>
|
|
184
|
+
## Document Summary
|
|
185
|
+
- **Purpose:** [inferred or provided purpose]
|
|
186
|
+
- **Audience:** [inferred or provided audience]
|
|
187
|
+
- **Reader type:** [selected reader type]
|
|
188
|
+
- **Structure model:** [selected structure model]
|
|
189
|
+
- **Current length:** [X] words across [Y] sections
|
|
190
|
+
|
|
191
|
+
## Recommendations
|
|
192
|
+
|
|
193
|
+
### 1. [CUT/MERGE/MOVE/CONDENSE/QUESTION/PRESERVE] - [Section or element name]
|
|
194
|
+
**Rationale:** [One sentence explanation]
|
|
195
|
+
**Impact:** ~[X] words
|
|
196
|
+
**Comprehension note:** [If applicable, note impact on reader understanding]
|
|
197
|
+
|
|
198
|
+
### 2. ...
|
|
199
|
+
|
|
200
|
+
## Summary
|
|
201
|
+
- **Total recommendations:** [N]
|
|
202
|
+
- **Estimated reduction:** [X] words ([Y]% of original)
|
|
203
|
+
- **Meets length target:** [Yes/No/No target specified]
|
|
204
|
+
- **Comprehension trade-offs:** [Note any cuts that sacrifice reader engagement for brevity]
|
|
205
|
+
</output-format>
|
|
206
|
+
</step>
|
|
207
|
+
</flow>
|
|
208
|
+
<halt-conditions>
|
|
209
|
+
<condition>HALT with error if content is empty or fewer than 3 words</condition>
|
|
210
|
+
<condition>HALT with error if reader_type is not "humans" or "llm"</condition>
|
|
211
|
+
<condition>If no structural issues found, output "No substantive changes
|
|
212
|
+
recommended" (this is valid completion, not an error)</condition>
|
|
213
|
+
</halt-conditions>
|
|
214
|
+
</task>
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: bmad-help
|
|
3
|
+
description: "Get unstuck by showing what workflow steps come next or answering questions about what to do"
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Task: BMAD Help
|
|
7
|
+
|
|
8
|
+
## ROUTING RULES
|
|
9
|
+
|
|
10
|
+
- **Empty `phase` = anytime** — Universal tools work regardless of workflow state
|
|
11
|
+
- **Numbered phases indicate sequence** — Phases like `1-discover` → `2-define` → `3-build` → `4-ship` flow in order (naming varies by module)
|
|
12
|
+
- **Stay in module** — Guide through the active module's workflow based on phase+sequence ordering
|
|
13
|
+
- **Descriptions contain routing** — Read for alternate paths (e.g., "back to previous if fixes needed")
|
|
14
|
+
- **`required=true` blocks progress** — Required workflows must complete before proceeding to later phases
|
|
15
|
+
- **Artifacts reveal completion** — Search resolved output paths for `outputs` patterns, fuzzy-match found files to workflow rows
|
|
16
|
+
|
|
17
|
+
## DISPLAY RULES
|
|
18
|
+
|
|
19
|
+
### Command-Based Workflows
|
|
20
|
+
When `command` field has a value:
|
|
21
|
+
- Show the command prefixed with `/` (e.g., `/bmad-bmm-create-prd`)
|
|
22
|
+
|
|
23
|
+
### Agent-Based Workflows
|
|
24
|
+
When `command` field is empty:
|
|
25
|
+
- User loads agent first via `/agent-command`
|
|
26
|
+
- Then invokes by referencing the `code` field or describing the `name` field
|
|
27
|
+
- Do NOT show a slash command — show the code value and agent load instruction instead
|
|
28
|
+
|
|
29
|
+
Example presentation for empty command:
|
|
30
|
+
```
|
|
31
|
+
Explain Concept (EC)
|
|
32
|
+
Load: /tech-writer, then ask to "EC about [topic]"
|
|
33
|
+
Agent: Tech Writer
|
|
34
|
+
Description: Create clear technical explanations with examples...
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## MODULE DETECTION
|
|
38
|
+
|
|
39
|
+
- **Empty `module` column** → universal tools (work across all modules)
|
|
40
|
+
- **Named `module`** → module-specific workflows
|
|
41
|
+
|
|
42
|
+
Detect the active module from conversation context, recent workflows, or user query keywords. If ambiguous, ask the user.
|
|
43
|
+
|
|
44
|
+
## INPUT ANALYSIS
|
|
45
|
+
|
|
46
|
+
Determine what was just completed:
|
|
47
|
+
- Explicit completion stated by user
|
|
48
|
+
- Workflow completed in current conversation
|
|
49
|
+
- Artifacts found matching `outputs` patterns
|
|
50
|
+
- If `index.md` exists, read it for additional context
|
|
51
|
+
- If still unclear, ask: "What workflow did you most recently complete?"
|
|
52
|
+
|
|
53
|
+
## EXECUTION
|
|
54
|
+
|
|
55
|
+
1. **Load catalog** — Load `{project-root}/_bmad/_config/bmad-help.csv`
|
|
56
|
+
|
|
57
|
+
2. **Resolve output locations** — Scan each folder under `_bmad/` (except `_config`) for `config.yaml`. For each workflow row, resolve its `output-location` variables against that module's config so artifact paths can be searched.
|
|
58
|
+
|
|
59
|
+
3. **Detect active module** — Use MODULE DETECTION above
|
|
60
|
+
|
|
61
|
+
4. **Analyze input** — Task may provide a workflow name/code, conversational phrase, or nothing. Infer what was just completed using INPUT ANALYSIS above.
|
|
62
|
+
|
|
63
|
+
5. **Present recommendations** — Show next steps based on:
|
|
64
|
+
- Completed workflows detected
|
|
65
|
+
- Phase/sequence ordering (ROUTING RULES)
|
|
66
|
+
- Artifact presence
|
|
67
|
+
|
|
68
|
+
**Optional items first** — List optional workflows until a required step is reached
|
|
69
|
+
**Required items next** — List the next required workflow
|
|
70
|
+
|
|
71
|
+
For each item, apply DISPLAY RULES above and include:
|
|
72
|
+
- Workflow **name**
|
|
73
|
+
- **Command** OR **Code + Agent load instruction** (per DISPLAY RULES)
|
|
74
|
+
- **Agent** title and display name from the CSV (e.g., "🎨 Alex (Designer)")
|
|
75
|
+
- Brief **description**
|
|
76
|
+
|
|
77
|
+
6. **Additional guidance to convey**:
|
|
78
|
+
- Run each workflow in a **fresh context window**
|
|
79
|
+
- For **validation workflows**: recommend using a different high-quality LLM if available
|
|
80
|
+
- For conversational requests: match the user's tone while presenting clearly
|
|
81
|
+
|
|
82
|
+
7. Return to the calling process after presenting recommendations.
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: bmad-index-docs
|
|
3
|
+
description: "Generates or updates an index.md of all documents in the specified directory"
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
<task id="_bmad/core/tasks/index-docs" name="Index Docs"
|
|
7
|
+
description="Generates or updates an index.md of all documents in the specified directory">
|
|
8
|
+
<llm critical="true">
|
|
9
|
+
<i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
|
|
10
|
+
<i>DO NOT skip steps or change the sequence</i>
|
|
11
|
+
<i>HALT immediately when halt-conditions are met</i>
|
|
12
|
+
<i>Each action xml tag within step xml tag is a REQUIRED action to complete that step</i>
|
|
13
|
+
<i>Sections outside flow (validation, output, critical-context) provide essential context - review and apply throughout execution</i>
|
|
14
|
+
</llm>
|
|
15
|
+
|
|
16
|
+
<flow>
|
|
17
|
+
<step n="1" title="Scan Directory">
|
|
18
|
+
<i>List all files and subdirectories in the target location</i>
|
|
19
|
+
</step>
|
|
20
|
+
|
|
21
|
+
<step n="2" title="Group Content">
|
|
22
|
+
<i>Organize files by type, purpose, or subdirectory</i>
|
|
23
|
+
</step>
|
|
24
|
+
|
|
25
|
+
<step n="3" title="Generate Descriptions">
|
|
26
|
+
<i>Read each file to understand its actual purpose and create brief (3-10 word) descriptions based on the content, not just the
|
|
27
|
+
filename</i>
|
|
28
|
+
</step>
|
|
29
|
+
|
|
30
|
+
<step n="4" title="Create/Update Index">
|
|
31
|
+
<i>Write or update index.md with organized file listings</i>
|
|
32
|
+
</step>
|
|
33
|
+
</flow>
|
|
34
|
+
|
|
35
|
+
<output-format>
|
|
36
|
+
<example>
|
|
37
|
+
# Directory Index
|
|
38
|
+
|
|
39
|
+
## Files
|
|
40
|
+
|
|
41
|
+
- **[filename.ext](./filename.ext)** - Brief description
|
|
42
|
+
- **[another-file.ext](./another-file.ext)** - Brief description
|
|
43
|
+
|
|
44
|
+
## Subdirectories
|
|
45
|
+
|
|
46
|
+
### subfolder/
|
|
47
|
+
|
|
48
|
+
- **[file1.ext](./subfolder/file1.ext)** - Brief description
|
|
49
|
+
- **[file2.ext](./subfolder/file2.ext)** - Brief description
|
|
50
|
+
|
|
51
|
+
### another-folder/
|
|
52
|
+
|
|
53
|
+
- **[file3.ext](./another-folder/file3.ext)** - Brief description
|
|
54
|
+
</example>
|
|
55
|
+
</output-format>
|
|
56
|
+
|
|
57
|
+
<halt-conditions critical="true">
|
|
58
|
+
<i>HALT if target directory does not exist or is inaccessible</i>
|
|
59
|
+
<i>HALT if user does not have write permissions to create index.md</i>
|
|
60
|
+
</halt-conditions>
|
|
61
|
+
|
|
62
|
+
<validation>
|
|
63
|
+
<i>Use relative paths starting with ./</i>
|
|
64
|
+
<i>Group similar files together</i>
|
|
65
|
+
<i>Read file contents to generate accurate descriptions - don't guess from filenames</i>
|
|
66
|
+
<i>Keep descriptions concise but informative (3-10 words)</i>
|
|
67
|
+
<i>Sort alphabetically within groups</i>
|
|
68
|
+
<i>Skip hidden files (starting with .) unless specified</i>
|
|
69
|
+
</validation>
|
|
70
|
+
</task>
|