bmad-method 6.3.1-next.14 → 6.3.1-next.16
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/package.json +1 -1
- package/src/bmm-skills/1-analysis/bmad-document-project/SKILL.md +57 -1
- package/src/bmm-skills/1-analysis/bmad-document-project/customize.toml +41 -0
- package/src/bmm-skills/1-analysis/bmad-prfaq/SKILL.md +48 -9
- package/src/bmm-skills/1-analysis/bmad-prfaq/customize.toml +19 -0
- package/src/bmm-skills/1-analysis/research/bmad-domain-research/SKILL.md +91 -1
- package/src/bmm-skills/1-analysis/research/bmad-domain-research/customize.toml +19 -0
- package/src/bmm-skills/1-analysis/research/bmad-market-research/SKILL.md +91 -1
- package/src/bmm-skills/1-analysis/research/bmad-market-research/customize.toml +15 -0
- package/src/bmm-skills/1-analysis/research/bmad-technical-research/SKILL.md +91 -1
- package/src/bmm-skills/1-analysis/research/bmad-technical-research/customize.toml +15 -0
- package/src/bmm-skills/2-plan-workflows/bmad-create-prd/SKILL.md +99 -1
- package/src/bmm-skills/2-plan-workflows/bmad-create-prd/customize.toml +14 -0
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/SKILL.md +70 -1
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/customize.toml +14 -0
- package/src/bmm-skills/2-plan-workflows/bmad-edit-prd/SKILL.md +97 -1
- package/src/bmm-skills/2-plan-workflows/bmad-edit-prd/customize.toml +14 -0
- package/src/bmm-skills/2-plan-workflows/bmad-validate-prd/SKILL.md +99 -1
- package/src/bmm-skills/2-plan-workflows/bmad-validate-prd/customize.toml +14 -0
- package/src/bmm-skills/3-solutioning/bmad-check-implementation-readiness/SKILL.md +86 -1
- package/src/bmm-skills/3-solutioning/bmad-check-implementation-readiness/customize.toml +14 -0
- package/src/bmm-skills/3-solutioning/bmad-create-architecture/SKILL.md +69 -1
- package/src/bmm-skills/3-solutioning/bmad-create-architecture/customize.toml +14 -0
- package/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/SKILL.md +88 -1
- package/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/customize.toml +14 -0
- package/src/bmm-skills/3-solutioning/bmad-generate-project-context/SKILL.md +76 -1
- package/src/bmm-skills/3-solutioning/bmad-generate-project-context/customize.toml +14 -0
- package/src/bmm-skills/4-implementation/bmad-correct-course/SKILL.md +295 -1
- package/src/bmm-skills/4-implementation/bmad-correct-course/customize.toml +14 -0
- package/src/bmm-skills/4-implementation/bmad-create-story/SKILL.md +411 -1
- package/src/bmm-skills/4-implementation/bmad-create-story/customize.toml +14 -0
- package/src/bmm-skills/4-implementation/bmad-qa-generate-e2e-tests/SKILL.md +165 -1
- package/src/bmm-skills/4-implementation/bmad-qa-generate-e2e-tests/customize.toml +14 -0
- package/src/bmm-skills/4-implementation/bmad-retrospective/SKILL.md +1507 -1
- package/src/bmm-skills/4-implementation/bmad-retrospective/customize.toml +14 -0
- package/src/bmm-skills/module.yaml +6 -0
- package/src/bmm-skills/1-analysis/bmad-document-project/workflow.md +0 -25
- package/src/bmm-skills/1-analysis/research/bmad-domain-research/workflow.md +0 -51
- package/src/bmm-skills/1-analysis/research/bmad-market-research/workflow.md +0 -51
- package/src/bmm-skills/1-analysis/research/bmad-technical-research/workflow.md +0 -52
- package/src/bmm-skills/2-plan-workflows/bmad-create-prd/workflow.md +0 -61
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/workflow.md +0 -35
- package/src/bmm-skills/2-plan-workflows/bmad-edit-prd/workflow.md +0 -62
- package/src/bmm-skills/2-plan-workflows/bmad-validate-prd/workflow.md +0 -61
- package/src/bmm-skills/3-solutioning/bmad-check-implementation-readiness/workflow.md +0 -47
- package/src/bmm-skills/3-solutioning/bmad-create-architecture/workflow.md +0 -32
- package/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/workflow.md +0 -51
- package/src/bmm-skills/3-solutioning/bmad-generate-project-context/workflow.md +0 -39
- package/src/bmm-skills/4-implementation/bmad-correct-course/workflow.md +0 -267
- package/src/bmm-skills/4-implementation/bmad-create-story/workflow.md +0 -380
- package/src/bmm-skills/4-implementation/bmad-qa-generate-e2e-tests/workflow.md +0 -136
- package/src/bmm-skills/4-implementation/bmad-retrospective/workflow.md +0 -1479
package/package.json
CHANGED
|
@@ -3,4 +3,60 @@ name: bmad-document-project
|
|
|
3
3
|
description: 'Document brownfield projects for AI context. Use when the user says "document this project" or "generate project docs"'
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
# Document Project Workflow
|
|
7
|
+
|
|
8
|
+
**Goal:** Document brownfield projects for AI context.
|
|
9
|
+
|
|
10
|
+
**Your Role:** Project documentation specialist.
|
|
11
|
+
|
|
12
|
+
## Conventions
|
|
13
|
+
|
|
14
|
+
- Bare paths (e.g. `instructions.md`) resolve from the skill root.
|
|
15
|
+
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
|
16
|
+
- `{project-root}`-prefixed paths resolve from the project working directory.
|
|
17
|
+
- `{skill-name}` resolves to the skill directory's basename.
|
|
18
|
+
|
|
19
|
+
## On Activation
|
|
20
|
+
|
|
21
|
+
### Step 1: Resolve the Workflow Block
|
|
22
|
+
|
|
23
|
+
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
|
24
|
+
|
|
25
|
+
**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver:
|
|
26
|
+
|
|
27
|
+
1. `{skill-root}/customize.toml` — defaults
|
|
28
|
+
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
|
29
|
+
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
|
30
|
+
|
|
31
|
+
Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append.
|
|
32
|
+
|
|
33
|
+
### Step 2: Execute Prepend Steps
|
|
34
|
+
|
|
35
|
+
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
|
36
|
+
|
|
37
|
+
### Step 3: Load Persistent Facts
|
|
38
|
+
|
|
39
|
+
Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim.
|
|
40
|
+
|
|
41
|
+
### Step 4: Load Config
|
|
42
|
+
|
|
43
|
+
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
|
44
|
+
- Use `{user_name}` for greeting
|
|
45
|
+
- Use `{communication_language}` for all communications
|
|
46
|
+
- Use `{document_output_language}` for output documents
|
|
47
|
+
- Use `{planning_artifacts}` for output location and artifact scanning
|
|
48
|
+
- Use `{project_knowledge}` for additional context scanning
|
|
49
|
+
|
|
50
|
+
### Step 5: Greet the User
|
|
51
|
+
|
|
52
|
+
Greet `{user_name}` (if you have not already), speaking in `{communication_language}`.
|
|
53
|
+
|
|
54
|
+
### Step 6: Execute Append Steps
|
|
55
|
+
|
|
56
|
+
Execute each entry in `{workflow.activation_steps_append}` in order.
|
|
57
|
+
|
|
58
|
+
Activation is complete. Begin the workflow below.
|
|
59
|
+
|
|
60
|
+
## Execution
|
|
61
|
+
|
|
62
|
+
Read fully and follow: `./instructions.md`
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# DO NOT EDIT -- overwritten on every update.
|
|
2
|
+
#
|
|
3
|
+
# Workflow customization surface for bmad-document-project. Mirrors the
|
|
4
|
+
# agent customization shape under the [workflow] namespace.
|
|
5
|
+
|
|
6
|
+
[workflow]
|
|
7
|
+
|
|
8
|
+
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
|
9
|
+
# scalars: override wins • arrays (persistent_facts, activation_steps_*): append
|
|
10
|
+
# arrays-of-tables with `code`/`id`: replace matching items, append new ones.
|
|
11
|
+
|
|
12
|
+
# Steps to run before the standard activation (config load, greet).
|
|
13
|
+
# Overrides append. Use for pre-flight loads, compliance checks, etc.
|
|
14
|
+
|
|
15
|
+
activation_steps_prepend = []
|
|
16
|
+
|
|
17
|
+
# Steps to run after greet but before the workflow begins.
|
|
18
|
+
# Overrides append. Use for context-heavy setup that should happen
|
|
19
|
+
# once the user has been acknowledged.
|
|
20
|
+
|
|
21
|
+
activation_steps_append = []
|
|
22
|
+
|
|
23
|
+
# Persistent facts the workflow keeps in mind for the whole run
|
|
24
|
+
# (standards, compliance constraints, stylistic guardrails).
|
|
25
|
+
# Distinct from the runtime memory sidecar — these are static context
|
|
26
|
+
# loaded on activation. Overrides append.
|
|
27
|
+
#
|
|
28
|
+
# Each entry is either:
|
|
29
|
+
# - a literal sentence, e.g. "All briefs must include a regulatory-risk section."
|
|
30
|
+
# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md"
|
|
31
|
+
# (glob patterns are supported; the file's contents are loaded and treated as facts).
|
|
32
|
+
|
|
33
|
+
persistent_facts = [
|
|
34
|
+
"file:{project-root}/**/project-context.md",
|
|
35
|
+
]
|
|
36
|
+
|
|
37
|
+
# Scalar: executed when the workflow reaches its terminal stage, after
|
|
38
|
+
# the main output has been delivered. Override wins. Leave empty for
|
|
39
|
+
# no custom post-completion behavior.
|
|
40
|
+
|
|
41
|
+
on_complete = ""
|
|
@@ -19,20 +19,59 @@ The PRFAQ forces customer-first clarity: write the press release announcing the
|
|
|
19
19
|
|
|
20
20
|
**Research-grounded.** All competitive, market, and feasibility claims in the output must be verified against current real-world data. Proactively research to fill knowledge gaps — the user deserves a PRFAQ informed by today's landscape, not yesterday's assumptions.
|
|
21
21
|
|
|
22
|
+
## Conventions
|
|
23
|
+
|
|
24
|
+
- Bare paths (e.g. `references/press-release.md`) resolve from the skill root.
|
|
25
|
+
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
|
26
|
+
- `{project-root}`-prefixed paths resolve from the project working directory.
|
|
27
|
+
- `{skill-name}` resolves to the skill directory's basename.
|
|
28
|
+
|
|
22
29
|
## On Activation
|
|
23
30
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
31
|
+
### Step 1: Resolve the Workflow Block
|
|
32
|
+
|
|
33
|
+
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
|
34
|
+
|
|
35
|
+
**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver:
|
|
36
|
+
|
|
37
|
+
1. `{skill-root}/customize.toml` — defaults
|
|
38
|
+
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
|
39
|
+
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
|
40
|
+
|
|
41
|
+
Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append.
|
|
42
|
+
|
|
43
|
+
### Step 2: Execute Prepend Steps
|
|
44
|
+
|
|
45
|
+
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
|
46
|
+
|
|
47
|
+
### Step 3: Load Persistent Facts
|
|
48
|
+
|
|
49
|
+
Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim.
|
|
50
|
+
|
|
51
|
+
### Step 4: Load Config
|
|
52
|
+
|
|
53
|
+
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
|
54
|
+
- Use `{user_name}` for greeting
|
|
55
|
+
- Use `{communication_language}` for all communications
|
|
56
|
+
- Use `{document_output_language}` for output documents
|
|
57
|
+
- Use `{planning_artifacts}` for output location and artifact scanning
|
|
58
|
+
- Use `{project_knowledge}` for additional context scanning
|
|
59
|
+
|
|
60
|
+
### Step 5: Greet the User
|
|
61
|
+
|
|
62
|
+
Greet `{user_name}`, speaking in `{communication_language}`. Be warm but efficient — dream builder energy.
|
|
63
|
+
|
|
64
|
+
### Step 6: Execute Append Steps
|
|
65
|
+
|
|
66
|
+
Execute each entry in `{workflow.activation_steps_append}` in order.
|
|
67
|
+
|
|
68
|
+
Activation is complete. Continue below.
|
|
30
69
|
|
|
31
|
-
|
|
70
|
+
## Pre-workflow Setup
|
|
32
71
|
|
|
33
|
-
|
|
72
|
+
1. **Resume detection:** Check if `{planning_artifacts}/prfaq-{project_name}.md` already exists. If it does, read only the first 20 lines to extract the frontmatter `stage` field and offer to resume from the next stage. Do not read the full document. If the user confirms, route directly to that stage's reference file.
|
|
34
73
|
|
|
35
|
-
|
|
74
|
+
2. **Mode detection:**
|
|
36
75
|
- `--headless` / `-H`: Produce complete first-draft PRFAQ from provided inputs without interaction. Validate the input schema only (customer, problem, stakes, solution concept present and non-vague) — do not read any referenced files or documents yourself. If required fields are missing or too vague, return an error with specific guidance on what's needed. Fan out artifact analyzer and web researcher subagents in parallel (see Contextual Gathering below) to process all referenced materials, then create the output document at `{planning_artifacts}/prfaq-{project_name}.md` using `./assets/prfaq-template.md` and route to `./references/press-release.md`.
|
|
37
76
|
- Default: Full interactive coaching — the gauntlet.
|
|
38
77
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# DO NOT EDIT -- overwritten on every update.
|
|
2
|
+
#
|
|
3
|
+
# Workflow customization surface for bmad-prfaq. Mirrors the
|
|
4
|
+
# agent customization shape under the [workflow] namespace.
|
|
5
|
+
|
|
6
|
+
[workflow]
|
|
7
|
+
|
|
8
|
+
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
|
9
|
+
# scalars: override wins • arrays (persistent_facts, activation_steps_*): append
|
|
10
|
+
# arrays-of-tables with `code`/`id`: replace matching items, append new ones.
|
|
11
|
+
|
|
12
|
+
activation_steps_prepend = []
|
|
13
|
+
activation_steps_append = []
|
|
14
|
+
|
|
15
|
+
persistent_facts = [
|
|
16
|
+
"file:{project-root}/**/project-context.md",
|
|
17
|
+
]
|
|
18
|
+
|
|
19
|
+
on_complete = ""
|
|
@@ -3,4 +3,94 @@ name: bmad-domain-research
|
|
|
3
3
|
description: 'Conduct domain and industry research. Use when the user says wants to do domain research for a topic or industry'
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
# Domain Research Workflow
|
|
7
|
+
|
|
8
|
+
**Goal:** Conduct comprehensive domain/industry research using current web data and verified sources to produce complete research documents with compelling narratives and proper citations.
|
|
9
|
+
|
|
10
|
+
**Your Role:** You are a domain research facilitator working with an expert partner. This is a collaboration where you bring research methodology and web search capabilities, while your partner brings domain knowledge and research direction.
|
|
11
|
+
|
|
12
|
+
## Conventions
|
|
13
|
+
|
|
14
|
+
- Bare paths (e.g. `domain-steps/step-01-init.md`) resolve from the skill root.
|
|
15
|
+
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
|
16
|
+
- `{project-root}`-prefixed paths resolve from the project working directory.
|
|
17
|
+
- `{skill-name}` resolves to the skill directory's basename.
|
|
18
|
+
|
|
19
|
+
## PREREQUISITE
|
|
20
|
+
|
|
21
|
+
**⛔ Web search required.** If unavailable, abort and tell the user.
|
|
22
|
+
|
|
23
|
+
## On Activation
|
|
24
|
+
|
|
25
|
+
### Step 1: Resolve the Workflow Block
|
|
26
|
+
|
|
27
|
+
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
|
28
|
+
|
|
29
|
+
**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver:
|
|
30
|
+
|
|
31
|
+
1. `{skill-root}/customize.toml` — defaults
|
|
32
|
+
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
|
33
|
+
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
|
34
|
+
|
|
35
|
+
Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append.
|
|
36
|
+
|
|
37
|
+
### Step 2: Execute Prepend Steps
|
|
38
|
+
|
|
39
|
+
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
|
40
|
+
|
|
41
|
+
### Step 3: Load Persistent Facts
|
|
42
|
+
|
|
43
|
+
Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim.
|
|
44
|
+
|
|
45
|
+
### Step 4: Load Config
|
|
46
|
+
|
|
47
|
+
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
|
48
|
+
- Use `{user_name}` for greeting
|
|
49
|
+
- Use `{communication_language}` for all communications
|
|
50
|
+
- Use `{document_output_language}` for output documents
|
|
51
|
+
- Use `{planning_artifacts}` for output location and artifact scanning
|
|
52
|
+
- Use `{project_knowledge}` for additional context scanning
|
|
53
|
+
|
|
54
|
+
### Step 5: Greet the User
|
|
55
|
+
|
|
56
|
+
Greet `{user_name}`, speaking in `{communication_language}`.
|
|
57
|
+
|
|
58
|
+
### Step 6: Execute Append Steps
|
|
59
|
+
|
|
60
|
+
Execute each entry in `{workflow.activation_steps_append}` in order.
|
|
61
|
+
|
|
62
|
+
Activation is complete. Begin the workflow below.
|
|
63
|
+
|
|
64
|
+
## QUICK TOPIC DISCOVERY
|
|
65
|
+
|
|
66
|
+
"Welcome {{user_name}}! Let's get started with your **domain/industry research**.
|
|
67
|
+
|
|
68
|
+
**What domain, industry, or sector do you want to research?**
|
|
69
|
+
|
|
70
|
+
For example:
|
|
71
|
+
- 'The healthcare technology industry'
|
|
72
|
+
- 'Sustainable packaging regulations in Europe'
|
|
73
|
+
- 'Construction and building materials sector'
|
|
74
|
+
- 'Or any other domain you have in mind...'"
|
|
75
|
+
|
|
76
|
+
### Topic Clarification
|
|
77
|
+
|
|
78
|
+
Based on the user's topic, briefly clarify:
|
|
79
|
+
1. **Core Domain**: "What specific aspect of [domain] are you most interested in?"
|
|
80
|
+
2. **Research Goals**: "What do you hope to achieve with this research?"
|
|
81
|
+
3. **Scope**: "Should we focus broadly or dive deep into specific aspects?"
|
|
82
|
+
|
|
83
|
+
## ROUTE TO DOMAIN RESEARCH STEPS
|
|
84
|
+
|
|
85
|
+
After gathering the topic and goals:
|
|
86
|
+
|
|
87
|
+
1. Set `research_type = "domain"`
|
|
88
|
+
2. Set `research_topic = [discovered topic from discussion]`
|
|
89
|
+
3. Set `research_goals = [discovered goals from discussion]`
|
|
90
|
+
4. Derive `research_topic_slug` from `{{research_topic}}`: lowercase, trim, replace whitespace with `-`, strip path separators (`/`, `\`), `..`, and any character that is not alphanumeric, `-`, or `_`. Collapse repeated `-` and strip leading/trailing `-`. If the result is empty, use `untitled`.
|
|
91
|
+
5. Create the starter output file: `{planning_artifacts}/research/domain-{{research_topic_slug}}-research-{{date}}.md` with exact copy of the `./research.template.md` contents
|
|
92
|
+
6. Load: `./domain-steps/step-01-init.md` with topic context
|
|
93
|
+
|
|
94
|
+
**Note:** The discovered topic from the discussion should be passed to the initialization step, so it doesn't need to ask "What do you want to research?" again - it can focus on refining the scope for domain research.
|
|
95
|
+
|
|
96
|
+
**✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`**
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# DO NOT EDIT -- overwritten on every update.
|
|
2
|
+
#
|
|
3
|
+
# Workflow customization surface for bmad-domain-research. Mirrors the
|
|
4
|
+
# agent customization shape under the [workflow] namespace.
|
|
5
|
+
|
|
6
|
+
[workflow]
|
|
7
|
+
|
|
8
|
+
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
|
9
|
+
# scalars: override wins • arrays (persistent_facts, activation_steps_*): append
|
|
10
|
+
# arrays-of-tables with `code`/`id`: replace matching items, append new ones.
|
|
11
|
+
|
|
12
|
+
activation_steps_prepend = []
|
|
13
|
+
activation_steps_append = []
|
|
14
|
+
|
|
15
|
+
persistent_facts = [
|
|
16
|
+
"file:{project-root}/**/project-context.md",
|
|
17
|
+
]
|
|
18
|
+
|
|
19
|
+
on_complete = ""
|
|
@@ -3,4 +3,94 @@ name: bmad-market-research
|
|
|
3
3
|
description: 'Conduct market research on competition and customers. Use when the user says they need market research'
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
# Market Research Workflow
|
|
7
|
+
|
|
8
|
+
**Goal:** Conduct comprehensive market research using current web data and verified sources to produce complete research documents with compelling narratives and proper citations.
|
|
9
|
+
|
|
10
|
+
**Your Role:** You are a market research facilitator working with an expert partner. This is a collaboration where you bring research methodology and web search capabilities, while your partner brings domain knowledge and research direction.
|
|
11
|
+
|
|
12
|
+
## Conventions
|
|
13
|
+
|
|
14
|
+
- Bare paths (e.g. `steps/step-01-init.md`) resolve from the skill root.
|
|
15
|
+
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
|
16
|
+
- `{project-root}`-prefixed paths resolve from the project working directory.
|
|
17
|
+
- `{skill-name}` resolves to the skill directory's basename.
|
|
18
|
+
|
|
19
|
+
## PREREQUISITE
|
|
20
|
+
|
|
21
|
+
**⛔ Web search required.** If unavailable, abort and tell the user.
|
|
22
|
+
|
|
23
|
+
## On Activation
|
|
24
|
+
|
|
25
|
+
### Step 1: Resolve the Workflow Block
|
|
26
|
+
|
|
27
|
+
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
|
28
|
+
|
|
29
|
+
**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver:
|
|
30
|
+
|
|
31
|
+
1. `{skill-root}/customize.toml` — defaults
|
|
32
|
+
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
|
33
|
+
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
|
34
|
+
|
|
35
|
+
Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append.
|
|
36
|
+
|
|
37
|
+
### Step 2: Execute Prepend Steps
|
|
38
|
+
|
|
39
|
+
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
|
40
|
+
|
|
41
|
+
### Step 3: Load Persistent Facts
|
|
42
|
+
|
|
43
|
+
Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim.
|
|
44
|
+
|
|
45
|
+
### Step 4: Load Config
|
|
46
|
+
|
|
47
|
+
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
|
48
|
+
- Use `{user_name}` for greeting
|
|
49
|
+
- Use `{communication_language}` for all communications
|
|
50
|
+
- Use `{document_output_language}` for output documents
|
|
51
|
+
- Use `{planning_artifacts}` for output location and artifact scanning
|
|
52
|
+
- Use `{project_knowledge}` for additional context scanning
|
|
53
|
+
|
|
54
|
+
### Step 5: Greet the User
|
|
55
|
+
|
|
56
|
+
Greet `{user_name}`, speaking in `{communication_language}`.
|
|
57
|
+
|
|
58
|
+
### Step 6: Execute Append Steps
|
|
59
|
+
|
|
60
|
+
Execute each entry in `{workflow.activation_steps_append}` in order.
|
|
61
|
+
|
|
62
|
+
Activation is complete. Begin the workflow below.
|
|
63
|
+
|
|
64
|
+
## QUICK TOPIC DISCOVERY
|
|
65
|
+
|
|
66
|
+
"Welcome {{user_name}}! Let's get started with your **market research**.
|
|
67
|
+
|
|
68
|
+
**What topic, problem, or area do you want to research?**
|
|
69
|
+
|
|
70
|
+
For example:
|
|
71
|
+
- 'The electric vehicle market in Europe'
|
|
72
|
+
- 'Plant-based food alternatives market'
|
|
73
|
+
- 'Mobile payment solutions in Southeast Asia'
|
|
74
|
+
- 'Or anything else you have in mind...'"
|
|
75
|
+
|
|
76
|
+
### Topic Clarification
|
|
77
|
+
|
|
78
|
+
Based on the user's topic, briefly clarify:
|
|
79
|
+
1. **Core Topic**: "What exactly about [topic] are you most interested in?"
|
|
80
|
+
2. **Research Goals**: "What do you hope to achieve with this research?"
|
|
81
|
+
3. **Scope**: "Should we focus broadly or dive deep into specific aspects?"
|
|
82
|
+
|
|
83
|
+
## ROUTE TO MARKET RESEARCH STEPS
|
|
84
|
+
|
|
85
|
+
After gathering the topic and goals:
|
|
86
|
+
|
|
87
|
+
1. Set `research_type = "market"`
|
|
88
|
+
2. Set `research_topic = [discovered topic from discussion]`
|
|
89
|
+
3. Set `research_goals = [discovered goals from discussion]`
|
|
90
|
+
4. Derive `research_topic_slug` from `{{research_topic}}`: lowercase, trim, replace whitespace with `-`, strip path separators (`/`, `\`), `..`, and any character that is not alphanumeric, `-`, or `_`. Collapse repeated `-` and strip leading/trailing `-`. If the result is empty, use `untitled`.
|
|
91
|
+
5. Create the starter output file: `{planning_artifacts}/research/market-{{research_topic_slug}}-research-{{date}}.md` with exact copy of the `./research.template.md` contents
|
|
92
|
+
6. Load: `./steps/step-01-init.md` with topic context
|
|
93
|
+
|
|
94
|
+
**Note:** The discovered topic from the discussion should be passed to the initialization step, so it doesn't need to ask "What do you want to research?" again - it can focus on refining the scope for market research.
|
|
95
|
+
|
|
96
|
+
**✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`**
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# DO NOT EDIT -- overwritten on every update.
|
|
2
|
+
#
|
|
3
|
+
# Workflow customization surface for bmad-market-research. Mirrors the
|
|
4
|
+
# agent customization shape under the [workflow] namespace.
|
|
5
|
+
|
|
6
|
+
[workflow]
|
|
7
|
+
|
|
8
|
+
activation_steps_prepend = []
|
|
9
|
+
activation_steps_append = []
|
|
10
|
+
|
|
11
|
+
persistent_facts = [
|
|
12
|
+
"file:{project-root}/**/project-context.md",
|
|
13
|
+
]
|
|
14
|
+
|
|
15
|
+
on_complete = ""
|
|
@@ -3,4 +3,94 @@ name: bmad-technical-research
|
|
|
3
3
|
description: 'Conduct technical research on technologies and architecture. Use when the user says they would like to do or produce a technical research report'
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
# Technical Research Workflow
|
|
7
|
+
|
|
8
|
+
**Goal:** Conduct comprehensive technical research using current web data and verified sources to produce complete research documents with compelling narratives and proper citations.
|
|
9
|
+
|
|
10
|
+
**Your Role:** You are a technical research facilitator working with an expert partner. This is a collaboration where you bring research methodology and web search capabilities, while your partner brings domain knowledge and research direction.
|
|
11
|
+
|
|
12
|
+
## Conventions
|
|
13
|
+
|
|
14
|
+
- Bare paths (e.g. `technical-steps/step-01-init.md`) resolve from the skill root.
|
|
15
|
+
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
|
16
|
+
- `{project-root}`-prefixed paths resolve from the project working directory.
|
|
17
|
+
- `{skill-name}` resolves to the skill directory's basename.
|
|
18
|
+
|
|
19
|
+
## PREREQUISITE
|
|
20
|
+
|
|
21
|
+
**⛔ Web search required.** If unavailable, abort and tell the user.
|
|
22
|
+
|
|
23
|
+
## On Activation
|
|
24
|
+
|
|
25
|
+
### Step 1: Resolve the Workflow Block
|
|
26
|
+
|
|
27
|
+
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
|
28
|
+
|
|
29
|
+
**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver:
|
|
30
|
+
|
|
31
|
+
1. `{skill-root}/customize.toml` — defaults
|
|
32
|
+
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
|
33
|
+
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
|
34
|
+
|
|
35
|
+
Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append.
|
|
36
|
+
|
|
37
|
+
### Step 2: Execute Prepend Steps
|
|
38
|
+
|
|
39
|
+
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
|
40
|
+
|
|
41
|
+
### Step 3: Load Persistent Facts
|
|
42
|
+
|
|
43
|
+
Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim.
|
|
44
|
+
|
|
45
|
+
### Step 4: Load Config
|
|
46
|
+
|
|
47
|
+
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
|
48
|
+
- Use `{user_name}` for greeting
|
|
49
|
+
- Use `{communication_language}` for all communications
|
|
50
|
+
- Use `{document_output_language}` for output documents
|
|
51
|
+
- Use `{planning_artifacts}` for output location and artifact scanning
|
|
52
|
+
- Use `{project_knowledge}` for additional context scanning
|
|
53
|
+
|
|
54
|
+
### Step 5: Greet the User
|
|
55
|
+
|
|
56
|
+
Greet `{user_name}`, speaking in `{communication_language}`.
|
|
57
|
+
|
|
58
|
+
### Step 6: Execute Append Steps
|
|
59
|
+
|
|
60
|
+
Execute each entry in `{workflow.activation_steps_append}` in order.
|
|
61
|
+
|
|
62
|
+
Activation is complete. Begin the workflow below.
|
|
63
|
+
|
|
64
|
+
## QUICK TOPIC DISCOVERY
|
|
65
|
+
|
|
66
|
+
"Welcome {{user_name}}! Let's get started with your **technical research**.
|
|
67
|
+
|
|
68
|
+
**What technology, tool, or technical area do you want to research?**
|
|
69
|
+
|
|
70
|
+
For example:
|
|
71
|
+
- 'React vs Vue for large-scale applications'
|
|
72
|
+
- 'GraphQL vs REST API architectures'
|
|
73
|
+
- 'Serverless deployment options for Node.js'
|
|
74
|
+
- 'Or any other technical topic you have in mind...'"
|
|
75
|
+
|
|
76
|
+
### Topic Clarification
|
|
77
|
+
|
|
78
|
+
Based on the user's topic, briefly clarify:
|
|
79
|
+
1. **Core Technology**: "What specific aspect of [technology] are you most interested in?"
|
|
80
|
+
2. **Research Goals**: "What do you hope to achieve with this research?"
|
|
81
|
+
3. **Scope**: "Should we focus broadly or dive deep into specific aspects?"
|
|
82
|
+
|
|
83
|
+
## ROUTE TO TECHNICAL RESEARCH STEPS
|
|
84
|
+
|
|
85
|
+
After gathering the topic and goals:
|
|
86
|
+
|
|
87
|
+
1. Set `research_type = "technical"`
|
|
88
|
+
2. Set `research_topic = [discovered topic from discussion]`
|
|
89
|
+
3. Set `research_goals = [discovered goals from discussion]`
|
|
90
|
+
4. Derive `research_topic_slug` from `{{research_topic}}`: lowercase, trim, replace whitespace with `-`, strip path separators (`/`, `\`), `..`, and any character that is not alphanumeric, `-`, or `_`. Collapse repeated `-` and strip leading/trailing `-`. If the result is empty, use `untitled`.
|
|
91
|
+
5. Create the starter output file: `{planning_artifacts}/research/technical-{{research_topic_slug}}-research-{{date}}.md` with exact copy of the `./research.template.md` contents
|
|
92
|
+
6. Load: `./technical-steps/step-01-init.md` with topic context
|
|
93
|
+
|
|
94
|
+
**Note:** The discovered topic from the discussion should be passed to the initialization step, so it doesn't need to ask "What do you want to research?" again - it can focus on refining the scope for technical research.
|
|
95
|
+
|
|
96
|
+
**✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`**
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# DO NOT EDIT -- overwritten on every update.
|
|
2
|
+
#
|
|
3
|
+
# Workflow customization surface for bmad-technical-research. Mirrors the
|
|
4
|
+
# agent customization shape under the [workflow] namespace.
|
|
5
|
+
|
|
6
|
+
[workflow]
|
|
7
|
+
|
|
8
|
+
activation_steps_prepend = []
|
|
9
|
+
activation_steps_append = []
|
|
10
|
+
|
|
11
|
+
persistent_facts = [
|
|
12
|
+
"file:{project-root}/**/project-context.md",
|
|
13
|
+
]
|
|
14
|
+
|
|
15
|
+
on_complete = ""
|
|
@@ -3,4 +3,102 @@ name: bmad-create-prd
|
|
|
3
3
|
description: 'Create a PRD from scratch. Use when the user says "lets create a product requirements document" or "I want to create a new PRD"'
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
# PRD Create Workflow
|
|
7
|
+
|
|
8
|
+
**Goal:** Create comprehensive PRDs through structured workflow facilitation.
|
|
9
|
+
|
|
10
|
+
**Your Role:** Product-focused PM facilitator collaborating with an expert peer.
|
|
11
|
+
|
|
12
|
+
You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description.
|
|
13
|
+
|
|
14
|
+
## Conventions
|
|
15
|
+
|
|
16
|
+
- Bare paths (e.g. `steps-c/step-01-init.md`) resolve from the skill root.
|
|
17
|
+
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
|
18
|
+
- `{project-root}`-prefixed paths resolve from the project working directory.
|
|
19
|
+
- `{skill-name}` resolves to the skill directory's basename.
|
|
20
|
+
|
|
21
|
+
## WORKFLOW ARCHITECTURE
|
|
22
|
+
|
|
23
|
+
This uses **step-file architecture** for disciplined execution:
|
|
24
|
+
|
|
25
|
+
### Core Principles
|
|
26
|
+
|
|
27
|
+
- **Micro-file Design**: Each step is a self-contained instruction file that is a part of an overall workflow that must be followed exactly
|
|
28
|
+
- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so
|
|
29
|
+
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
|
|
30
|
+
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
|
|
31
|
+
- **Append-Only Building**: Build documents by appending content as directed to the output file
|
|
32
|
+
|
|
33
|
+
### Step Processing Rules
|
|
34
|
+
|
|
35
|
+
1. **READ COMPLETELY**: Always read the entire step file before taking any action
|
|
36
|
+
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
|
|
37
|
+
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
|
|
38
|
+
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
|
|
39
|
+
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
|
|
40
|
+
6. **LOAD NEXT**: When directed, read fully and follow the next step file
|
|
41
|
+
|
|
42
|
+
### Critical Rules (NO EXCEPTIONS)
|
|
43
|
+
|
|
44
|
+
- 🛑 **NEVER** load multiple step files simultaneously
|
|
45
|
+
- 📖 **ALWAYS** read entire step file before execution
|
|
46
|
+
- 🚫 **NEVER** skip steps or optimize the sequence
|
|
47
|
+
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
|
|
48
|
+
- 🎯 **ALWAYS** follow the exact instructions in the step file
|
|
49
|
+
- ⏸️ **ALWAYS** halt at menus and wait for user input
|
|
50
|
+
- 📋 **NEVER** create mental todo lists from future steps
|
|
51
|
+
|
|
52
|
+
## On Activation
|
|
53
|
+
|
|
54
|
+
### Step 1: Resolve the Workflow Block
|
|
55
|
+
|
|
56
|
+
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
|
57
|
+
|
|
58
|
+
**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver:
|
|
59
|
+
|
|
60
|
+
1. `{skill-root}/customize.toml` — defaults
|
|
61
|
+
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
|
62
|
+
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
|
63
|
+
|
|
64
|
+
Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append.
|
|
65
|
+
|
|
66
|
+
### Step 2: Execute Prepend Steps
|
|
67
|
+
|
|
68
|
+
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
|
69
|
+
|
|
70
|
+
### Step 3: Load Persistent Facts
|
|
71
|
+
|
|
72
|
+
Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim.
|
|
73
|
+
|
|
74
|
+
### Step 4: Load Config
|
|
75
|
+
|
|
76
|
+
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
|
77
|
+
- Use `{user_name}` for greeting
|
|
78
|
+
- Use `{communication_language}` for all communications
|
|
79
|
+
- Use `{document_output_language}` for output documents
|
|
80
|
+
- Use `{planning_artifacts}` for output location and artifact scanning
|
|
81
|
+
- Use `{project_knowledge}` for additional context scanning
|
|
82
|
+
|
|
83
|
+
### Step 5: Greet the User
|
|
84
|
+
|
|
85
|
+
Greet `{user_name}`, speaking in `{communication_language}`.
|
|
86
|
+
|
|
87
|
+
### Step 6: Execute Append Steps
|
|
88
|
+
|
|
89
|
+
Execute each entry in `{workflow.activation_steps_append}` in order.
|
|
90
|
+
|
|
91
|
+
Activation is complete. Begin the workflow below.
|
|
92
|
+
|
|
93
|
+
## Paths
|
|
94
|
+
|
|
95
|
+
- `outputFile` = `{planning_artifacts}/prd.md`
|
|
96
|
+
|
|
97
|
+
## Execution
|
|
98
|
+
|
|
99
|
+
✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the configured `{communication_language}`.
|
|
100
|
+
✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`.
|
|
101
|
+
|
|
102
|
+
**Create Mode: Creating a new PRD from scratch.**
|
|
103
|
+
|
|
104
|
+
Read fully and follow: `./steps-c/step-01-init.md`
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# DO NOT EDIT -- overwritten on every update.
|
|
2
|
+
#
|
|
3
|
+
# Workflow customization surface for bmad-create-prd.
|
|
4
|
+
|
|
5
|
+
[workflow]
|
|
6
|
+
|
|
7
|
+
activation_steps_prepend = []
|
|
8
|
+
activation_steps_append = []
|
|
9
|
+
|
|
10
|
+
persistent_facts = [
|
|
11
|
+
"file:{project-root}/**/project-context.md",
|
|
12
|
+
]
|
|
13
|
+
|
|
14
|
+
on_complete = ""
|