Compare commits
4 Commits
5a8a8b0ba4
...
169f8e2064
| Author | SHA1 | Date |
|---|---|---|
|
|
169f8e2064 | |
|
|
87292cd86a | |
|
|
b63086f22e | |
|
|
ffdd9bc69e |
|
|
@ -75,6 +75,8 @@ The customization model is what lets this scale beyond a single developer.
|
||||||
|
|
||||||
Every agent ships a `customize.toml` with sensible defaults. Teams commit overrides to `_bmad/custom/bmad-agent-{role}.toml`. Individuals can layer personal preferences in `.user.toml` (gitignored). The resolver merges all three at activation time with predictable structural rules.
|
Every agent ships a `customize.toml` with sensible defaults. Teams commit overrides to `_bmad/custom/bmad-agent-{role}.toml`. Individuals can layer personal preferences in `.user.toml` (gitignored). The resolver merges all three at activation time with predictable structural rules.
|
||||||
|
|
||||||
|
Most users never hand-author these files. The `bmad-customize` skill walks through picking the target, choosing agent vs workflow scope, authoring the override, and verifying the merge — so the customization surface stays accessible to anyone who understands their intent, not just those fluent in TOML.
|
||||||
|
|
||||||
Concrete example: a team commits a single file telling Amelia to always use the Context7 MCP tool for library docs and to fall back to Linear when a story isn't in the local epics list. Every dev workflow Amelia dispatches (dev-story, quick-dev, create-story, code-review) inherits that behavior, with no source edits or per-workflow duplication required.
|
Concrete example: a team commits a single file telling Amelia to always use the Context7 MCP tool for library docs and to fall back to Linear when a story isn't in the local epics list. Every dev workflow Amelia dispatches (dev-story, quick-dev, create-story, code-review) inherits that behavior, with no source edits or per-workflow duplication required.
|
||||||
|
|
||||||
There's also a second customization surface for *cross-cutting* concerns: the central `_bmad/config.toml` and `_bmad/config.user.toml` (both installer-owned, rebuilt from each module's `module.yaml`) plus `_bmad/custom/config.toml` (team, committed) and `_bmad/custom/config.user.toml` (personal, gitignored) for overrides. This is where the **agent roster** lives — the lightweight descriptors that roster consumers like `bmad-party-mode`, `bmad-retrospective`, and `bmad-advanced-elicitation` read to know who's available and how to embody them. Rebrand an agent org-wide with a team override; add fictional voices (Kirk, Spock, a domain expert persona) as personal experiments via the `.user.toml` override — without touching any skill folder. The per-skill file shapes how Mary *behaves* when she activates; the central config shapes how other skills *see* her when they look at the field.
|
There's also a second customization surface for *cross-cutting* concerns: the central `_bmad/config.toml` and `_bmad/config.user.toml` (both installer-owned, rebuilt from each module's `module.yaml`) plus `_bmad/custom/config.toml` (team, committed) and `_bmad/custom/config.user.toml` (personal, gitignored) for overrides. This is where the **agent roster** lives — the lightweight descriptors that roster consumers like `bmad-party-mode`, `bmad-retrospective`, and `bmad-advanced-elicitation` read to know who's available and how to embody them. Rebrand an agent org-wide with a team override; add fictional voices (Kirk, Spock, a domain expert persona) as personal experiments via the `.user.toml` override — without touching any skill folder. The per-skill file shapes how Mary *behaves* when she activates; the central config shapes how other skills *see* her when they look at the field.
|
||||||
|
|
@ -83,6 +85,7 @@ For the full customization surface and worked examples, see:
|
||||||
|
|
||||||
- [How to Customize BMad](../how-to/customize-bmad.md) — the reference for what's customizable and how merge works
|
- [How to Customize BMad](../how-to/customize-bmad.md) — the reference for what's customizable and how merge works
|
||||||
- [How to Expand BMad for Your Organization](../how-to/expand-bmad-for-your-org.md) — five worked recipes spanning agent-wide rules, workflow conventions, external publishing, template swaps, and agent roster customization
|
- [How to Expand BMad for Your Organization](../how-to/expand-bmad-for-your-org.md) — five worked recipes spanning agent-wide rules, workflow conventions, external publishing, template swaps, and agent roster customization
|
||||||
|
- `bmad-customize` skill — the guided authoring helper that turns intent into a correctly-placed, verified override file
|
||||||
|
|
||||||
## The Bigger Idea
|
## The Bigger Idea
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -7,6 +7,10 @@ sidebar:
|
||||||
|
|
||||||
Tailor agent personas, inject domain context, add capabilities, and configure workflow behavior -- all without modifying installed files. Your customizations survive every update.
|
Tailor agent personas, inject domain context, add capabilities, and configure workflow behavior -- all without modifying installed files. Your customizations survive every update.
|
||||||
|
|
||||||
|
:::tip[Don't want to hand-author TOML? Use `bmad-customize`]
|
||||||
|
The `bmad-customize` skill is a guided authoring helper for the **per-skill agent/workflow override surface** described in this doc. It scans what's customizable in your installation, helps you choose the right surface (agent vs workflow) for your intent, writes the override file for you, and verifies the merge landed. Central-config overrides (`_bmad/custom/config.toml`) are out of scope for v1 — hand-author those per the Central Configuration section below. Run the skill whenever you want to make a per-skill change; this doc is the reference for *what* each surface exposes and how merging works.
|
||||||
|
:::
|
||||||
|
|
||||||
## When to Use This
|
## When to Use This
|
||||||
|
|
||||||
- You want to change an agent's personality or communication style
|
- You want to change an agent's personality or communication style
|
||||||
|
|
@ -258,6 +262,27 @@ on_complete = "Summarize the brief in three bullets and offer to email it via th
|
||||||
|
|
||||||
The same field conventions cross the agent/workflow boundary: `activation_steps_prepend`/`activation_steps_append`, `persistent_facts` (with `file:` refs), and menu-style `[[…]]` tables with `code`/`id` for keyed merge. The resolver applies the same four structural rules regardless of the top-level key. SKILL.md references follow the namespace: `{workflow.activation_steps_prepend}`, `{workflow.persistent_facts}`, `{workflow.on_complete}`. Any additional fields a workflow exposes (output paths, toggles, review settings, stage flags) follow the same shape-based merge rules. Read the workflow's `customize.toml` to see what's customizable.
|
The same field conventions cross the agent/workflow boundary: `activation_steps_prepend`/`activation_steps_append`, `persistent_facts` (with `file:` refs), and menu-style `[[…]]` tables with `code`/`id` for keyed merge. The resolver applies the same four structural rules regardless of the top-level key. SKILL.md references follow the namespace: `{workflow.activation_steps_prepend}`, `{workflow.persistent_facts}`, `{workflow.on_complete}`. Any additional fields a workflow exposes (output paths, toggles, review settings, stage flags) follow the same shape-based merge rules. Read the workflow's `customize.toml` to see what's customizable.
|
||||||
|
|
||||||
|
### Activation Order
|
||||||
|
|
||||||
|
Customizable workflows run their activation in a fixed sequence so you know exactly when your hooks fire:
|
||||||
|
|
||||||
|
1. Resolve the `[workflow]` block (base → team → user merge)
|
||||||
|
2. Execute `activation_steps_prepend` in order
|
||||||
|
3. Load `persistent_facts` as foundational context for the run
|
||||||
|
4. Load config (`_bmad/bmm/config.yaml`) and resolve standard variables (project name, languages, paths, date)
|
||||||
|
5. Greet the user
|
||||||
|
6. Execute `activation_steps_append` in order
|
||||||
|
|
||||||
|
After step 6 the workflow body begins. Use `activation_steps_prepend` when you need context loaded before the greeting can be personalized; use `activation_steps_append` when the setup is heavy and you'd rather the user sees the greeting first.
|
||||||
|
|
||||||
|
### Scope of This Initial Pass
|
||||||
|
|
||||||
|
Customization is rolling out incrementally. The fields documented above — `activation_steps_prepend`, `activation_steps_append`, `persistent_facts`, `on_complete` — are the **baseline surface** that every customizable workflow exposes, and they will remain stable across versions. They give you broad-stroke control today: inject pre/post steps, pin foundational context, trigger follow-up actions.
|
||||||
|
|
||||||
|
Over time, individual workflows will expose **more targeted customization points** tailored to what that workflow actually does — things like step-specific toggles, stage flags, output template paths, or review gates. When those arrive, they stack on top of the baseline fields rather than replacing them, so customizations you author today keep working.
|
||||||
|
|
||||||
|
If you need a fine-grained knob that isn't exposed yet, either use `activation_steps_*` and `persistent_facts` to steer behavior, or open an issue describing the specific customization point you want — those requests are what drive which targeted fields get added next.
|
||||||
|
|
||||||
## Central Configuration
|
## Central Configuration
|
||||||
|
|
||||||
Per-skill `customize.toml` covers **deep behavior** (hooks, menus, persistent_facts, persona overrides for a single agent or workflow). A separate surface covers **cross-cutting state** — install answers and the agent roster that external skills like `bmad-party-mode`, `bmad-retrospective`, and `bmad-advanced-elicitation` consume. That surface lives in four TOML files at project root:
|
Per-skill `customize.toml` covers **deep behavior** (hooks, menus, persistent_facts, persona overrides for a single agent or workflow). A separate surface covers **cross-cutting state** — install answers and the agent roster that external skills like `bmad-party-mode`, `bmad-retrospective`, and `bmad-advanced-elicitation` consume. That surface lives in four TOML files at project root:
|
||||||
|
|
@ -362,7 +387,8 @@ For enterprise-oriented recipes (shaping an agent across every workflow it dispa
|
||||||
|
|
||||||
**Need to see what's customizable?**
|
**Need to see what's customizable?**
|
||||||
|
|
||||||
- Read the skill's `customize.toml` -- every field there is customizable (except `name` and `title`)
|
- Run the `bmad-customize` skill — it enumerates every customizable skill installed in your project, shows which ones already have overrides, and walks you through adding or updating one
|
||||||
|
- Or read the skill's `customize.toml` directly — every field there is customizable (except `name` and `title`)
|
||||||
|
|
||||||
**Need to reset?**
|
**Need to reset?**
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -14,6 +14,10 @@ BMad's customization surface lets an organization reshape behavior without editi
|
||||||
- Python 3.11+ on PATH (for the resolver — stdlib only, no `pip install`)
|
- Python 3.11+ on PATH (for the resolver — stdlib only, no `pip install`)
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
:::tip[Applying these recipes]
|
||||||
|
The **per-skill recipes** below (Recipes 1–4) can be applied by running the `bmad-customize` skill and describing the intent — it will pick the right surface, author the override file, and verify the merge. Recipe 5 (central-config overrides to the agent roster) is out of scope for v1 of the skill and remains hand-authored. The recipes here are the source of truth for *what* to override; `bmad-customize` handles the *how* for the agent/workflow surface.
|
||||||
|
:::
|
||||||
|
|
||||||
## The Three-Layer Mental Model
|
## The Three-Layer Mental Model
|
||||||
|
|
||||||
Before picking a recipe, know where your override lands:
|
Before picking a recipe, know where your override lands:
|
||||||
|
|
|
||||||
|
|
@ -3,4 +3,60 @@ name: bmad-document-project
|
||||||
description: 'Document brownfield projects for AI context. Use when the user says "document this project" or "generate project docs"'
|
description: 'Document brownfield projects for AI context. Use when the user says "document this project" or "generate project docs"'
|
||||||
---
|
---
|
||||||
|
|
||||||
Follow the instructions in ./workflow.md.
|
# Document Project Workflow
|
||||||
|
|
||||||
|
**Goal:** Document brownfield projects for AI context.
|
||||||
|
|
||||||
|
**Your Role:** Project documentation specialist.
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- Bare paths (e.g. `instructions.md`) resolve from the skill root.
|
||||||
|
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
||||||
|
- `{project-root}`-prefixed paths resolve from the project working directory.
|
||||||
|
- `{skill-name}` resolves to the skill directory's basename.
|
||||||
|
|
||||||
|
## On Activation
|
||||||
|
|
||||||
|
### Step 1: Resolve the Workflow Block
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
||||||
|
|
||||||
|
**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:
|
||||||
|
|
||||||
|
1. `{skill-root}/customize.toml` — defaults
|
||||||
|
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
||||||
|
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 2: Execute Prepend Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
||||||
|
|
||||||
|
### Step 3: Load Persistent Facts
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 4: Load Config
|
||||||
|
|
||||||
|
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||||
|
- Use `{user_name}` for greeting
|
||||||
|
- Use `{communication_language}` for all communications
|
||||||
|
- Use `{document_output_language}` for output documents
|
||||||
|
- Use `{planning_artifacts}` for output location and artifact scanning
|
||||||
|
- Use `{project_knowledge}` for additional context scanning
|
||||||
|
|
||||||
|
### Step 5: Greet the User
|
||||||
|
|
||||||
|
Greet `{user_name}` (if you have not already), speaking in `{communication_language}`.
|
||||||
|
|
||||||
|
### Step 6: Execute Append Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_append}` in order.
|
||||||
|
|
||||||
|
Activation is complete. Begin the workflow below.
|
||||||
|
|
||||||
|
## Execution
|
||||||
|
|
||||||
|
Read fully and follow: `./instructions.md`
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,41 @@
|
||||||
|
# DO NOT EDIT -- overwritten on every update.
|
||||||
|
#
|
||||||
|
# Workflow customization surface for bmad-document-project. Mirrors the
|
||||||
|
# agent customization shape under the [workflow] namespace.
|
||||||
|
|
||||||
|
[workflow]
|
||||||
|
|
||||||
|
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
||||||
|
# scalars: override wins • arrays (persistent_facts, activation_steps_*): append
|
||||||
|
# arrays-of-tables with `code`/`id`: replace matching items, append new ones.
|
||||||
|
|
||||||
|
# Steps to run before the standard activation (config load, greet).
|
||||||
|
# Overrides append. Use for pre-flight loads, compliance checks, etc.
|
||||||
|
|
||||||
|
activation_steps_prepend = []
|
||||||
|
|
||||||
|
# Steps to run after greet but before the workflow begins.
|
||||||
|
# Overrides append. Use for context-heavy setup that should happen
|
||||||
|
# once the user has been acknowledged.
|
||||||
|
|
||||||
|
activation_steps_append = []
|
||||||
|
|
||||||
|
# Persistent facts the workflow keeps in mind for the whole run
|
||||||
|
# (standards, compliance constraints, stylistic guardrails).
|
||||||
|
# Distinct from the runtime memory sidecar — these are static context
|
||||||
|
# loaded on activation. Overrides append.
|
||||||
|
#
|
||||||
|
# Each entry is either:
|
||||||
|
# - a literal sentence, e.g. "All briefs must include a regulatory-risk section."
|
||||||
|
# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md"
|
||||||
|
# (glob patterns are supported; the file's contents are loaded and treated as facts).
|
||||||
|
|
||||||
|
persistent_facts = [
|
||||||
|
"file:{project-root}/**/project-context.md",
|
||||||
|
]
|
||||||
|
|
||||||
|
# Scalar: executed when the workflow reaches its terminal stage, after
|
||||||
|
# the main output has been delivered. Override wins. Leave empty for
|
||||||
|
# no custom post-completion behavior.
|
||||||
|
|
||||||
|
on_complete = ""
|
||||||
|
|
@ -1,25 +0,0 @@
|
||||||
# Document Project Workflow
|
|
||||||
|
|
||||||
**Goal:** Document brownfield projects for AI context.
|
|
||||||
|
|
||||||
**Your Role:** Project documentation specialist.
|
|
||||||
- Communicate all responses in {communication_language}
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## INITIALIZATION
|
|
||||||
|
|
||||||
1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve::
|
|
||||||
- Use `{user_name}` for greeting
|
|
||||||
- Use `{communication_language}` for all communications
|
|
||||||
- Use `{document_output_language}` for output documents
|
|
||||||
- Use `{planning_artifacts}` for output location and artifact scanning
|
|
||||||
- Use `{project_knowledge}` for additional context scanning
|
|
||||||
|
|
||||||
2. **Greet user** as `{user_name}`, speaking in `{communication_language}`.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## EXECUTION
|
|
||||||
|
|
||||||
Read fully and follow: `./instructions.md`
|
|
||||||
|
|
@ -291,6 +291,7 @@ These comprehensive docs are now ready for:
|
||||||
|
|
||||||
Thank you for using the document-project workflow!
|
Thank you for using the document-project workflow!
|
||||||
</action>
|
</action>
|
||||||
|
<action>Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` — if the resolved value is non-empty, follow it as the final terminal instruction before exiting.</action>
|
||||||
<action>Exit workflow</action>
|
<action>Exit workflow</action>
|
||||||
</action>
|
</action>
|
||||||
</step>
|
</step>
|
||||||
|
|
|
||||||
|
|
@ -1103,5 +1103,6 @@ When ready to plan new features, run the PRD workflow and provide this index as
|
||||||
</action>
|
</action>
|
||||||
|
|
||||||
<action>Display: "State file saved: {{project_knowledge}}/project-scan-report.json"</action>
|
<action>Display: "State file saved: {{project_knowledge}}/project-scan-report.json"</action>
|
||||||
|
<action>Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` — if the resolved value is non-empty, follow it as the final terminal instruction before exiting.</action>
|
||||||
|
|
||||||
</workflow>
|
</workflow>
|
||||||
|
|
|
||||||
|
|
@ -19,20 +19,59 @@ The PRFAQ forces customer-first clarity: write the press release announcing the
|
||||||
|
|
||||||
**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.
|
**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.
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- Bare paths (e.g. `references/press-release.md`) resolve from the skill root.
|
||||||
|
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
||||||
|
- `{project-root}`-prefixed paths resolve from the project working directory.
|
||||||
|
- `{skill-name}` resolves to the skill directory's basename.
|
||||||
|
|
||||||
## On Activation
|
## On Activation
|
||||||
|
|
||||||
1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve::
|
### Step 1: Resolve the Workflow Block
|
||||||
- Use `{user_name}` for greeting
|
|
||||||
- Use `{communication_language}` for all communications
|
|
||||||
- Use `{document_output_language}` for output documents
|
|
||||||
- Use `{planning_artifacts}` for output location and artifact scanning
|
|
||||||
- Use `{project_knowledge}` for additional context scanning
|
|
||||||
|
|
||||||
2. **Greet user** as `{user_name}`, speaking in `{communication_language}`. Be warm but efficient — dream builder energy.
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
||||||
|
|
||||||
3. **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.
|
**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:
|
||||||
|
|
||||||
4. **Mode detection:**
|
1. `{skill-root}/customize.toml` — defaults
|
||||||
|
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
||||||
|
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 2: Execute Prepend Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
||||||
|
|
||||||
|
### Step 3: Load Persistent Facts
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 4: Load Config
|
||||||
|
|
||||||
|
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||||
|
- Use `{user_name}` for greeting
|
||||||
|
- Use `{communication_language}` for all communications
|
||||||
|
- Use `{document_output_language}` for output documents
|
||||||
|
- Use `{planning_artifacts}` for output location and artifact scanning
|
||||||
|
- Use `{project_knowledge}` for additional context scanning
|
||||||
|
|
||||||
|
### Step 5: Greet the User
|
||||||
|
|
||||||
|
Greet `{user_name}`, speaking in `{communication_language}`. Be warm but efficient — dream builder energy.
|
||||||
|
|
||||||
|
### Step 6: Execute Append Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_append}` in order.
|
||||||
|
|
||||||
|
Activation is complete. Continue below.
|
||||||
|
|
||||||
|
## Pre-workflow Setup
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
2. **Mode detection:**
|
||||||
- `--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`.
|
- `--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`.
|
||||||
- Default: Full interactive coaching — the gauntlet.
|
- Default: Full interactive coaching — the gauntlet.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,41 @@
|
||||||
|
# DO NOT EDIT -- overwritten on every update.
|
||||||
|
#
|
||||||
|
# Workflow customization surface for bmad-prfaq. Mirrors the
|
||||||
|
# agent customization shape under the [workflow] namespace.
|
||||||
|
|
||||||
|
[workflow]
|
||||||
|
|
||||||
|
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
||||||
|
# scalars: override wins • arrays (persistent_facts, activation_steps_*): append
|
||||||
|
# arrays-of-tables with `code`/`id`: replace matching items, append new ones.
|
||||||
|
|
||||||
|
# Steps to run before the standard activation (config load, greet).
|
||||||
|
# Overrides append. Use for pre-flight loads, compliance checks, etc.
|
||||||
|
|
||||||
|
activation_steps_prepend = []
|
||||||
|
|
||||||
|
# Steps to run after greet but before the workflow begins.
|
||||||
|
# Overrides append. Use for context-heavy setup that should happen
|
||||||
|
# once the user has been acknowledged.
|
||||||
|
|
||||||
|
activation_steps_append = []
|
||||||
|
|
||||||
|
# Persistent facts the workflow keeps in mind for the whole run
|
||||||
|
# (standards, compliance constraints, stylistic guardrails).
|
||||||
|
# Distinct from the runtime memory sidecar — these are static context
|
||||||
|
# loaded on activation. Overrides append.
|
||||||
|
#
|
||||||
|
# Each entry is either:
|
||||||
|
# - a literal sentence, e.g. "All briefs must include a regulatory-risk section."
|
||||||
|
# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md"
|
||||||
|
# (glob patterns are supported; the file's contents are loaded and treated as facts).
|
||||||
|
|
||||||
|
persistent_facts = [
|
||||||
|
"file:{project-root}/**/project-context.md",
|
||||||
|
]
|
||||||
|
|
||||||
|
# Scalar: executed when the workflow reaches its terminal stage (Stage 5: The Verdict),
|
||||||
|
# after the PRFAQ and distillate have been delivered. Override wins. Leave empty for
|
||||||
|
# no custom post-completion behavior.
|
||||||
|
|
||||||
|
on_complete = ""
|
||||||
|
|
@ -77,3 +77,7 @@ purpose: "Token-efficient context for downstream PRD creation"
|
||||||
## Stage Complete
|
## Stage Complete
|
||||||
|
|
||||||
This is the terminal stage. If the user wants to revise, loop back to the relevant stage. Otherwise, the workflow is done.
|
This is the terminal stage. If the user wants to revise, loop back to the relevant stage. Otherwise, the workflow is done.
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete`
|
||||||
|
|
||||||
|
If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting.
|
||||||
|
|
|
||||||
|
|
@ -3,4 +3,94 @@ name: bmad-domain-research
|
||||||
description: 'Conduct domain and industry research. Use when the user says wants to do domain research for a topic or industry'
|
description: 'Conduct domain and industry research. Use when the user says wants to do domain research for a topic or industry'
|
||||||
---
|
---
|
||||||
|
|
||||||
Follow the instructions in ./workflow.md.
|
# Domain Research Workflow
|
||||||
|
|
||||||
|
**Goal:** Conduct comprehensive domain/industry research using current web data and verified sources to produce complete research documents with compelling narratives and proper citations.
|
||||||
|
|
||||||
|
**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.
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- Bare paths (e.g. `domain-steps/step-01-init.md`) resolve from the skill root.
|
||||||
|
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
||||||
|
- `{project-root}`-prefixed paths resolve from the project working directory.
|
||||||
|
- `{skill-name}` resolves to the skill directory's basename.
|
||||||
|
|
||||||
|
## PREREQUISITE
|
||||||
|
|
||||||
|
**⛔ Web search required.** If unavailable, abort and tell the user.
|
||||||
|
|
||||||
|
## On Activation
|
||||||
|
|
||||||
|
### Step 1: Resolve the Workflow Block
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
||||||
|
|
||||||
|
**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:
|
||||||
|
|
||||||
|
1. `{skill-root}/customize.toml` — defaults
|
||||||
|
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
||||||
|
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 2: Execute Prepend Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
||||||
|
|
||||||
|
### Step 3: Load Persistent Facts
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 4: Load Config
|
||||||
|
|
||||||
|
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||||
|
- Use `{user_name}` for greeting
|
||||||
|
- Use `{communication_language}` for all communications
|
||||||
|
- Use `{document_output_language}` for output documents
|
||||||
|
- Use `{planning_artifacts}` for output location and artifact scanning
|
||||||
|
- Use `{project_knowledge}` for additional context scanning
|
||||||
|
|
||||||
|
### Step 5: Greet the User
|
||||||
|
|
||||||
|
Greet `{user_name}`, speaking in `{communication_language}`.
|
||||||
|
|
||||||
|
### Step 6: Execute Append Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_append}` in order.
|
||||||
|
|
||||||
|
Activation is complete. Begin the workflow below.
|
||||||
|
|
||||||
|
## QUICK TOPIC DISCOVERY
|
||||||
|
|
||||||
|
"Welcome {{user_name}}! Let's get started with your **domain/industry research**.
|
||||||
|
|
||||||
|
**What domain, industry, or sector do you want to research?**
|
||||||
|
|
||||||
|
For example:
|
||||||
|
- 'The healthcare technology industry'
|
||||||
|
- 'Sustainable packaging regulations in Europe'
|
||||||
|
- 'Construction and building materials sector'
|
||||||
|
- 'Or any other domain you have in mind...'"
|
||||||
|
|
||||||
|
### Topic Clarification
|
||||||
|
|
||||||
|
Based on the user's topic, briefly clarify:
|
||||||
|
1. **Core Domain**: "What specific aspect of [domain] are you most interested in?"
|
||||||
|
2. **Research Goals**: "What do you hope to achieve with this research?"
|
||||||
|
3. **Scope**: "Should we focus broadly or dive deep into specific aspects?"
|
||||||
|
|
||||||
|
## ROUTE TO DOMAIN RESEARCH STEPS
|
||||||
|
|
||||||
|
After gathering the topic and goals:
|
||||||
|
|
||||||
|
1. Set `research_type = "domain"`
|
||||||
|
2. Set `research_topic = [discovered topic from discussion]`
|
||||||
|
3. Set `research_goals = [discovered goals from discussion]`
|
||||||
|
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`.
|
||||||
|
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
|
||||||
|
6. Load: `./domain-steps/step-01-init.md` with topic context
|
||||||
|
|
||||||
|
**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.
|
||||||
|
|
||||||
|
**✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`**
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,41 @@
|
||||||
|
# DO NOT EDIT -- overwritten on every update.
|
||||||
|
#
|
||||||
|
# Workflow customization surface for bmad-domain-research. Mirrors the
|
||||||
|
# agent customization shape under the [workflow] namespace.
|
||||||
|
|
||||||
|
[workflow]
|
||||||
|
|
||||||
|
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
||||||
|
# scalars: override wins • arrays (persistent_facts, activation_steps_*): append
|
||||||
|
# arrays-of-tables with `code`/`id`: replace matching items, append new ones.
|
||||||
|
|
||||||
|
# Steps to run before the standard activation (config load, greet).
|
||||||
|
# Overrides append. Use for pre-flight loads, compliance checks, etc.
|
||||||
|
|
||||||
|
activation_steps_prepend = []
|
||||||
|
|
||||||
|
# Steps to run after greet but before the workflow begins.
|
||||||
|
# Overrides append. Use for context-heavy setup that should happen
|
||||||
|
# once the user has been acknowledged.
|
||||||
|
|
||||||
|
activation_steps_append = []
|
||||||
|
|
||||||
|
# Persistent facts the workflow keeps in mind for the whole run
|
||||||
|
# (standards, compliance constraints, stylistic guardrails).
|
||||||
|
# Distinct from the runtime memory sidecar — these are static context
|
||||||
|
# loaded on activation. Overrides append.
|
||||||
|
#
|
||||||
|
# Each entry is either:
|
||||||
|
# - a literal sentence, e.g. "All briefs must include a regulatory-risk section."
|
||||||
|
# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md"
|
||||||
|
# (glob patterns are supported; the file's contents are loaded and treated as facts).
|
||||||
|
|
||||||
|
persistent_facts = [
|
||||||
|
"file:{project-root}/**/project-context.md",
|
||||||
|
]
|
||||||
|
|
||||||
|
# Scalar: executed when the workflow reaches its terminal stage (Step 6: Research Synthesis),
|
||||||
|
# after the domain research document has been saved and the user selects [C] Complete.
|
||||||
|
# Override wins. Leave empty for no custom post-completion behavior.
|
||||||
|
|
||||||
|
on_complete = ""
|
||||||
|
|
@ -441,4 +441,10 @@ Complete authoritative research document on {{research_topic}} that:
|
||||||
- Serves as reference document for continued use
|
- Serves as reference document for continued use
|
||||||
- Maintains highest research quality standards
|
- Maintains highest research quality standards
|
||||||
|
|
||||||
|
## On Complete
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete`
|
||||||
|
|
||||||
|
If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting.
|
||||||
|
|
||||||
Congratulations on completing comprehensive domain research! 🎉
|
Congratulations on completing comprehensive domain research! 🎉
|
||||||
|
|
|
||||||
|
|
@ -1,51 +0,0 @@
|
||||||
# Domain Research Workflow
|
|
||||||
|
|
||||||
**Goal:** Conduct comprehensive domain/industry research using current web data and verified sources to produce complete research documents with compelling narratives and proper citations.
|
|
||||||
|
|
||||||
**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.
|
|
||||||
|
|
||||||
## PREREQUISITE
|
|
||||||
|
|
||||||
**⛔ Web search required.** If unavailable, abort and tell the user.
|
|
||||||
|
|
||||||
## Activation
|
|
||||||
|
|
||||||
1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve::
|
|
||||||
- Use `{user_name}` for greeting
|
|
||||||
- Use `{communication_language}` for all communications
|
|
||||||
- Use `{document_output_language}` for output documents
|
|
||||||
- Use `{planning_artifacts}` for output location and artifact scanning
|
|
||||||
- Use `{project_knowledge}` for additional context scanning
|
|
||||||
|
|
||||||
## QUICK TOPIC DISCOVERY
|
|
||||||
|
|
||||||
"Welcome {{user_name}}! Let's get started with your **domain/industry research**.
|
|
||||||
|
|
||||||
**What domain, industry, or sector do you want to research?**
|
|
||||||
|
|
||||||
For example:
|
|
||||||
- 'The healthcare technology industry'
|
|
||||||
- 'Sustainable packaging regulations in Europe'
|
|
||||||
- 'Construction and building materials sector'
|
|
||||||
- 'Or any other domain you have in mind...'"
|
|
||||||
|
|
||||||
### Topic Clarification
|
|
||||||
|
|
||||||
Based on the user's topic, briefly clarify:
|
|
||||||
1. **Core Domain**: "What specific aspect of [domain] are you most interested in?"
|
|
||||||
2. **Research Goals**: "What do you hope to achieve with this research?"
|
|
||||||
3. **Scope**: "Should we focus broadly or dive deep into specific aspects?"
|
|
||||||
|
|
||||||
## ROUTE TO DOMAIN RESEARCH STEPS
|
|
||||||
|
|
||||||
After gathering the topic and goals:
|
|
||||||
|
|
||||||
1. Set `research_type = "domain"`
|
|
||||||
2. Set `research_topic = [discovered topic from discussion]`
|
|
||||||
3. Set `research_goals = [discovered goals from discussion]`
|
|
||||||
4. Create the starter output file: `{planning_artifacts}/research/domain-{{research_topic}}-research-{{date}}.md` with exact copy of the `./research.template.md` contents
|
|
||||||
5. Load: `./domain-steps/step-01-init.md` with topic context
|
|
||||||
|
|
||||||
**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.
|
|
||||||
|
|
||||||
**✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`**
|
|
||||||
|
|
@ -3,4 +3,94 @@ name: bmad-market-research
|
||||||
description: 'Conduct market research on competition and customers. Use when the user says they need market research'
|
description: 'Conduct market research on competition and customers. Use when the user says they need market research'
|
||||||
---
|
---
|
||||||
|
|
||||||
Follow the instructions in ./workflow.md.
|
# Market Research Workflow
|
||||||
|
|
||||||
|
**Goal:** Conduct comprehensive market research using current web data and verified sources to produce complete research documents with compelling narratives and proper citations.
|
||||||
|
|
||||||
|
**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.
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- Bare paths (e.g. `steps/step-01-init.md`) resolve from the skill root.
|
||||||
|
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
||||||
|
- `{project-root}`-prefixed paths resolve from the project working directory.
|
||||||
|
- `{skill-name}` resolves to the skill directory's basename.
|
||||||
|
|
||||||
|
## PREREQUISITE
|
||||||
|
|
||||||
|
**⛔ Web search required.** If unavailable, abort and tell the user.
|
||||||
|
|
||||||
|
## On Activation
|
||||||
|
|
||||||
|
### Step 1: Resolve the Workflow Block
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
||||||
|
|
||||||
|
**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:
|
||||||
|
|
||||||
|
1. `{skill-root}/customize.toml` — defaults
|
||||||
|
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
||||||
|
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 2: Execute Prepend Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
||||||
|
|
||||||
|
### Step 3: Load Persistent Facts
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 4: Load Config
|
||||||
|
|
||||||
|
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||||
|
- Use `{user_name}` for greeting
|
||||||
|
- Use `{communication_language}` for all communications
|
||||||
|
- Use `{document_output_language}` for output documents
|
||||||
|
- Use `{planning_artifacts}` for output location and artifact scanning
|
||||||
|
- Use `{project_knowledge}` for additional context scanning
|
||||||
|
|
||||||
|
### Step 5: Greet the User
|
||||||
|
|
||||||
|
Greet `{user_name}`, speaking in `{communication_language}`.
|
||||||
|
|
||||||
|
### Step 6: Execute Append Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_append}` in order.
|
||||||
|
|
||||||
|
Activation is complete. Begin the workflow below.
|
||||||
|
|
||||||
|
## QUICK TOPIC DISCOVERY
|
||||||
|
|
||||||
|
"Welcome {{user_name}}! Let's get started with your **market research**.
|
||||||
|
|
||||||
|
**What topic, problem, or area do you want to research?**
|
||||||
|
|
||||||
|
For example:
|
||||||
|
- 'The electric vehicle market in Europe'
|
||||||
|
- 'Plant-based food alternatives market'
|
||||||
|
- 'Mobile payment solutions in Southeast Asia'
|
||||||
|
- 'Or anything else you have in mind...'"
|
||||||
|
|
||||||
|
### Topic Clarification
|
||||||
|
|
||||||
|
Based on the user's topic, briefly clarify:
|
||||||
|
1. **Core Topic**: "What exactly about [topic] are you most interested in?"
|
||||||
|
2. **Research Goals**: "What do you hope to achieve with this research?"
|
||||||
|
3. **Scope**: "Should we focus broadly or dive deep into specific aspects?"
|
||||||
|
|
||||||
|
## ROUTE TO MARKET RESEARCH STEPS
|
||||||
|
|
||||||
|
After gathering the topic and goals:
|
||||||
|
|
||||||
|
1. Set `research_type = "market"`
|
||||||
|
2. Set `research_topic = [discovered topic from discussion]`
|
||||||
|
3. Set `research_goals = [discovered goals from discussion]`
|
||||||
|
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`.
|
||||||
|
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
|
||||||
|
6. Load: `./steps/step-01-init.md` with topic context
|
||||||
|
|
||||||
|
**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.
|
||||||
|
|
||||||
|
**✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`**
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,41 @@
|
||||||
|
# DO NOT EDIT -- overwritten on every update.
|
||||||
|
#
|
||||||
|
# Workflow customization surface for bmad-market-research. Mirrors the
|
||||||
|
# agent customization shape under the [workflow] namespace.
|
||||||
|
|
||||||
|
[workflow]
|
||||||
|
|
||||||
|
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
||||||
|
# scalars: override wins • arrays (persistent_facts, activation_steps_*): append
|
||||||
|
# arrays-of-tables with `code`/`id`: replace matching items, append new ones.
|
||||||
|
|
||||||
|
# Steps to run before the standard activation (config load, greet).
|
||||||
|
# Overrides append. Use for pre-flight loads, compliance checks, etc.
|
||||||
|
|
||||||
|
activation_steps_prepend = []
|
||||||
|
|
||||||
|
# Steps to run after greet but before the workflow begins.
|
||||||
|
# Overrides append. Use for context-heavy setup that should happen
|
||||||
|
# once the user has been acknowledged.
|
||||||
|
|
||||||
|
activation_steps_append = []
|
||||||
|
|
||||||
|
# Persistent facts the workflow keeps in mind for the whole run
|
||||||
|
# (standards, compliance constraints, stylistic guardrails).
|
||||||
|
# Distinct from the runtime memory sidecar — these are static context
|
||||||
|
# loaded on activation. Overrides append.
|
||||||
|
#
|
||||||
|
# Each entry is either:
|
||||||
|
# - a literal sentence, e.g. "All briefs must include a regulatory-risk section."
|
||||||
|
# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md"
|
||||||
|
# (glob patterns are supported; the file's contents are loaded and treated as facts).
|
||||||
|
|
||||||
|
persistent_facts = [
|
||||||
|
"file:{project-root}/**/project-context.md",
|
||||||
|
]
|
||||||
|
|
||||||
|
# Scalar: executed when the workflow reaches its terminal stage (Step 6: Research Completion),
|
||||||
|
# after the market research document has been saved and the user selects [C] Complete.
|
||||||
|
# Override wins. Leave empty for no custom post-completion behavior.
|
||||||
|
|
||||||
|
on_complete = ""
|
||||||
|
|
@ -475,4 +475,10 @@ Comprehensive market research workflow complete. User may:
|
||||||
- Combine market research with other research types for comprehensive insights
|
- Combine market research with other research types for comprehensive insights
|
||||||
- Move forward with implementation based on strategic market recommendations
|
- Move forward with implementation based on strategic market recommendations
|
||||||
|
|
||||||
|
## On Complete
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete`
|
||||||
|
|
||||||
|
If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting.
|
||||||
|
|
||||||
Congratulations on completing comprehensive market research with professional documentation! 🎉
|
Congratulations on completing comprehensive market research with professional documentation! 🎉
|
||||||
|
|
|
||||||
|
|
@ -1,51 +0,0 @@
|
||||||
# Market Research Workflow
|
|
||||||
|
|
||||||
**Goal:** Conduct comprehensive market research using current web data and verified sources to produce complete research documents with compelling narratives and proper citations.
|
|
||||||
|
|
||||||
**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.
|
|
||||||
|
|
||||||
## PREREQUISITE
|
|
||||||
|
|
||||||
**⛔ Web search required.** If unavailable, abort and tell the user.
|
|
||||||
|
|
||||||
## Activation
|
|
||||||
|
|
||||||
1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve::
|
|
||||||
- Use `{user_name}` for greeting
|
|
||||||
- Use `{communication_language}` for all communications
|
|
||||||
- Use `{document_output_language}` for output documents
|
|
||||||
- Use `{planning_artifacts}` for output location and artifact scanning
|
|
||||||
- Use `{project_knowledge}` for additional context scanning
|
|
||||||
|
|
||||||
## QUICK TOPIC DISCOVERY
|
|
||||||
|
|
||||||
"Welcome {{user_name}}! Let's get started with your **market research**.
|
|
||||||
|
|
||||||
**What topic, problem, or area do you want to research?**
|
|
||||||
|
|
||||||
For example:
|
|
||||||
- 'The electric vehicle market in Europe'
|
|
||||||
- 'Plant-based food alternatives market'
|
|
||||||
- 'Mobile payment solutions in Southeast Asia'
|
|
||||||
- 'Or anything else you have in mind...'"
|
|
||||||
|
|
||||||
### Topic Clarification
|
|
||||||
|
|
||||||
Based on the user's topic, briefly clarify:
|
|
||||||
1. **Core Topic**: "What exactly about [topic] are you most interested in?"
|
|
||||||
2. **Research Goals**: "What do you hope to achieve with this research?"
|
|
||||||
3. **Scope**: "Should we focus broadly or dive deep into specific aspects?"
|
|
||||||
|
|
||||||
## ROUTE TO MARKET RESEARCH STEPS
|
|
||||||
|
|
||||||
After gathering the topic and goals:
|
|
||||||
|
|
||||||
1. Set `research_type = "market"`
|
|
||||||
2. Set `research_topic = [discovered topic from discussion]`
|
|
||||||
3. Set `research_goals = [discovered goals from discussion]`
|
|
||||||
4. Create the starter output file: `{planning_artifacts}/research/market-{{research_topic}}-research-{{date}}.md` with exact copy of the `./research.template.md` contents
|
|
||||||
5. Load: `./steps/step-01-init.md` with topic context
|
|
||||||
|
|
||||||
**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.
|
|
||||||
|
|
||||||
**✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`**
|
|
||||||
|
|
@ -3,4 +3,94 @@ name: bmad-technical-research
|
||||||
description: 'Conduct technical research on technologies and architecture. Use when the user says they would like to do or produce a technical research report'
|
description: 'Conduct technical research on technologies and architecture. Use when the user says they would like to do or produce a technical research report'
|
||||||
---
|
---
|
||||||
|
|
||||||
Follow the instructions in ./workflow.md.
|
# Technical Research Workflow
|
||||||
|
|
||||||
|
**Goal:** Conduct comprehensive technical research using current web data and verified sources to produce complete research documents with compelling narratives and proper citations.
|
||||||
|
|
||||||
|
**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.
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- Bare paths (e.g. `technical-steps/step-01-init.md`) resolve from the skill root.
|
||||||
|
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
||||||
|
- `{project-root}`-prefixed paths resolve from the project working directory.
|
||||||
|
- `{skill-name}` resolves to the skill directory's basename.
|
||||||
|
|
||||||
|
## PREREQUISITE
|
||||||
|
|
||||||
|
**⛔ Web search required.** If unavailable, abort and tell the user.
|
||||||
|
|
||||||
|
## On Activation
|
||||||
|
|
||||||
|
### Step 1: Resolve the Workflow Block
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
||||||
|
|
||||||
|
**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:
|
||||||
|
|
||||||
|
1. `{skill-root}/customize.toml` — defaults
|
||||||
|
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
||||||
|
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 2: Execute Prepend Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
||||||
|
|
||||||
|
### Step 3: Load Persistent Facts
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 4: Load Config
|
||||||
|
|
||||||
|
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||||
|
- Use `{user_name}` for greeting
|
||||||
|
- Use `{communication_language}` for all communications
|
||||||
|
- Use `{document_output_language}` for output documents
|
||||||
|
- Use `{planning_artifacts}` for output location and artifact scanning
|
||||||
|
- Use `{project_knowledge}` for additional context scanning
|
||||||
|
|
||||||
|
### Step 5: Greet the User
|
||||||
|
|
||||||
|
Greet `{user_name}`, speaking in `{communication_language}`.
|
||||||
|
|
||||||
|
### Step 6: Execute Append Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_append}` in order.
|
||||||
|
|
||||||
|
Activation is complete. Begin the workflow below.
|
||||||
|
|
||||||
|
## QUICK TOPIC DISCOVERY
|
||||||
|
|
||||||
|
"Welcome {{user_name}}! Let's get started with your **technical research**.
|
||||||
|
|
||||||
|
**What technology, tool, or technical area do you want to research?**
|
||||||
|
|
||||||
|
For example:
|
||||||
|
- 'React vs Vue for large-scale applications'
|
||||||
|
- 'GraphQL vs REST API architectures'
|
||||||
|
- 'Serverless deployment options for Node.js'
|
||||||
|
- 'Or any other technical topic you have in mind...'"
|
||||||
|
|
||||||
|
### Topic Clarification
|
||||||
|
|
||||||
|
Based on the user's topic, briefly clarify:
|
||||||
|
1. **Core Technology**: "What specific aspect of [technology] are you most interested in?"
|
||||||
|
2. **Research Goals**: "What do you hope to achieve with this research?"
|
||||||
|
3. **Scope**: "Should we focus broadly or dive deep into specific aspects?"
|
||||||
|
|
||||||
|
## ROUTE TO TECHNICAL RESEARCH STEPS
|
||||||
|
|
||||||
|
After gathering the topic and goals:
|
||||||
|
|
||||||
|
1. Set `research_type = "technical"`
|
||||||
|
2. Set `research_topic = [discovered topic from discussion]`
|
||||||
|
3. Set `research_goals = [discovered goals from discussion]`
|
||||||
|
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`.
|
||||||
|
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
|
||||||
|
6. Load: `./technical-steps/step-01-init.md` with topic context
|
||||||
|
|
||||||
|
**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.
|
||||||
|
|
||||||
|
**✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`**
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,41 @@
|
||||||
|
# DO NOT EDIT -- overwritten on every update.
|
||||||
|
#
|
||||||
|
# Workflow customization surface for bmad-technical-research. Mirrors the
|
||||||
|
# agent customization shape under the [workflow] namespace.
|
||||||
|
|
||||||
|
[workflow]
|
||||||
|
|
||||||
|
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
||||||
|
# scalars: override wins • arrays (persistent_facts, activation_steps_*): append
|
||||||
|
# arrays-of-tables with `code`/`id`: replace matching items, append new ones.
|
||||||
|
|
||||||
|
# Steps to run before the standard activation (config load, greet).
|
||||||
|
# Overrides append. Use for pre-flight loads, compliance checks, etc.
|
||||||
|
|
||||||
|
activation_steps_prepend = []
|
||||||
|
|
||||||
|
# Steps to run after greet but before the workflow begins.
|
||||||
|
# Overrides append. Use for context-heavy setup that should happen
|
||||||
|
# once the user has been acknowledged.
|
||||||
|
|
||||||
|
activation_steps_append = []
|
||||||
|
|
||||||
|
# Persistent facts the workflow keeps in mind for the whole run
|
||||||
|
# (standards, compliance constraints, stylistic guardrails).
|
||||||
|
# Distinct from the runtime memory sidecar — these are static context
|
||||||
|
# loaded on activation. Overrides append.
|
||||||
|
#
|
||||||
|
# Each entry is either:
|
||||||
|
# - a literal sentence, e.g. "All briefs must include a regulatory-risk section."
|
||||||
|
# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md"
|
||||||
|
# (glob patterns are supported; the file's contents are loaded and treated as facts).
|
||||||
|
|
||||||
|
persistent_facts = [
|
||||||
|
"file:{project-root}/**/project-context.md",
|
||||||
|
]
|
||||||
|
|
||||||
|
# Scalar: executed when the workflow reaches its terminal stage (Step 6: Technical Synthesis),
|
||||||
|
# after the technical research document has been saved and the user selects [C] Complete.
|
||||||
|
# Override wins. Leave empty for no custom post-completion behavior.
|
||||||
|
|
||||||
|
on_complete = ""
|
||||||
|
|
@ -484,4 +484,10 @@ Complete authoritative technical research document on {{research_topic}} that:
|
||||||
- Serves as technical reference document for continued use
|
- Serves as technical reference document for continued use
|
||||||
- Maintains highest technical research quality standards with current verification
|
- Maintains highest technical research quality standards with current verification
|
||||||
|
|
||||||
|
## On Complete
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete`
|
||||||
|
|
||||||
|
If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting.
|
||||||
|
|
||||||
Congratulations on completing comprehensive technical research with professional documentation! 🎉
|
Congratulations on completing comprehensive technical research with professional documentation! 🎉
|
||||||
|
|
|
||||||
|
|
@ -1,52 +0,0 @@
|
||||||
|
|
||||||
# Technical Research Workflow
|
|
||||||
|
|
||||||
**Goal:** Conduct comprehensive technical research using current web data and verified sources to produce complete research documents with compelling narratives and proper citations.
|
|
||||||
|
|
||||||
**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.
|
|
||||||
|
|
||||||
## PREREQUISITE
|
|
||||||
|
|
||||||
**⛔ Web search required.** If unavailable, abort and tell the user.
|
|
||||||
|
|
||||||
## Activation
|
|
||||||
|
|
||||||
1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve::
|
|
||||||
- Use `{user_name}` for greeting
|
|
||||||
- Use `{communication_language}` for all communications
|
|
||||||
- Use `{document_output_language}` for output documents
|
|
||||||
- Use `{planning_artifacts}` for output location and artifact scanning
|
|
||||||
- Use `{project_knowledge}` for additional context scanning
|
|
||||||
|
|
||||||
## QUICK TOPIC DISCOVERY
|
|
||||||
|
|
||||||
"Welcome {{user_name}}! Let's get started with your **technical research**.
|
|
||||||
|
|
||||||
**What technology, tool, or technical area do you want to research?**
|
|
||||||
|
|
||||||
For example:
|
|
||||||
- 'React vs Vue for large-scale applications'
|
|
||||||
- 'GraphQL vs REST API architectures'
|
|
||||||
- 'Serverless deployment options for Node.js'
|
|
||||||
- 'Or any other technical topic you have in mind...'"
|
|
||||||
|
|
||||||
### Topic Clarification
|
|
||||||
|
|
||||||
Based on the user's topic, briefly clarify:
|
|
||||||
1. **Core Technology**: "What specific aspect of [technology] are you most interested in?"
|
|
||||||
2. **Research Goals**: "What do you hope to achieve with this research?"
|
|
||||||
3. **Scope**: "Should we focus broadly or dive deep into specific aspects?"
|
|
||||||
|
|
||||||
## ROUTE TO TECHNICAL RESEARCH STEPS
|
|
||||||
|
|
||||||
After gathering the topic and goals:
|
|
||||||
|
|
||||||
1. Set `research_type = "technical"`
|
|
||||||
2. Set `research_topic = [discovered topic from discussion]`
|
|
||||||
3. Set `research_goals = [discovered goals from discussion]`
|
|
||||||
4. Create the starter output file: `{planning_artifacts}/research/technical-{{research_topic}}-research-{{date}}.md` with exact copy of the `./research.template.md` contents
|
|
||||||
5. Load: `./technical-steps/step-01-init.md` with topic context
|
|
||||||
|
|
||||||
**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.
|
|
||||||
|
|
||||||
**✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`**
|
|
||||||
|
|
@ -3,4 +3,102 @@ name: bmad-create-prd
|
||||||
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"'
|
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"'
|
||||||
---
|
---
|
||||||
|
|
||||||
Follow the instructions in ./workflow.md.
|
# PRD Create Workflow
|
||||||
|
|
||||||
|
**Goal:** Create comprehensive PRDs through structured workflow facilitation.
|
||||||
|
|
||||||
|
**Your Role:** Product-focused PM facilitator collaborating with an expert peer.
|
||||||
|
|
||||||
|
You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description.
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- Bare paths (e.g. `steps-c/step-01-init.md`) resolve from the skill root.
|
||||||
|
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
||||||
|
- `{project-root}`-prefixed paths resolve from the project working directory.
|
||||||
|
- `{skill-name}` resolves to the skill directory's basename.
|
||||||
|
|
||||||
|
## WORKFLOW ARCHITECTURE
|
||||||
|
|
||||||
|
This uses **step-file architecture** for disciplined execution:
|
||||||
|
|
||||||
|
### Core Principles
|
||||||
|
|
||||||
|
- **Micro-file Design**: Each step is a self-contained instruction file that is a part of an overall workflow that must be followed exactly
|
||||||
|
- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so
|
||||||
|
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
|
||||||
|
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
|
||||||
|
- **Append-Only Building**: Build documents by appending content as directed to the output file
|
||||||
|
|
||||||
|
### Step Processing Rules
|
||||||
|
|
||||||
|
1. **READ COMPLETELY**: Always read the entire step file before taking any action
|
||||||
|
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
|
||||||
|
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
|
||||||
|
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
|
||||||
|
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
|
||||||
|
6. **LOAD NEXT**: When directed, read fully and follow the next step file
|
||||||
|
|
||||||
|
### Critical Rules (NO EXCEPTIONS)
|
||||||
|
|
||||||
|
- 🛑 **NEVER** load multiple step files simultaneously
|
||||||
|
- 📖 **ALWAYS** read entire step file before execution
|
||||||
|
- 🚫 **NEVER** skip steps or optimize the sequence
|
||||||
|
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
|
||||||
|
- 🎯 **ALWAYS** follow the exact instructions in the step file
|
||||||
|
- ⏸️ **ALWAYS** halt at menus and wait for user input
|
||||||
|
- 📋 **NEVER** create mental todo lists from future steps
|
||||||
|
|
||||||
|
## On Activation
|
||||||
|
|
||||||
|
### Step 1: Resolve the Workflow Block
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
||||||
|
|
||||||
|
**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:
|
||||||
|
|
||||||
|
1. `{skill-root}/customize.toml` — defaults
|
||||||
|
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
||||||
|
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 2: Execute Prepend Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
||||||
|
|
||||||
|
### Step 3: Load Persistent Facts
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 4: Load Config
|
||||||
|
|
||||||
|
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||||
|
- Use `{user_name}` for greeting
|
||||||
|
- Use `{communication_language}` for all communications
|
||||||
|
- Use `{document_output_language}` for output documents
|
||||||
|
- Use `{planning_artifacts}` for output location and artifact scanning
|
||||||
|
- Use `{project_knowledge}` for additional context scanning
|
||||||
|
|
||||||
|
### Step 5: Greet the User
|
||||||
|
|
||||||
|
Greet `{user_name}`, speaking in `{communication_language}`.
|
||||||
|
|
||||||
|
### Step 6: Execute Append Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_append}` in order.
|
||||||
|
|
||||||
|
Activation is complete. Begin the workflow below.
|
||||||
|
|
||||||
|
## Paths
|
||||||
|
|
||||||
|
- `outputFile` = `{planning_artifacts}/prd.md`
|
||||||
|
|
||||||
|
## Execution
|
||||||
|
|
||||||
|
✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the configured `{communication_language}`.
|
||||||
|
✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`.
|
||||||
|
|
||||||
|
**Create Mode: Creating a new PRD from scratch.**
|
||||||
|
|
||||||
|
Read fully and follow: `./steps-c/step-01-init.md`
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,41 @@
|
||||||
|
# DO NOT EDIT -- overwritten on every update.
|
||||||
|
#
|
||||||
|
# Workflow customization surface for bmad-create-prd. Mirrors the
|
||||||
|
# agent customization shape under the [workflow] namespace.
|
||||||
|
|
||||||
|
[workflow]
|
||||||
|
|
||||||
|
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
||||||
|
# scalars: override wins • arrays (persistent_facts, activation_steps_*): append
|
||||||
|
# arrays-of-tables with `code`/`id`: replace matching items, append new ones.
|
||||||
|
|
||||||
|
# Steps to run before the standard activation (config load, greet).
|
||||||
|
# Overrides append. Use for pre-flight loads, compliance checks, etc.
|
||||||
|
|
||||||
|
activation_steps_prepend = []
|
||||||
|
|
||||||
|
# Steps to run after greet but before the workflow begins.
|
||||||
|
# Overrides append. Use for context-heavy setup that should happen
|
||||||
|
# once the user has been acknowledged.
|
||||||
|
|
||||||
|
activation_steps_append = []
|
||||||
|
|
||||||
|
# Persistent facts the workflow keeps in mind for the whole run
|
||||||
|
# (standards, compliance constraints, stylistic guardrails).
|
||||||
|
# Distinct from the runtime memory sidecar — these are static context
|
||||||
|
# loaded on activation. Overrides append.
|
||||||
|
#
|
||||||
|
# Each entry is either:
|
||||||
|
# - a literal sentence, e.g. "All PRDs must include a regulatory-risk section."
|
||||||
|
# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md"
|
||||||
|
# (glob patterns are supported; the file's contents are loaded and treated as facts).
|
||||||
|
|
||||||
|
persistent_facts = [
|
||||||
|
"file:{project-root}/**/project-context.md",
|
||||||
|
]
|
||||||
|
|
||||||
|
# Scalar: executed when the workflow reaches Step 12 (Workflow Completion),
|
||||||
|
# after the PRD is finalized and workflow status is updated. Override wins.
|
||||||
|
# Leave empty for no custom post-completion behavior.
|
||||||
|
|
||||||
|
on_complete = ""
|
||||||
|
|
@ -113,3 +113,9 @@ PRD complete. Invoke the `bmad-help` skill.
|
||||||
The polished PRD serves as the foundation for all subsequent product development activities. All design, architecture, and development work should trace back to the requirements and vision documented in this PRD - update it also as needed as you continue planning.
|
The polished PRD serves as the foundation for all subsequent product development activities. All design, architecture, and development work should trace back to the requirements and vision documented in this PRD - update it also as needed as you continue planning.
|
||||||
|
|
||||||
**Congratulations on completing the Product Requirements Document for {{project_name}}!** 🎉
|
**Congratulations on completing the Product Requirements Document for {{project_name}}!** 🎉
|
||||||
|
|
||||||
|
## On Complete
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete`
|
||||||
|
|
||||||
|
If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting.
|
||||||
|
|
|
||||||
|
|
@ -1,61 +0,0 @@
|
||||||
---
|
|
||||||
main_config: '{project-root}/_bmad/bmm/config.yaml'
|
|
||||||
outputFile: '{planning_artifacts}/prd.md'
|
|
||||||
---
|
|
||||||
|
|
||||||
# PRD Create Workflow
|
|
||||||
|
|
||||||
**Goal:** Create comprehensive PRDs through structured workflow facilitation.
|
|
||||||
|
|
||||||
**Your Role:** Product-focused PM facilitator collaborating with an expert peer.
|
|
||||||
|
|
||||||
You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description.
|
|
||||||
|
|
||||||
## WORKFLOW ARCHITECTURE
|
|
||||||
|
|
||||||
This uses **step-file architecture** for disciplined execution:
|
|
||||||
|
|
||||||
### Core Principles
|
|
||||||
|
|
||||||
- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly
|
|
||||||
- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so
|
|
||||||
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
|
|
||||||
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
|
|
||||||
- **Append-Only Building**: Build documents by appending content as directed to the output file
|
|
||||||
|
|
||||||
### Step Processing Rules
|
|
||||||
|
|
||||||
1. **READ COMPLETELY**: Always read the entire step file before taking any action
|
|
||||||
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
|
|
||||||
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
|
|
||||||
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
|
|
||||||
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
|
|
||||||
6. **LOAD NEXT**: When directed, read fully and follow the next step file
|
|
||||||
|
|
||||||
### Critical Rules (NO EXCEPTIONS)
|
|
||||||
|
|
||||||
- 🛑 **NEVER** load multiple step files simultaneously
|
|
||||||
- 📖 **ALWAYS** read entire step file before execution
|
|
||||||
- 🚫 **NEVER** skip steps or optimize the sequence
|
|
||||||
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
|
|
||||||
- 🎯 **ALWAYS** follow the exact instructions in the step file
|
|
||||||
- ⏸️ **ALWAYS** halt at menus and wait for user input
|
|
||||||
- 📋 **NEVER** create mental todo lists from future steps
|
|
||||||
|
|
||||||
## Activation
|
|
||||||
|
|
||||||
1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve::
|
|
||||||
- Use `{user_name}` for greeting
|
|
||||||
- Use `{communication_language}` for all communications
|
|
||||||
- Use `{document_output_language}` for output documents
|
|
||||||
- Use `{planning_artifacts}` for output location and artifact scanning
|
|
||||||
- Use `{project_knowledge}` for additional context scanning
|
|
||||||
|
|
||||||
✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the configured `{communication_language}`.
|
|
||||||
✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`.
|
|
||||||
|
|
||||||
2. Route to Create Workflow
|
|
||||||
|
|
||||||
"**Create Mode: Creating a new PRD from scratch.**"
|
|
||||||
|
|
||||||
Read fully and follow: `./steps-c/step-01-init.md`
|
|
||||||
|
|
@ -3,4 +3,73 @@ name: bmad-create-ux-design
|
||||||
description: 'Plan UX patterns and design specifications. Use when the user says "lets create UX design" or "create UX specifications" or "help me plan the UX"'
|
description: 'Plan UX patterns and design specifications. Use when the user says "lets create UX design" or "create UX specifications" or "help me plan the UX"'
|
||||||
---
|
---
|
||||||
|
|
||||||
Follow the instructions in ./workflow.md.
|
# Create UX Design Workflow
|
||||||
|
|
||||||
|
**Goal:** Create comprehensive UX design specifications through collaborative visual exploration and informed decision-making where you act as a UX facilitator working with a product stakeholder.
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- Bare paths (e.g. `steps/step-01-init.md`) resolve from the skill root.
|
||||||
|
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
||||||
|
- `{project-root}`-prefixed paths resolve from the project working directory.
|
||||||
|
- `{skill-name}` resolves to the skill directory's basename.
|
||||||
|
|
||||||
|
## WORKFLOW ARCHITECTURE
|
||||||
|
|
||||||
|
This uses **micro-file architecture** for disciplined execution:
|
||||||
|
|
||||||
|
- Each step is a self-contained file with embedded rules
|
||||||
|
- Sequential progression with user control at each step
|
||||||
|
- Document state tracked in frontmatter
|
||||||
|
- Append-only document building through conversation
|
||||||
|
|
||||||
|
## On Activation
|
||||||
|
|
||||||
|
### Step 1: Resolve the Workflow Block
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
||||||
|
|
||||||
|
**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:
|
||||||
|
|
||||||
|
1. `{skill-root}/customize.toml` — defaults
|
||||||
|
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
||||||
|
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 2: Execute Prepend Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
||||||
|
|
||||||
|
### Step 3: Load Persistent Facts
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 4: Load Config
|
||||||
|
|
||||||
|
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||||
|
- Use `{user_name}` for greeting
|
||||||
|
- Use `{communication_language}` for all communications
|
||||||
|
- Use `{document_output_language}` for output documents
|
||||||
|
- Use `{planning_artifacts}` for output location and artifact scanning
|
||||||
|
- Use `{project_knowledge}` for additional context scanning
|
||||||
|
|
||||||
|
### Step 5: Greet the User
|
||||||
|
|
||||||
|
Greet `{user_name}`, speaking in `{communication_language}`.
|
||||||
|
|
||||||
|
### Step 6: Execute Append Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_append}` in order.
|
||||||
|
|
||||||
|
Activation is complete. Begin the workflow below.
|
||||||
|
|
||||||
|
## Paths
|
||||||
|
|
||||||
|
- `default_output_file` = `{planning_artifacts}/ux-design-specification.md`
|
||||||
|
|
||||||
|
## EXECUTION
|
||||||
|
|
||||||
|
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||||
|
- ✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`
|
||||||
|
- Read fully and follow: `./steps/step-01-init.md` to begin the UX design workflow.
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,41 @@
|
||||||
|
# DO NOT EDIT -- overwritten on every update.
|
||||||
|
#
|
||||||
|
# Workflow customization surface for bmad-create-ux-design. Mirrors the
|
||||||
|
# agent customization shape under the [workflow] namespace.
|
||||||
|
|
||||||
|
[workflow]
|
||||||
|
|
||||||
|
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
||||||
|
# scalars: override wins • arrays (persistent_facts, activation_steps_*): append
|
||||||
|
# arrays-of-tables with `code`/`id`: replace matching items, append new ones.
|
||||||
|
|
||||||
|
# Steps to run before the standard activation (config load, greet).
|
||||||
|
# Overrides append. Use for pre-flight loads, compliance checks, etc.
|
||||||
|
|
||||||
|
activation_steps_prepend = []
|
||||||
|
|
||||||
|
# Steps to run after greet but before the workflow begins.
|
||||||
|
# Overrides append. Use for context-heavy setup that should happen
|
||||||
|
# once the user has been acknowledged.
|
||||||
|
|
||||||
|
activation_steps_append = []
|
||||||
|
|
||||||
|
# Persistent facts the workflow keeps in mind for the whole run
|
||||||
|
# (standards, compliance constraints, stylistic guardrails).
|
||||||
|
# Distinct from the runtime memory sidecar — these are static context
|
||||||
|
# loaded on activation. Overrides append.
|
||||||
|
#
|
||||||
|
# Each entry is either:
|
||||||
|
# - a literal sentence, e.g. "All designs must meet WCAG 2.1 AA accessibility standards."
|
||||||
|
# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md"
|
||||||
|
# (glob patterns are supported; the file's contents are loaded and treated as facts).
|
||||||
|
|
||||||
|
persistent_facts = [
|
||||||
|
"file:{project-root}/**/project-context.md",
|
||||||
|
]
|
||||||
|
|
||||||
|
# Scalar: executed when the workflow reaches Step 14 (Workflow Completion),
|
||||||
|
# after the UX design specification is finalized and status is updated. Override wins.
|
||||||
|
# Leave empty for no custom post-completion behavior.
|
||||||
|
|
||||||
|
on_complete = ""
|
||||||
|
|
@ -169,3 +169,9 @@ This UX design workflow is now complete. The specification serves as the foundat
|
||||||
- ✅ UX Design Specification: `{planning_artifacts}/ux-design-specification.md`
|
- ✅ UX Design Specification: `{planning_artifacts}/ux-design-specification.md`
|
||||||
- ✅ Color Themes Visualizer: `{planning_artifacts}/ux-color-themes.html`
|
- ✅ Color Themes Visualizer: `{planning_artifacts}/ux-color-themes.html`
|
||||||
- ✅ Design Directions: `{planning_artifacts}/ux-design-directions.html`
|
- ✅ Design Directions: `{planning_artifacts}/ux-design-directions.html`
|
||||||
|
|
||||||
|
## On Complete
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete`
|
||||||
|
|
||||||
|
If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting.
|
||||||
|
|
|
||||||
|
|
@ -1,35 +0,0 @@
|
||||||
# Create UX Design Workflow
|
|
||||||
|
|
||||||
**Goal:** Create comprehensive UX design specifications through collaborative visual exploration and informed decision-making where you act as a UX facilitator working with a product stakeholder.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## WORKFLOW ARCHITECTURE
|
|
||||||
|
|
||||||
This uses **micro-file architecture** for disciplined execution:
|
|
||||||
|
|
||||||
- Each step is a self-contained file with embedded rules
|
|
||||||
- Sequential progression with user control at each step
|
|
||||||
- Document state tracked in frontmatter
|
|
||||||
- Append-only document building through conversation
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Activation
|
|
||||||
|
|
||||||
1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve::
|
|
||||||
- Use `{user_name}` for greeting
|
|
||||||
- Use `{communication_language}` for all communications
|
|
||||||
- Use `{document_output_language}` for output documents
|
|
||||||
- Use `{planning_artifacts}` for output location and artifact scanning
|
|
||||||
- Use `{project_knowledge}` for additional context scanning
|
|
||||||
|
|
||||||
### Paths
|
|
||||||
|
|
||||||
- `default_output_file` = `{planning_artifacts}/ux-design-specification.md`
|
|
||||||
|
|
||||||
## EXECUTION
|
|
||||||
|
|
||||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
|
||||||
- ✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`
|
|
||||||
- Read fully and follow: `./steps/step-01-init.md` to begin the UX design workflow.
|
|
||||||
|
|
@ -3,4 +3,100 @@ name: bmad-edit-prd
|
||||||
description: 'Edit an existing PRD. Use when the user says "edit this PRD".'
|
description: 'Edit an existing PRD. Use when the user says "edit this PRD".'
|
||||||
---
|
---
|
||||||
|
|
||||||
Follow the instructions in ./workflow.md.
|
# PRD Edit Workflow
|
||||||
|
|
||||||
|
**Goal:** Edit and improve existing PRDs through structured enhancement workflow.
|
||||||
|
|
||||||
|
**Your Role:** PRD improvement specialist.
|
||||||
|
|
||||||
|
You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description.
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- Bare paths (e.g. `steps-e/step-e-01-discovery.md`) resolve from the skill root.
|
||||||
|
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
||||||
|
- `{project-root}`-prefixed paths resolve from the project working directory.
|
||||||
|
- `{skill-name}` resolves to the skill directory's basename.
|
||||||
|
|
||||||
|
## WORKFLOW ARCHITECTURE
|
||||||
|
|
||||||
|
This uses **step-file architecture** for disciplined execution:
|
||||||
|
|
||||||
|
### Core Principles
|
||||||
|
|
||||||
|
- **Micro-file Design**: Each step is a self-contained instruction file that is a part of an overall workflow that must be followed exactly
|
||||||
|
- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so
|
||||||
|
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
|
||||||
|
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
|
||||||
|
- **Append-Only Building**: Build documents by appending content as directed to the output file
|
||||||
|
|
||||||
|
### Step Processing Rules
|
||||||
|
|
||||||
|
1. **READ COMPLETELY**: Always read the entire step file before taking any action
|
||||||
|
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
|
||||||
|
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
|
||||||
|
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
|
||||||
|
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
|
||||||
|
6. **LOAD NEXT**: When directed, read fully and follow the next step file
|
||||||
|
|
||||||
|
### Critical Rules (NO EXCEPTIONS)
|
||||||
|
|
||||||
|
- 🛑 **NEVER** load multiple step files simultaneously
|
||||||
|
- 📖 **ALWAYS** read entire step file before execution
|
||||||
|
- 🚫 **NEVER** skip steps or optimize the sequence
|
||||||
|
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
|
||||||
|
- 🎯 **ALWAYS** follow the exact instructions in the step file
|
||||||
|
- ⏸️ **ALWAYS** halt at menus and wait for user input
|
||||||
|
- 📋 **NEVER** create mental todo lists from future steps
|
||||||
|
|
||||||
|
## On Activation
|
||||||
|
|
||||||
|
### Step 1: Resolve the Workflow Block
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
||||||
|
|
||||||
|
**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:
|
||||||
|
|
||||||
|
1. `{skill-root}/customize.toml` — defaults
|
||||||
|
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
||||||
|
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 2: Execute Prepend Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
||||||
|
|
||||||
|
### Step 3: Load Persistent Facts
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 4: Load Config
|
||||||
|
|
||||||
|
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||||
|
- Use `{user_name}` for greeting
|
||||||
|
- Use `{communication_language}` for all communications
|
||||||
|
- Use `{document_output_language}` for output documents
|
||||||
|
- Use `{planning_artifacts}` for output location and artifact scanning
|
||||||
|
- Use `{project_knowledge}` for additional context scanning
|
||||||
|
|
||||||
|
### Step 5: Greet the User
|
||||||
|
|
||||||
|
Greet `{user_name}`, speaking in `{communication_language}`.
|
||||||
|
|
||||||
|
### Step 6: Execute Append Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_append}` in order.
|
||||||
|
|
||||||
|
Activation is complete. Begin the workflow below.
|
||||||
|
|
||||||
|
## Execution
|
||||||
|
|
||||||
|
✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the configured `{communication_language}`.
|
||||||
|
✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`.
|
||||||
|
|
||||||
|
**Edit Mode: Improving an existing PRD.**
|
||||||
|
|
||||||
|
Prompt for PRD path: "Which PRD would you like to edit? Please provide the path to the PRD.md file."
|
||||||
|
|
||||||
|
Then read fully and follow: `./steps-e/step-e-01-discovery.md`
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,42 @@
|
||||||
|
# DO NOT EDIT -- overwritten on every update.
|
||||||
|
#
|
||||||
|
# Workflow customization surface for bmad-edit-prd. Mirrors the
|
||||||
|
# agent customization shape under the [workflow] namespace.
|
||||||
|
|
||||||
|
[workflow]
|
||||||
|
|
||||||
|
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
||||||
|
# scalars: override wins • arrays (persistent_facts, activation_steps_*): append
|
||||||
|
# arrays-of-tables with `code`/`id`: replace matching items, append new ones.
|
||||||
|
|
||||||
|
# Steps to run before the standard activation (config load, greet).
|
||||||
|
# Overrides append. Use for pre-flight loads, compliance checks, etc.
|
||||||
|
|
||||||
|
activation_steps_prepend = []
|
||||||
|
|
||||||
|
# Steps to run after greet but before the workflow begins.
|
||||||
|
# Overrides append. Use for context-heavy setup that should happen
|
||||||
|
# once the user has been acknowledged.
|
||||||
|
|
||||||
|
activation_steps_append = []
|
||||||
|
|
||||||
|
# Persistent facts the workflow keeps in mind for the whole run
|
||||||
|
# (standards, compliance constraints, stylistic guardrails).
|
||||||
|
# Distinct from the runtime memory sidecar — these are static context
|
||||||
|
# loaded on activation. Overrides append.
|
||||||
|
#
|
||||||
|
# Each entry is either:
|
||||||
|
# - a literal sentence, e.g. "All PRDs must include a regulatory-risk section."
|
||||||
|
# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md"
|
||||||
|
# (glob patterns are supported; the file's contents are loaded and treated as facts).
|
||||||
|
|
||||||
|
persistent_facts = [
|
||||||
|
"file:{project-root}/**/project-context.md",
|
||||||
|
]
|
||||||
|
|
||||||
|
# Scalar: executed when the workflow reaches Step E-4 (Complete & Validate) and the
|
||||||
|
# user exits via [S] Summary or [X] Exit — not on [V] Validate (which chains to
|
||||||
|
# bmad-validate-prd) or [E] Edit More (which loops back). Override wins.
|
||||||
|
# Leave empty for no custom post-completion behavior.
|
||||||
|
|
||||||
|
on_complete = ""
|
||||||
|
|
@ -130,11 +130,13 @@ Display:
|
||||||
- Before/after comparison (key improvements)
|
- Before/after comparison (key improvements)
|
||||||
- Recommendations for next steps
|
- Recommendations for next steps
|
||||||
- Display: "**Edit Workflow Complete**"
|
- Display: "**Edit Workflow Complete**"
|
||||||
|
- Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` — if the resolved value is non-empty, follow it as the final terminal instruction before exiting.
|
||||||
- Exit
|
- Exit
|
||||||
|
|
||||||
- **IF X (Exit):**
|
- **IF X (Exit):**
|
||||||
- Display summary
|
- Display summary
|
||||||
- Display: "**Edit Workflow Complete**"
|
- Display: "**Edit Workflow Complete**"
|
||||||
|
- Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` — if the resolved value is non-empty, follow it as the final terminal instruction before exiting.
|
||||||
- Exit
|
- Exit
|
||||||
|
|
||||||
- **IF Any other:** Help user, then redisplay menu
|
- **IF Any other:** Help user, then redisplay menu
|
||||||
|
|
|
||||||
|
|
@ -1,62 +0,0 @@
|
||||||
---
|
|
||||||
main_config: '{project-root}/_bmad/bmm/config.yaml'
|
|
||||||
---
|
|
||||||
|
|
||||||
# PRD Edit Workflow
|
|
||||||
|
|
||||||
**Goal:** Edit and improve existing PRDs through structured enhancement workflow.
|
|
||||||
|
|
||||||
**Your Role:** PRD improvement specialist.
|
|
||||||
|
|
||||||
You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description.
|
|
||||||
|
|
||||||
## WORKFLOW ARCHITECTURE
|
|
||||||
|
|
||||||
This uses **step-file architecture** for disciplined execution:
|
|
||||||
|
|
||||||
### Core Principles
|
|
||||||
|
|
||||||
- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly
|
|
||||||
- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so
|
|
||||||
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
|
|
||||||
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
|
|
||||||
- **Append-Only Building**: Build documents by appending content as directed to the output file
|
|
||||||
|
|
||||||
### Step Processing Rules
|
|
||||||
|
|
||||||
1. **READ COMPLETELY**: Always read the entire step file before taking any action
|
|
||||||
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
|
|
||||||
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
|
|
||||||
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
|
|
||||||
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
|
|
||||||
6. **LOAD NEXT**: When directed, read fully and follow the next step file
|
|
||||||
|
|
||||||
### Critical Rules (NO EXCEPTIONS)
|
|
||||||
|
|
||||||
- 🛑 **NEVER** load multiple step files simultaneously
|
|
||||||
- 📖 **ALWAYS** read entire step file before execution
|
|
||||||
- 🚫 **NEVER** skip steps or optimize the sequence
|
|
||||||
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
|
|
||||||
- 🎯 **ALWAYS** follow the exact instructions in the step file
|
|
||||||
- ⏸️ **ALWAYS** halt at menus and wait for user input
|
|
||||||
- 📋 **NEVER** create mental todo lists from future steps
|
|
||||||
|
|
||||||
## Activation
|
|
||||||
|
|
||||||
1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve::
|
|
||||||
- Use `{user_name}` for greeting
|
|
||||||
- Use `{communication_language}` for all communications
|
|
||||||
- Use `{document_output_language}` for output documents
|
|
||||||
- Use `{planning_artifacts}` for output location and artifact scanning
|
|
||||||
- Use `{project_knowledge}` for additional context scanning
|
|
||||||
|
|
||||||
✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the configured `{communication_language}`.
|
|
||||||
✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`.
|
|
||||||
|
|
||||||
2. Route to Edit Workflow
|
|
||||||
|
|
||||||
"**Edit Mode: Improving an existing PRD.**"
|
|
||||||
|
|
||||||
Prompt for PRD path: "Which PRD would you like to edit? Please provide the path to the PRD.md file."
|
|
||||||
|
|
||||||
Then read fully and follow: `./steps-e/step-e-01-discovery.md`
|
|
||||||
|
|
@ -3,4 +3,102 @@ name: bmad-validate-prd
|
||||||
description: 'Validate a PRD against standards. Use when the user says "validate this PRD" or "run PRD validation"'
|
description: 'Validate a PRD against standards. Use when the user says "validate this PRD" or "run PRD validation"'
|
||||||
---
|
---
|
||||||
|
|
||||||
Follow the instructions in ./workflow.md.
|
# PRD Validate Workflow
|
||||||
|
|
||||||
|
**Goal:** Validate existing PRDs against BMAD standards through comprehensive review.
|
||||||
|
|
||||||
|
**Your Role:** Validation Architect and Quality Assurance Specialist.
|
||||||
|
|
||||||
|
You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description.
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- Bare paths (e.g. `steps-v/step-v-01-discovery.md`) resolve from the skill root.
|
||||||
|
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
||||||
|
- `{project-root}`-prefixed paths resolve from the project working directory.
|
||||||
|
- `{skill-name}` resolves to the skill directory's basename.
|
||||||
|
|
||||||
|
## WORKFLOW ARCHITECTURE
|
||||||
|
|
||||||
|
This uses **step-file architecture** for disciplined execution:
|
||||||
|
|
||||||
|
### Core Principles
|
||||||
|
|
||||||
|
- **Micro-file Design**: Each step is a self-contained instruction file that is a part of an overall workflow that must be followed exactly
|
||||||
|
- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so
|
||||||
|
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
|
||||||
|
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
|
||||||
|
- **Append-Only Building**: Build documents by appending content as directed to the output file
|
||||||
|
|
||||||
|
### Step Processing Rules
|
||||||
|
|
||||||
|
1. **READ COMPLETELY**: Always read the entire step file before taking any action
|
||||||
|
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
|
||||||
|
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
|
||||||
|
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
|
||||||
|
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
|
||||||
|
6. **LOAD NEXT**: When directed, read fully and follow the next step file
|
||||||
|
|
||||||
|
### Critical Rules (NO EXCEPTIONS)
|
||||||
|
|
||||||
|
- 🛑 **NEVER** load multiple step files simultaneously
|
||||||
|
- 📖 **ALWAYS** read entire step file before execution
|
||||||
|
- 🚫 **NEVER** skip steps or optimize the sequence
|
||||||
|
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
|
||||||
|
- 🎯 **ALWAYS** follow the exact instructions in the step file
|
||||||
|
- ⏸️ **ALWAYS** halt at menus and wait for user input
|
||||||
|
- 📋 **NEVER** create mental todo lists from future steps
|
||||||
|
|
||||||
|
## On Activation
|
||||||
|
|
||||||
|
### Step 1: Resolve the Workflow Block
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
||||||
|
|
||||||
|
**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:
|
||||||
|
|
||||||
|
1. `{skill-root}/customize.toml` — defaults
|
||||||
|
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
||||||
|
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 2: Execute Prepend Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
||||||
|
|
||||||
|
### Step 3: Load Persistent Facts
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 4: Load Config
|
||||||
|
|
||||||
|
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||||
|
- Use `{user_name}` for greeting
|
||||||
|
- Use `{communication_language}` for all communications
|
||||||
|
- Use `{document_output_language}` for output documents
|
||||||
|
- Use `{planning_artifacts}` for output location and artifact scanning
|
||||||
|
- Use `{project_knowledge}` for additional context scanning
|
||||||
|
|
||||||
|
### Step 5: Greet the User
|
||||||
|
|
||||||
|
Greet `{user_name}`, speaking in `{communication_language}`.
|
||||||
|
|
||||||
|
### Step 6: Execute Append Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_append}` in order.
|
||||||
|
|
||||||
|
Activation is complete. Begin the workflow below.
|
||||||
|
|
||||||
|
## Paths
|
||||||
|
|
||||||
|
- `validateWorkflow` = `./steps-v/step-v-01-discovery.md`
|
||||||
|
|
||||||
|
## Execution
|
||||||
|
|
||||||
|
✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the configured `{communication_language}`.
|
||||||
|
✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`.
|
||||||
|
|
||||||
|
**Validate Mode: Validating an existing PRD against BMAD standards.**
|
||||||
|
|
||||||
|
Then read fully and follow: `{validateWorkflow}` (steps-v/step-v-01-discovery.md)
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,42 @@
|
||||||
|
# DO NOT EDIT -- overwritten on every update.
|
||||||
|
#
|
||||||
|
# Workflow customization surface for bmad-validate-prd. Mirrors the
|
||||||
|
# agent customization shape under the [workflow] namespace.
|
||||||
|
|
||||||
|
[workflow]
|
||||||
|
|
||||||
|
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
||||||
|
# scalars: override wins • arrays (persistent_facts, activation_steps_*): append
|
||||||
|
# arrays-of-tables with `code`/`id`: replace matching items, append new ones.
|
||||||
|
|
||||||
|
# Steps to run before the standard activation (config load, greet).
|
||||||
|
# Overrides append. Use for pre-flight loads, compliance checks, etc.
|
||||||
|
|
||||||
|
activation_steps_prepend = []
|
||||||
|
|
||||||
|
# Steps to run after greet but before the workflow begins.
|
||||||
|
# Overrides append. Use for context-heavy setup that should happen
|
||||||
|
# once the user has been acknowledged.
|
||||||
|
|
||||||
|
activation_steps_append = []
|
||||||
|
|
||||||
|
# Persistent facts the workflow keeps in mind for the whole run
|
||||||
|
# (standards, compliance constraints, stylistic guardrails).
|
||||||
|
# Distinct from the runtime memory sidecar — these are static context
|
||||||
|
# loaded on activation. Overrides append.
|
||||||
|
#
|
||||||
|
# Each entry is either:
|
||||||
|
# - a literal sentence, e.g. "All PRDs must include a regulatory-risk section."
|
||||||
|
# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md"
|
||||||
|
# (glob patterns are supported; the file's contents are loaded and treated as facts).
|
||||||
|
|
||||||
|
persistent_facts = [
|
||||||
|
"file:{project-root}/**/project-context.md",
|
||||||
|
]
|
||||||
|
|
||||||
|
# Scalar: executed when the workflow reaches Step 13 (Validation Report Complete) and
|
||||||
|
# the user exits via [X] Exit — not on [E] Use Edit Workflow (which chains to
|
||||||
|
# bmad-edit-prd), [R] Review (which loops within), or [F] Fix (which loops within).
|
||||||
|
# Override wins. Leave empty for no custom post-completion behavior.
|
||||||
|
|
||||||
|
on_complete = ""
|
||||||
|
|
@ -196,6 +196,7 @@ Display:
|
||||||
- Display: "**Validation Report Saved:** {validationReportPath}"
|
- Display: "**Validation Report Saved:** {validationReportPath}"
|
||||||
- Display: "**Summary:** {overall status} - {recommendation}"
|
- Display: "**Summary:** {overall status} - {recommendation}"
|
||||||
- PRD Validation complete. Invoke the `bmad-help` skill.
|
- PRD Validation complete. Invoke the `bmad-help` skill.
|
||||||
|
- Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` — if the resolved value is non-empty, follow it as the final terminal instruction before exiting.
|
||||||
|
|
||||||
- **IF Any other:** Help user, then redisplay menu
|
- **IF Any other:** Help user, then redisplay menu
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,61 +0,0 @@
|
||||||
---
|
|
||||||
main_config: '{project-root}/_bmad/bmm/config.yaml'
|
|
||||||
validateWorkflow: './steps-v/step-v-01-discovery.md'
|
|
||||||
---
|
|
||||||
|
|
||||||
# PRD Validate Workflow
|
|
||||||
|
|
||||||
**Goal:** Validate existing PRDs against BMAD standards through comprehensive review.
|
|
||||||
|
|
||||||
**Your Role:** Validation Architect and Quality Assurance Specialist.
|
|
||||||
|
|
||||||
You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description.
|
|
||||||
|
|
||||||
## WORKFLOW ARCHITECTURE
|
|
||||||
|
|
||||||
This uses **step-file architecture** for disciplined execution:
|
|
||||||
|
|
||||||
### Core Principles
|
|
||||||
|
|
||||||
- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly
|
|
||||||
- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so
|
|
||||||
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
|
|
||||||
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
|
|
||||||
- **Append-Only Building**: Build documents by appending content as directed to the output file
|
|
||||||
|
|
||||||
### Step Processing Rules
|
|
||||||
|
|
||||||
1. **READ COMPLETELY**: Always read the entire step file before taking any action
|
|
||||||
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
|
|
||||||
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
|
|
||||||
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
|
|
||||||
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
|
|
||||||
6. **LOAD NEXT**: When directed, read fully and follow the next step file
|
|
||||||
|
|
||||||
### Critical Rules (NO EXCEPTIONS)
|
|
||||||
|
|
||||||
- 🛑 **NEVER** load multiple step files simultaneously
|
|
||||||
- 📖 **ALWAYS** read entire step file before execution
|
|
||||||
- 🚫 **NEVER** skip steps or optimize the sequence
|
|
||||||
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
|
|
||||||
- 🎯 **ALWAYS** follow the exact instructions in the step file
|
|
||||||
- ⏸️ **ALWAYS** halt at menus and wait for user input
|
|
||||||
- 📋 **NEVER** create mental todo lists from future steps
|
|
||||||
|
|
||||||
## Activation
|
|
||||||
|
|
||||||
1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve::
|
|
||||||
- Use `{user_name}` for greeting
|
|
||||||
- Use `{communication_language}` for all communications
|
|
||||||
- Use `{document_output_language}` for output documents
|
|
||||||
- Use `{planning_artifacts}` for output location and artifact scanning
|
|
||||||
- Use `{project_knowledge}` for additional context scanning
|
|
||||||
|
|
||||||
✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the configured `{communication_language}`.
|
|
||||||
✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`.
|
|
||||||
|
|
||||||
2. Route to Validate Workflow
|
|
||||||
|
|
||||||
"**Validate Mode: Validating an existing PRD against BMAD standards.**"
|
|
||||||
|
|
||||||
Then read fully and follow: `{validateWorkflow}` (steps-v/step-v-01-discovery.md)
|
|
||||||
|
|
@ -3,4 +3,89 @@ name: bmad-check-implementation-readiness
|
||||||
description: 'Validate PRD, UX, Architecture and Epics specs are complete. Use when the user says "check implementation readiness".'
|
description: 'Validate PRD, UX, Architecture and Epics specs are complete. Use when the user says "check implementation readiness".'
|
||||||
---
|
---
|
||||||
|
|
||||||
Follow the instructions in ./workflow.md.
|
# Implementation Readiness
|
||||||
|
|
||||||
|
**Goal:** Validate that PRD, UX, Architecture, Epics and Stories are complete and aligned before Phase 4 implementation starts, with a focus on ensuring epics and stories are logical and have accounted for all requirements and planning.
|
||||||
|
|
||||||
|
**Your Role:** You are an expert Product Manager, renowned and respected in the field of requirements traceability and spotting gaps in planning. Your success is measured in spotting the failures others have made in planning or preparation of epics and stories to produce the user's product vision.
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- Bare paths (e.g. `steps/step-01-document-discovery.md`) resolve from the skill root.
|
||||||
|
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
||||||
|
- `{project-root}`-prefixed paths resolve from the project working directory.
|
||||||
|
- `{skill-name}` resolves to the skill directory's basename.
|
||||||
|
|
||||||
|
## WORKFLOW ARCHITECTURE
|
||||||
|
|
||||||
|
### Core Principles
|
||||||
|
|
||||||
|
- **Micro-file Design**: Each step toward the overall goal is a self-contained instruction file; adhere to one file at a time, as directed
|
||||||
|
- **Just-In-Time Loading**: Only 1 current step file will be loaded and followed to completion - never load future step files until told to do so
|
||||||
|
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
|
||||||
|
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
|
||||||
|
- **Append-Only Building**: Build documents by appending content as directed to the output file
|
||||||
|
|
||||||
|
### Step Processing Rules
|
||||||
|
|
||||||
|
1. **READ COMPLETELY**: Always read the entire step file before taking any action
|
||||||
|
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
|
||||||
|
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
|
||||||
|
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
|
||||||
|
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
|
||||||
|
6. **LOAD NEXT**: When directed, read fully and follow the next step file
|
||||||
|
|
||||||
|
### Critical Rules (NO EXCEPTIONS)
|
||||||
|
|
||||||
|
- 🛑 **NEVER** load multiple step files simultaneously
|
||||||
|
- 📖 **ALWAYS** read entire step file before execution
|
||||||
|
- 🚫 **NEVER** skip steps or optimize the sequence
|
||||||
|
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
|
||||||
|
- 🎯 **ALWAYS** follow the exact instructions in the step file
|
||||||
|
- ⏸️ **ALWAYS** halt at menus and wait for user input
|
||||||
|
- 📋 **NEVER** create mental todo lists from future steps
|
||||||
|
|
||||||
|
## On Activation
|
||||||
|
|
||||||
|
### Step 1: Resolve the Workflow Block
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
||||||
|
|
||||||
|
**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:
|
||||||
|
|
||||||
|
1. `{skill-root}/customize.toml` — defaults
|
||||||
|
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
||||||
|
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 2: Execute Prepend Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
||||||
|
|
||||||
|
### Step 3: Load Persistent Facts
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 4: Load Config
|
||||||
|
|
||||||
|
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||||
|
- Use `{user_name}` for greeting
|
||||||
|
- Use `{communication_language}` for all communications
|
||||||
|
- Use `{document_output_language}` for output documents
|
||||||
|
- Use `{planning_artifacts}` for output location and artifact scanning
|
||||||
|
- Use `{project_knowledge}` for additional context scanning
|
||||||
|
|
||||||
|
### Step 5: Greet the User
|
||||||
|
|
||||||
|
Greet `{user_name}`, speaking in `{communication_language}`.
|
||||||
|
|
||||||
|
### Step 6: Execute Append Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_append}` in order.
|
||||||
|
|
||||||
|
Activation is complete. Begin the workflow below.
|
||||||
|
|
||||||
|
## Execution
|
||||||
|
|
||||||
|
Read fully and follow: `./steps/step-01-document-discovery.md` to begin the workflow.
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,41 @@
|
||||||
|
# DO NOT EDIT -- overwritten on every update.
|
||||||
|
#
|
||||||
|
# Workflow customization surface for bmad-check-implementation-readiness. Mirrors the
|
||||||
|
# agent customization shape under the [workflow] namespace.
|
||||||
|
|
||||||
|
[workflow]
|
||||||
|
|
||||||
|
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
||||||
|
# scalars: override wins • arrays (persistent_facts, activation_steps_*): append
|
||||||
|
# arrays-of-tables with `code`/`id`: replace matching items, append new ones.
|
||||||
|
|
||||||
|
# Steps to run before the standard activation (config load, greet).
|
||||||
|
# Overrides append. Use for pre-flight loads, compliance checks, etc.
|
||||||
|
|
||||||
|
activation_steps_prepend = []
|
||||||
|
|
||||||
|
# Steps to run after greet but before the workflow begins.
|
||||||
|
# Overrides append. Use for context-heavy setup that should happen
|
||||||
|
# once the user has been acknowledged.
|
||||||
|
|
||||||
|
activation_steps_append = []
|
||||||
|
|
||||||
|
# Persistent facts the workflow keeps in mind for the whole run
|
||||||
|
# (standards, compliance constraints, stylistic guardrails).
|
||||||
|
# Distinct from the runtime memory sidecar — these are static context
|
||||||
|
# loaded on activation. Overrides append.
|
||||||
|
#
|
||||||
|
# Each entry is either:
|
||||||
|
# - a literal sentence, e.g. "All artifacts must follow org naming conventions."
|
||||||
|
# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md"
|
||||||
|
# (glob patterns are supported; the file's contents are loaded and treated as facts).
|
||||||
|
|
||||||
|
persistent_facts = [
|
||||||
|
"file:{project-root}/**/project-context.md",
|
||||||
|
]
|
||||||
|
|
||||||
|
# Scalar: executed when the workflow reaches Step 6 (Final Assessment),
|
||||||
|
# after the readiness report has been saved and presented. Override wins.
|
||||||
|
# Leave empty for no custom post-completion behavior.
|
||||||
|
|
||||||
|
on_complete = ""
|
||||||
|
|
@ -124,3 +124,9 @@ Implementation Readiness complete. Invoke the `bmad-help` skill.
|
||||||
- Not reviewing previous findings
|
- Not reviewing previous findings
|
||||||
- Incomplete summary
|
- Incomplete summary
|
||||||
- No clear recommendations
|
- No clear recommendations
|
||||||
|
|
||||||
|
## On Complete
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete`
|
||||||
|
|
||||||
|
If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting.
|
||||||
|
|
|
||||||
|
|
@ -1,47 +0,0 @@
|
||||||
# Implementation Readiness
|
|
||||||
|
|
||||||
**Goal:** Validate that PRD, Architecture, Epics and Stories are complete and aligned before Phase 4 implementation starts, with a focus on ensuring epics and stories are logical and have accounted for all requirements and planning.
|
|
||||||
|
|
||||||
**Your Role:** You are an expert Product Manager, renowned and respected in the field of requirements traceability and spotting gaps in planning. Your success is measured in spotting the failures others have made in planning or preparation of epics and stories to produce the user's product vision.
|
|
||||||
|
|
||||||
## WORKFLOW ARCHITECTURE
|
|
||||||
|
|
||||||
### Core Principles
|
|
||||||
|
|
||||||
- **Micro-file Design**: Each step of the overall goal is a self contained instruction file that you will adhere too 1 file as directed at a time
|
|
||||||
- **Just-In-Time Loading**: Only 1 current step file will be loaded and followed to completion - never load future step files until told to do so
|
|
||||||
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
|
|
||||||
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
|
|
||||||
- **Append-Only Building**: Build documents by appending content as directed to the output file
|
|
||||||
|
|
||||||
### Step Processing Rules
|
|
||||||
|
|
||||||
1. **READ COMPLETELY**: Always read the entire step file before taking any action
|
|
||||||
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
|
|
||||||
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
|
|
||||||
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
|
|
||||||
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
|
|
||||||
6. **LOAD NEXT**: When directed, read fully and follow the next step file
|
|
||||||
|
|
||||||
### Critical Rules (NO EXCEPTIONS)
|
|
||||||
|
|
||||||
- 🛑 **NEVER** load multiple step files simultaneously
|
|
||||||
- 📖 **ALWAYS** read entire step file before execution
|
|
||||||
- 🚫 **NEVER** skip steps or optimize the sequence
|
|
||||||
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
|
|
||||||
- 🎯 **ALWAYS** follow the exact instructions in the step file
|
|
||||||
- ⏸️ **ALWAYS** halt at menus and wait for user input
|
|
||||||
- 📋 **NEVER** create mental todo lists from future steps
|
|
||||||
|
|
||||||
## Activation
|
|
||||||
|
|
||||||
1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve::
|
|
||||||
- Use `{user_name}` for greeting
|
|
||||||
- Use `{communication_language}` for all communications
|
|
||||||
- Use `{document_output_language}` for output documents
|
|
||||||
- Use `{planning_artifacts}` for output location and artifact scanning
|
|
||||||
- Use `{project_knowledge}` for additional context scanning
|
|
||||||
|
|
||||||
2. First Step EXECUTION
|
|
||||||
|
|
||||||
Read fully and follow: `./steps/step-01-document-discovery.md` to begin the workflow.
|
|
||||||
|
|
@ -3,4 +3,72 @@ name: bmad-create-architecture
|
||||||
description: 'Create architecture solution design decisions for AI agent consistency. Use when the user says "lets create architecture" or "create technical architecture" or "create a solution design"'
|
description: 'Create architecture solution design decisions for AI agent consistency. Use when the user says "lets create architecture" or "create technical architecture" or "create a solution design"'
|
||||||
---
|
---
|
||||||
|
|
||||||
Follow the instructions in ./workflow.md.
|
# Architecture Workflow
|
||||||
|
|
||||||
|
**Goal:** Create comprehensive architecture decisions through collaborative step-by-step discovery that ensures AI agents implement consistently.
|
||||||
|
|
||||||
|
**Your Role:** You are an architectural facilitator collaborating with a peer. This is a partnership, not a client-vendor relationship. You bring structured thinking and architectural knowledge, while the user brings domain expertise and product vision. Work together as equals to make decisions that prevent implementation conflicts.
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- Bare paths (e.g. `steps/step-01-init.md`) resolve from the skill root.
|
||||||
|
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
||||||
|
- `{project-root}`-prefixed paths resolve from the project working directory.
|
||||||
|
- `{skill-name}` resolves to the skill directory's basename.
|
||||||
|
|
||||||
|
## WORKFLOW ARCHITECTURE
|
||||||
|
|
||||||
|
This uses **micro-file architecture** for disciplined execution:
|
||||||
|
|
||||||
|
- Each step is a self-contained file with embedded rules
|
||||||
|
- Sequential progression with user control at each step
|
||||||
|
- Document state tracked in frontmatter
|
||||||
|
- Append-only document building through conversation
|
||||||
|
- You NEVER proceed to a step file if the current step file indicates the user must approve and indicate continuation.
|
||||||
|
|
||||||
|
## On Activation
|
||||||
|
|
||||||
|
### Step 1: Resolve the Workflow Block
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
||||||
|
|
||||||
|
**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:
|
||||||
|
|
||||||
|
1. `{skill-root}/customize.toml` — defaults
|
||||||
|
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
||||||
|
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 2: Execute Prepend Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
||||||
|
|
||||||
|
### Step 3: Load Persistent Facts
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 4: Load Config
|
||||||
|
|
||||||
|
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||||
|
- Use `{user_name}` for greeting
|
||||||
|
- Use `{communication_language}` for all communications
|
||||||
|
- Use `{document_output_language}` for output documents
|
||||||
|
- Use `{planning_artifacts}` for output location and artifact scanning
|
||||||
|
- Use `{project_knowledge}` for additional context scanning
|
||||||
|
|
||||||
|
### Step 5: Greet the User
|
||||||
|
|
||||||
|
Greet `{user_name}`, speaking in `{communication_language}`.
|
||||||
|
|
||||||
|
### Step 6: Execute Append Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_append}` in order.
|
||||||
|
|
||||||
|
Activation is complete. Begin the workflow below.
|
||||||
|
|
||||||
|
## Execution
|
||||||
|
|
||||||
|
Read fully and follow: `./steps/step-01-init.md` to begin the workflow.
|
||||||
|
|
||||||
|
**Note:** Input document discovery and all initialization protocols are handled in step-01-init.md.
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,41 @@
|
||||||
|
# DO NOT EDIT -- overwritten on every update.
|
||||||
|
#
|
||||||
|
# Workflow customization surface for bmad-create-architecture. Mirrors the
|
||||||
|
# agent customization shape under the [workflow] namespace.
|
||||||
|
|
||||||
|
[workflow]
|
||||||
|
|
||||||
|
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
||||||
|
# scalars: override wins • arrays (persistent_facts, activation_steps_*): append
|
||||||
|
# arrays-of-tables with `code`/`id`: replace matching items, append new ones.
|
||||||
|
|
||||||
|
# Steps to run before the standard activation (config load, greet).
|
||||||
|
# Overrides append. Use for pre-flight loads, compliance checks, etc.
|
||||||
|
|
||||||
|
activation_steps_prepend = []
|
||||||
|
|
||||||
|
# Steps to run after greet but before the workflow begins.
|
||||||
|
# Overrides append. Use for context-heavy setup that should happen
|
||||||
|
# once the user has been acknowledged.
|
||||||
|
|
||||||
|
activation_steps_append = []
|
||||||
|
|
||||||
|
# Persistent facts the workflow keeps in mind for the whole run
|
||||||
|
# (standards, compliance constraints, stylistic guardrails).
|
||||||
|
# Distinct from the runtime memory sidecar — these are static context
|
||||||
|
# loaded on activation. Overrides append.
|
||||||
|
#
|
||||||
|
# Each entry is either:
|
||||||
|
# - a literal sentence, e.g. "Our org is AWS-only -- do not propose GCP or Azure."
|
||||||
|
# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md"
|
||||||
|
# (glob patterns are supported; the file's contents are loaded and treated as facts).
|
||||||
|
|
||||||
|
persistent_facts = [
|
||||||
|
"file:{project-root}/**/project-context.md",
|
||||||
|
]
|
||||||
|
|
||||||
|
# Scalar: executed when the workflow reaches Step 8 (Architecture Completion & Handoff),
|
||||||
|
# after the architecture document frontmatter is updated and next-steps guidance is given.
|
||||||
|
# Override wins. Leave empty for no custom post-completion behavior.
|
||||||
|
|
||||||
|
on_complete = ""
|
||||||
|
|
@ -74,3 +74,9 @@ Upon Completion of task output: offer to answer any questions about the Architec
|
||||||
This is the final step of the Architecture workflow. The user now has a complete, validated architecture document ready for AI agent implementation.
|
This is the final step of the Architecture workflow. The user now has a complete, validated architecture document ready for AI agent implementation.
|
||||||
|
|
||||||
The architecture will serve as the single source of truth for all technical decisions, ensuring consistent implementation across the entire project development lifecycle.
|
The architecture will serve as the single source of truth for all technical decisions, ensuring consistent implementation across the entire project development lifecycle.
|
||||||
|
|
||||||
|
## On Complete
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete`
|
||||||
|
|
||||||
|
If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting.
|
||||||
|
|
|
||||||
|
|
@ -1,32 +0,0 @@
|
||||||
# Architecture Workflow
|
|
||||||
|
|
||||||
**Goal:** Create comprehensive architecture decisions through collaborative step-by-step discovery that ensures AI agents implement consistently.
|
|
||||||
|
|
||||||
**Your Role:** You are an architectural facilitator collaborating with a peer. This is a partnership, not a client-vendor relationship. You bring structured thinking and architectural knowledge, while the user brings domain expertise and product vision. Work together as equals to make decisions that prevent implementation conflicts.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## WORKFLOW ARCHITECTURE
|
|
||||||
|
|
||||||
This uses **micro-file architecture** for disciplined execution:
|
|
||||||
|
|
||||||
- Each step is a self-contained file with embedded rules
|
|
||||||
- Sequential progression with user control at each step
|
|
||||||
- Document state tracked in frontmatter
|
|
||||||
- Append-only document building through conversation
|
|
||||||
- You NEVER proceed to a step file if the current step file indicates the user must approve and indicate continuation.
|
|
||||||
|
|
||||||
## Activation
|
|
||||||
|
|
||||||
1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve::
|
|
||||||
- Use `{user_name}` for greeting
|
|
||||||
- Use `{communication_language}` for all communications
|
|
||||||
- Use `{document_output_language}` for output documents
|
|
||||||
- Use `{planning_artifacts}` for output location and artifact scanning
|
|
||||||
- Use `{project_knowledge}` for additional context scanning
|
|
||||||
|
|
||||||
2. EXECUTION
|
|
||||||
|
|
||||||
Read fully and follow: `./steps/step-01-init.md` to begin the workflow.
|
|
||||||
|
|
||||||
**Note:** Input document discovery and all initialization protocols are handled in step-01-init.md.
|
|
||||||
|
|
@ -3,4 +3,91 @@ name: bmad-create-epics-and-stories
|
||||||
description: 'Break requirements into epics and user stories. Use when the user says "create the epics and stories list"'
|
description: 'Break requirements into epics and user stories. Use when the user says "create the epics and stories list"'
|
||||||
---
|
---
|
||||||
|
|
||||||
Follow the instructions in ./workflow.md.
|
# Create Epics and Stories
|
||||||
|
|
||||||
|
**Goal:** Transform PRD requirements and Architecture decisions into comprehensive stories organized by user value, creating detailed, actionable stories with complete acceptance criteria for the Developer agent.
|
||||||
|
|
||||||
|
**Your Role:** In addition to your name, communication_style, and persona, you are also a product strategist and technical specifications writer collaborating with a product owner. This is a partnership, not a client-vendor relationship. You bring expertise in requirements decomposition, technical implementation context, and acceptance criteria writing, while the user brings their product vision, user needs, and business requirements. Work together as equals.
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- Bare paths (e.g. `steps/step-01-validate-prerequisites.md`) resolve from the skill root.
|
||||||
|
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
||||||
|
- `{project-root}`-prefixed paths resolve from the project working directory.
|
||||||
|
- `{skill-name}` resolves to the skill directory's basename.
|
||||||
|
|
||||||
|
## WORKFLOW ARCHITECTURE
|
||||||
|
|
||||||
|
This uses **step-file architecture** for disciplined execution:
|
||||||
|
|
||||||
|
### Core Principles
|
||||||
|
|
||||||
|
- **Micro-file Design**: Each step toward the overall goal is a self-contained instruction file; adhere to one file at a time, as directed
|
||||||
|
- **Just-In-Time Loading**: Only 1 current step file will be loaded and followed to completion - never load future step files until told to do so
|
||||||
|
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
|
||||||
|
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
|
||||||
|
- **Append-Only Building**: Build documents by appending content as directed to the output file
|
||||||
|
|
||||||
|
### Step Processing Rules
|
||||||
|
|
||||||
|
1. **READ COMPLETELY**: Always read the entire step file before taking any action
|
||||||
|
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
|
||||||
|
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
|
||||||
|
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
|
||||||
|
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
|
||||||
|
6. **LOAD NEXT**: When directed, read fully and follow the next step file
|
||||||
|
|
||||||
|
### Critical Rules (NO EXCEPTIONS)
|
||||||
|
|
||||||
|
- 🛑 **NEVER** load multiple step files simultaneously
|
||||||
|
- 📖 **ALWAYS** read entire step file before execution
|
||||||
|
- 🚫 **NEVER** skip steps or optimize the sequence
|
||||||
|
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
|
||||||
|
- 🎯 **ALWAYS** follow the exact instructions in the step file
|
||||||
|
- ⏸️ **ALWAYS** halt at menus and wait for user input
|
||||||
|
- 📋 **NEVER** create mental todo lists from future steps
|
||||||
|
|
||||||
|
## On Activation
|
||||||
|
|
||||||
|
### Step 1: Resolve the Workflow Block
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
||||||
|
|
||||||
|
**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:
|
||||||
|
|
||||||
|
1. `{skill-root}/customize.toml` — defaults
|
||||||
|
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
||||||
|
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 2: Execute Prepend Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
||||||
|
|
||||||
|
### Step 3: Load Persistent Facts
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 4: Load Config
|
||||||
|
|
||||||
|
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||||
|
- Use `{user_name}` for greeting
|
||||||
|
- Use `{communication_language}` for all communications
|
||||||
|
- Use `{document_output_language}` for output documents
|
||||||
|
- Use `{planning_artifacts}` for output location and artifact scanning
|
||||||
|
- Use `{project_knowledge}` for additional context scanning
|
||||||
|
|
||||||
|
### Step 5: Greet the User
|
||||||
|
|
||||||
|
Greet `{user_name}`, speaking in `{communication_language}`.
|
||||||
|
|
||||||
|
### Step 6: Execute Append Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_append}` in order.
|
||||||
|
|
||||||
|
Activation is complete. Begin the workflow below.
|
||||||
|
|
||||||
|
## Execution
|
||||||
|
|
||||||
|
Read fully and follow: `./steps/step-01-validate-prerequisites.md` to begin the workflow.
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,41 @@
|
||||||
|
# DO NOT EDIT -- overwritten on every update.
|
||||||
|
#
|
||||||
|
# Workflow customization surface for bmad-create-epics-and-stories. Mirrors the
|
||||||
|
# agent customization shape under the [workflow] namespace.
|
||||||
|
|
||||||
|
[workflow]
|
||||||
|
|
||||||
|
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
||||||
|
# scalars: override wins • arrays (persistent_facts, activation_steps_*): append
|
||||||
|
# arrays-of-tables with `code`/`id`: replace matching items, append new ones.
|
||||||
|
|
||||||
|
# Steps to run before the standard activation (config load, greet).
|
||||||
|
# Overrides append. Use for pre-flight loads, compliance checks, etc.
|
||||||
|
|
||||||
|
activation_steps_prepend = []
|
||||||
|
|
||||||
|
# Steps to run after greet but before the workflow begins.
|
||||||
|
# Overrides append. Use for context-heavy setup that should happen
|
||||||
|
# once the user has been acknowledged.
|
||||||
|
|
||||||
|
activation_steps_append = []
|
||||||
|
|
||||||
|
# Persistent facts the workflow keeps in mind for the whole run
|
||||||
|
# (standards, compliance constraints, stylistic guardrails).
|
||||||
|
# Distinct from the runtime memory sidecar — these are static context
|
||||||
|
# loaded on activation. Overrides append.
|
||||||
|
#
|
||||||
|
# Each entry is either:
|
||||||
|
# - a literal sentence, e.g. "All epics must deliver complete end-to-end user value."
|
||||||
|
# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md"
|
||||||
|
# (glob patterns are supported; the file's contents are loaded and treated as facts).
|
||||||
|
|
||||||
|
persistent_facts = [
|
||||||
|
"file:{project-root}/**/project-context.md",
|
||||||
|
]
|
||||||
|
|
||||||
|
# Scalar: executed when the workflow reaches Step 4 (Final Validation) and the
|
||||||
|
# user confirms [C] Complete — after the epics.md is saved and bmad-help is invoked.
|
||||||
|
# Override wins. Leave empty for no custom post-completion behavior.
|
||||||
|
|
||||||
|
on_complete = ""
|
||||||
|
|
@ -129,3 +129,9 @@ When C is selected, the workflow is complete and the epics.md is ready for devel
|
||||||
Epics and Stories complete. Invoke the `bmad-help` skill.
|
Epics and Stories complete. Invoke the `bmad-help` skill.
|
||||||
|
|
||||||
Upon Completion of task output: offer to answer any questions about the Epics and Stories.
|
Upon Completion of task output: offer to answer any questions about the Epics and Stories.
|
||||||
|
|
||||||
|
## On Complete
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete`
|
||||||
|
|
||||||
|
If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting.
|
||||||
|
|
|
||||||
|
|
@ -1,51 +0,0 @@
|
||||||
# Create Epics and Stories
|
|
||||||
|
|
||||||
**Goal:** Transform PRD requirements and Architecture decisions into comprehensive stories organized by user value, creating detailed, actionable stories with complete acceptance criteria for the Developer agent.
|
|
||||||
|
|
||||||
**Your Role:** In addition to your name, communication_style, and persona, you are also a product strategist and technical specifications writer collaborating with a product owner. This is a partnership, not a client-vendor relationship. You bring expertise in requirements decomposition, technical implementation context, and acceptance criteria writing, while the user brings their product vision, user needs, and business requirements. Work together as equals.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## WORKFLOW ARCHITECTURE
|
|
||||||
|
|
||||||
This uses **step-file architecture** for disciplined execution:
|
|
||||||
|
|
||||||
### Core Principles
|
|
||||||
|
|
||||||
- **Micro-file Design**: Each step of the overall goal is a self contained instruction file that you will adhere too 1 file as directed at a time
|
|
||||||
- **Just-In-Time Loading**: Only 1 current step file will be loaded and followed to completion - never load future step files until told to do so
|
|
||||||
- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
|
|
||||||
- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
|
|
||||||
- **Append-Only Building**: Build documents by appending content as directed to the output file
|
|
||||||
|
|
||||||
### Step Processing Rules
|
|
||||||
|
|
||||||
1. **READ COMPLETELY**: Always read the entire step file before taking any action
|
|
||||||
2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
|
|
||||||
3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
|
|
||||||
4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
|
|
||||||
5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
|
|
||||||
6. **LOAD NEXT**: When directed, read fully and follow the next step file
|
|
||||||
|
|
||||||
### Critical Rules (NO EXCEPTIONS)
|
|
||||||
|
|
||||||
- 🛑 **NEVER** load multiple step files simultaneously
|
|
||||||
- 📖 **ALWAYS** read entire step file before execution
|
|
||||||
- 🚫 **NEVER** skip steps or optimize the sequence
|
|
||||||
- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
|
|
||||||
- 🎯 **ALWAYS** follow the exact instructions in the step file
|
|
||||||
- ⏸️ **ALWAYS** halt at menus and wait for user input
|
|
||||||
- 📋 **NEVER** create mental todo lists from future steps
|
|
||||||
|
|
||||||
## Activation
|
|
||||||
|
|
||||||
1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve::
|
|
||||||
- Use `{user_name}` for greeting
|
|
||||||
- Use `{communication_language}` for all communications
|
|
||||||
- Use `{document_output_language}` for output documents
|
|
||||||
- Use `{planning_artifacts}` for output location and artifact scanning
|
|
||||||
- Use `{project_knowledge}` for additional context scanning
|
|
||||||
|
|
||||||
2. First Step EXECUTION
|
|
||||||
|
|
||||||
Read fully and follow: `./steps/step-01-validate-prerequisites.md` to begin the workflow.
|
|
||||||
|
|
@ -3,4 +3,79 @@ name: bmad-generate-project-context
|
||||||
description: 'Create project-context.md with AI rules. Use when the user says "generate project context" or "create project context"'
|
description: 'Create project-context.md with AI rules. Use when the user says "generate project context" or "create project context"'
|
||||||
---
|
---
|
||||||
|
|
||||||
Follow the instructions in ./workflow.md.
|
# Generate Project Context Workflow
|
||||||
|
|
||||||
|
**Goal:** Create a concise, optimized `project-context.md` file containing critical rules, patterns, and guidelines that AI agents must follow when implementing code. This file focuses on unobvious details that LLMs need to be reminded of.
|
||||||
|
|
||||||
|
**Your Role:** You are a technical facilitator working with a peer to capture the essential implementation rules that will ensure consistent, high-quality code generation across all AI agents working on the project.
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- Bare paths (e.g. `steps/step-01-discover.md`) resolve from the skill root.
|
||||||
|
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
||||||
|
- `{project-root}`-prefixed paths resolve from the project working directory.
|
||||||
|
- `{skill-name}` resolves to the skill directory's basename.
|
||||||
|
|
||||||
|
## WORKFLOW ARCHITECTURE
|
||||||
|
|
||||||
|
This uses **micro-file architecture** for disciplined execution:
|
||||||
|
|
||||||
|
- Each step is a self-contained file with embedded rules
|
||||||
|
- Sequential progression with user control at each step
|
||||||
|
- Document state tracked in frontmatter
|
||||||
|
- Focus on lean, LLM-optimized content generation
|
||||||
|
- You NEVER proceed to a step file if the current step file indicates the user must approve and indicate continuation.
|
||||||
|
|
||||||
|
## On Activation
|
||||||
|
|
||||||
|
### Step 1: Resolve the Workflow Block
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
||||||
|
|
||||||
|
**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:
|
||||||
|
|
||||||
|
1. `{skill-root}/customize.toml` — defaults
|
||||||
|
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
||||||
|
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 2: Execute Prepend Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
||||||
|
|
||||||
|
### Step 3: Load Persistent Facts
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 4: Load Config
|
||||||
|
|
||||||
|
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||||
|
- Use `{user_name}` for greeting
|
||||||
|
- Use `{communication_language}` for all communications
|
||||||
|
- Use `{document_output_language}` for output documents
|
||||||
|
- Use `{planning_artifacts}` for output location and artifact scanning
|
||||||
|
- Use `{project_knowledge}` for additional context scanning
|
||||||
|
|
||||||
|
### Step 5: Greet the User
|
||||||
|
|
||||||
|
Greet `{user_name}`, speaking in `{communication_language}`.
|
||||||
|
|
||||||
|
### Step 6: Execute Append Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_append}` in order.
|
||||||
|
|
||||||
|
Activation is complete. Begin the workflow below.
|
||||||
|
|
||||||
|
## Paths
|
||||||
|
|
||||||
|
- `output_file` = `{output_folder}/project-context.md`
|
||||||
|
|
||||||
|
## Execution
|
||||||
|
|
||||||
|
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||||
|
- ✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`
|
||||||
|
|
||||||
|
Load and execute `./steps/step-01-discover.md` to begin the workflow.
|
||||||
|
|
||||||
|
**Note:** Input document discovery and initialization protocols are handled in step-01-discover.md.
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,41 @@
|
||||||
|
# DO NOT EDIT -- overwritten on every update.
|
||||||
|
#
|
||||||
|
# Workflow customization surface for bmad-generate-project-context. Mirrors the
|
||||||
|
# agent customization shape under the [workflow] namespace.
|
||||||
|
|
||||||
|
[workflow]
|
||||||
|
|
||||||
|
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
||||||
|
# scalars: override wins • arrays (persistent_facts, activation_steps_*): append
|
||||||
|
# arrays-of-tables with `code`/`id`: replace matching items, append new ones.
|
||||||
|
|
||||||
|
# Steps to run before the standard activation (config load, greet).
|
||||||
|
# Overrides append. Use for pre-flight loads, compliance checks, etc.
|
||||||
|
|
||||||
|
activation_steps_prepend = []
|
||||||
|
|
||||||
|
# Steps to run after greet but before the workflow begins.
|
||||||
|
# Overrides append. Use for context-heavy setup that should happen
|
||||||
|
# once the user has been acknowledged.
|
||||||
|
|
||||||
|
activation_steps_append = []
|
||||||
|
|
||||||
|
# Persistent facts the workflow keeps in mind for the whole run
|
||||||
|
# (standards, compliance constraints, stylistic guardrails).
|
||||||
|
# Distinct from the runtime memory sidecar — these are static context
|
||||||
|
# loaded on activation. Overrides append.
|
||||||
|
#
|
||||||
|
# Each entry is either:
|
||||||
|
# - a literal sentence, e.g. "All artifacts must follow org naming conventions."
|
||||||
|
# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md"
|
||||||
|
# (glob patterns are supported; the file's contents are loaded and treated as facts).
|
||||||
|
|
||||||
|
persistent_facts = [
|
||||||
|
"file:{project-root}/**/project-context.md",
|
||||||
|
]
|
||||||
|
|
||||||
|
# Scalar: executed when the workflow reaches Step 3 (Context Completion & Finalization),
|
||||||
|
# after the project-context.md file is optimized and saved. Override wins.
|
||||||
|
# Leave empty for no custom post-completion behavior.
|
||||||
|
|
||||||
|
on_complete = ""
|
||||||
|
|
@ -276,3 +276,9 @@ Your project context will help ensure high-quality, consistent implementation ac
|
||||||
This is the final step of the Generate Project Context workflow. The user now has a comprehensive, optimized project context file that will ensure consistent, high-quality implementation across all AI agents working on the project.
|
This is the final step of the Generate Project Context workflow. The user now has a comprehensive, optimized project context file that will ensure consistent, high-quality implementation across all AI agents working on the project.
|
||||||
|
|
||||||
The project context file serves as the critical "rules of the road" that agents need to implement code consistently with the project's standards and patterns.
|
The project context file serves as the critical "rules of the road" that agents need to implement code consistently with the project's standards and patterns.
|
||||||
|
|
||||||
|
## On Complete
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete`
|
||||||
|
|
||||||
|
If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting.
|
||||||
|
|
|
||||||
|
|
@ -1,39 +0,0 @@
|
||||||
# Generate Project Context Workflow
|
|
||||||
|
|
||||||
**Goal:** Create a concise, optimized `project-context.md` file containing critical rules, patterns, and guidelines that AI agents must follow when implementing code. This file focuses on unobvious details that LLMs need to be reminded of.
|
|
||||||
|
|
||||||
**Your Role:** You are a technical facilitator working with a peer to capture the essential implementation rules that will ensure consistent, high-quality code generation across all AI agents working on the project.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## WORKFLOW ARCHITECTURE
|
|
||||||
|
|
||||||
This uses **micro-file architecture** for disciplined execution:
|
|
||||||
|
|
||||||
- Each step is a self-contained file with embedded rules
|
|
||||||
- Sequential progression with user control at each step
|
|
||||||
- Document state tracked in frontmatter
|
|
||||||
- Focus on lean, LLM-optimized content generation
|
|
||||||
- You NEVER proceed to a step file if the current step file indicates the user must approve and indicate continuation.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Activation
|
|
||||||
|
|
||||||
1. Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve::
|
|
||||||
- Use `{user_name}` for greeting
|
|
||||||
- Use `{communication_language}` for all communications
|
|
||||||
- Use `{document_output_language}` for output documents
|
|
||||||
- Use `{planning_artifacts}` for output location and artifact scanning
|
|
||||||
- Use `{project_knowledge}` for additional context scanning
|
|
||||||
|
|
||||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
|
||||||
- ✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`
|
|
||||||
|
|
||||||
- `output_file` = `{output_folder}/project-context.md`
|
|
||||||
|
|
||||||
EXECUTION
|
|
||||||
|
|
||||||
Load and execute `./steps/step-01-discover.md` to begin the workflow.
|
|
||||||
|
|
||||||
**Note:** Input document discovery and initialization protocols are handled in step-01-discover.md.
|
|
||||||
|
|
@ -3,4 +3,299 @@ name: bmad-correct-course
|
||||||
description: 'Manage significant changes during sprint execution. Use when the user says "correct course" or "propose sprint change"'
|
description: 'Manage significant changes during sprint execution. Use when the user says "correct course" or "propose sprint change"'
|
||||||
---
|
---
|
||||||
|
|
||||||
Follow the instructions in ./workflow.md.
|
# Correct Course - Sprint Change Management Workflow
|
||||||
|
|
||||||
|
**Goal:** Manage significant changes during sprint execution by analyzing impact across all project artifacts and producing a structured Sprint Change Proposal.
|
||||||
|
|
||||||
|
**Your Role:** You are a Developer navigating change management. Analyze the triggering issue, assess impact across PRD, epics, architecture, and UX artifacts, and produce an actionable Sprint Change Proposal with clear handoff.
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- Bare paths (e.g. `checklist.md`) resolve from the skill root.
|
||||||
|
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
||||||
|
- `{project-root}`-prefixed paths resolve from the project working directory.
|
||||||
|
- `{skill-name}` resolves to the skill directory's basename.
|
||||||
|
|
||||||
|
## On Activation
|
||||||
|
|
||||||
|
### Step 1: Resolve the Workflow Block
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
||||||
|
|
||||||
|
**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:
|
||||||
|
|
||||||
|
1. `{skill-root}/customize.toml` — defaults
|
||||||
|
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
||||||
|
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 2: Execute Prepend Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
||||||
|
|
||||||
|
### Step 3: Load Persistent Facts
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 4: Load Config
|
||||||
|
|
||||||
|
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||||
|
|
||||||
|
- `project_name`, `user_name`
|
||||||
|
- `communication_language`, `document_output_language`
|
||||||
|
- `user_skill_level`
|
||||||
|
- `implementation_artifacts`
|
||||||
|
- `planning_artifacts`
|
||||||
|
- `project_knowledge`
|
||||||
|
- `date` as system-generated current datetime
|
||||||
|
- YOU MUST ALWAYS SPEAK OUTPUT in your Agent communication style with the config `{communication_language}`
|
||||||
|
- Language MUST be tailored to `{user_skill_level}`
|
||||||
|
- Generate all documents in `{document_output_language}`
|
||||||
|
- DOCUMENT OUTPUT: Updated epics, stories, or PRD sections. Clear, actionable changes. User skill level (`{user_skill_level}`) affects conversation style ONLY, not document updates.
|
||||||
|
|
||||||
|
### Step 5: Greet the User
|
||||||
|
|
||||||
|
Greet `{user_name}`, speaking in `{communication_language}`.
|
||||||
|
|
||||||
|
### Step 6: Execute Append Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_append}` in order.
|
||||||
|
|
||||||
|
Activation is complete. Begin the workflow below.
|
||||||
|
|
||||||
|
## Paths
|
||||||
|
|
||||||
|
- `default_output_file` = `{planning_artifacts}/sprint-change-proposal-{date}.md`
|
||||||
|
|
||||||
|
## Input Files
|
||||||
|
|
||||||
|
| Input | Path | Load Strategy |
|
||||||
|
|-------|------|---------------|
|
||||||
|
| PRD | `{planning_artifacts}/*prd*.md` (whole) or `{planning_artifacts}/*prd*/*.md` (sharded) | FULL_LOAD |
|
||||||
|
| Epics | `{planning_artifacts}/*epic*.md` (whole) or `{planning_artifacts}/*epic*/*.md` (sharded) | FULL_LOAD |
|
||||||
|
| Architecture | `{planning_artifacts}/*architecture*.md` (whole) or `{planning_artifacts}/*architecture*/*.md` (sharded) | FULL_LOAD |
|
||||||
|
| UX Design | `{planning_artifacts}/*ux*.md` (whole) or `{planning_artifacts}/*ux*/*.md` (sharded) | FULL_LOAD |
|
||||||
|
| Spec | `{planning_artifacts}/*spec-*.md` (whole) | FULL_LOAD |
|
||||||
|
| Document Project | `{project_knowledge}/index.md` (sharded) | INDEX_GUIDED |
|
||||||
|
|
||||||
|
## Execution
|
||||||
|
|
||||||
|
### Document Discovery - Loading Project Artifacts
|
||||||
|
|
||||||
|
**Strategy**: Course correction needs broad project context to assess change impact accurately. Load all available planning artifacts.
|
||||||
|
|
||||||
|
**Discovery Process for FULL_LOAD documents (PRD, Epics, Architecture, UX Design, Spec):**
|
||||||
|
|
||||||
|
1. **Search for whole document first** - Look for files matching the whole-document pattern (e.g., `*prd*.md`, `*epic*.md`, `*architecture*.md`, `*ux*.md`, `*spec-*.md`)
|
||||||
|
2. **Check for sharded version** - If whole document not found, look for a directory with `index.md` (e.g., `prd/index.md`, `epics/index.md`)
|
||||||
|
3. **If sharded version found**:
|
||||||
|
- Read `index.md` to understand the document structure
|
||||||
|
- Read ALL section files listed in the index
|
||||||
|
- Process the combined content as a single document
|
||||||
|
4. **Priority**: If both whole and sharded versions exist, use the whole document
|
||||||
|
|
||||||
|
**Discovery Process for INDEX_GUIDED documents (Document Project):**
|
||||||
|
|
||||||
|
1. **Search for index file** - Look for `{project_knowledge}/index.md`
|
||||||
|
2. **If found**: Read the index to understand available documentation sections
|
||||||
|
3. **Selectively load sections** based on relevance to the change being analyzed — do NOT load everything, only sections that relate to the impacted areas
|
||||||
|
4. **This document is optional** — skip if `{project_knowledge}` does not exist (greenfield projects)
|
||||||
|
|
||||||
|
**Fuzzy matching**: Be flexible with document names — users may use variations like `prd.md`, `bmm-prd.md`, `product-requirements.md`, etc.
|
||||||
|
|
||||||
|
**Missing documents**: Not all documents may exist. PRD and Epics are essential; Architecture, UX Design, Spec, and Document Project are loaded if available. HALT if PRD or Epics cannot be found.
|
||||||
|
|
||||||
|
<workflow>
|
||||||
|
|
||||||
|
<step n="1" goal="Initialize Change Navigation">
|
||||||
|
<action>Confirm change trigger and gather user description of the issue</action>
|
||||||
|
<action>Ask: "What specific issue or change has been identified that requires navigation?"</action>
|
||||||
|
<action>Verify access to project documents:</action>
|
||||||
|
- PRD (Product Requirements Document) — required
|
||||||
|
- Current Epics and Stories — required
|
||||||
|
- Architecture documentation — optional, load if available
|
||||||
|
- UI/UX specifications — optional, load if available
|
||||||
|
<action>Ask user for mode preference:</action>
|
||||||
|
- **Incremental** (recommended): Refine each edit collaboratively
|
||||||
|
- **Batch**: Present all changes at once for review
|
||||||
|
<action>Store mode selection for use throughout workflow</action>
|
||||||
|
|
||||||
|
<action if="change trigger is unclear">HALT: "Cannot navigate change without clear understanding of the triggering issue. Please provide specific details about what needs to change and why."</action>
|
||||||
|
|
||||||
|
<action if="PRD or Epics are unavailable">HALT: "Need access to PRD and Epics to assess change impact. Please ensure these documents are accessible. Architecture and UI/UX will be used if available."</action>
|
||||||
|
</step>
|
||||||
|
|
||||||
|
<step n="2" goal="Execute Change Analysis Checklist">
|
||||||
|
<action>Read fully and follow the systematic analysis from: checklist.md</action>
|
||||||
|
<action>Work through each checklist section interactively with the user</action>
|
||||||
|
<action>Record status for each checklist item:</action>
|
||||||
|
- [x] Done - Item completed successfully
|
||||||
|
- [N/A] Skip - Item not applicable to this change
|
||||||
|
- [!] Action-needed - Item requires attention or follow-up
|
||||||
|
<action>Maintain running notes of findings and impacts discovered</action>
|
||||||
|
<action>Present checklist progress after each major section</action>
|
||||||
|
|
||||||
|
<action if="checklist cannot be completed">Identify blocking issues and work with user to resolve before continuing</action>
|
||||||
|
</step>
|
||||||
|
|
||||||
|
<step n="3" goal="Draft Specific Change Proposals">
|
||||||
|
<action>Based on checklist findings, create explicit edit proposals for each identified artifact</action>
|
||||||
|
|
||||||
|
<action>For Story changes:</action>
|
||||||
|
|
||||||
|
- Show old → new text format
|
||||||
|
- Include story ID and section being modified
|
||||||
|
- Provide rationale for each change
|
||||||
|
- Example format:
|
||||||
|
|
||||||
|
```
|
||||||
|
Story: [STORY-123] User Authentication
|
||||||
|
Section: Acceptance Criteria
|
||||||
|
|
||||||
|
OLD:
|
||||||
|
- User can log in with email/password
|
||||||
|
|
||||||
|
NEW:
|
||||||
|
- User can log in with email/password
|
||||||
|
- User can enable 2FA via authenticator app
|
||||||
|
|
||||||
|
Rationale: Security requirement identified during implementation
|
||||||
|
```
|
||||||
|
|
||||||
|
<action>For PRD modifications:</action>
|
||||||
|
|
||||||
|
- Specify exact sections to update
|
||||||
|
- Show current content and proposed changes
|
||||||
|
- Explain impact on MVP scope and requirements
|
||||||
|
|
||||||
|
<action>For Architecture changes:</action>
|
||||||
|
|
||||||
|
- Identify affected components, patterns, or technology choices
|
||||||
|
- Describe diagram updates needed
|
||||||
|
- Note any ripple effects on other components
|
||||||
|
|
||||||
|
<action>For UI/UX specification updates:</action>
|
||||||
|
|
||||||
|
- Reference specific screens or components
|
||||||
|
- Show wireframe or flow changes needed
|
||||||
|
- Connect changes to user experience impact
|
||||||
|
|
||||||
|
<check if="mode is Incremental">
|
||||||
|
<action>Present each edit proposal individually</action>
|
||||||
|
<ask>Review and refine this change? Options: Approve [a], Edit [e], Skip [s]</ask>
|
||||||
|
<action>Iterate on each proposal based on user feedback</action>
|
||||||
|
</check>
|
||||||
|
|
||||||
|
<action if="mode is Batch">Collect all edit proposals and present together at end of step</action>
|
||||||
|
|
||||||
|
</step>
|
||||||
|
|
||||||
|
<step n="4" goal="Generate Sprint Change Proposal">
|
||||||
|
<action>Compile comprehensive Sprint Change Proposal document with following sections:</action>
|
||||||
|
|
||||||
|
<action>Section 1: Issue Summary</action>
|
||||||
|
|
||||||
|
- Clear problem statement describing what triggered the change
|
||||||
|
- Context about when/how the issue was discovered
|
||||||
|
- Evidence or examples demonstrating the issue
|
||||||
|
|
||||||
|
<action>Section 2: Impact Analysis</action>
|
||||||
|
|
||||||
|
- Epic Impact: Which epics are affected and how
|
||||||
|
- Story Impact: Current and future stories requiring changes
|
||||||
|
- Artifact Conflicts: PRD, Architecture, UI/UX documents needing updates
|
||||||
|
- Technical Impact: Code, infrastructure, or deployment implications
|
||||||
|
|
||||||
|
<action>Section 3: Recommended Approach</action>
|
||||||
|
|
||||||
|
- Present chosen path forward from checklist evaluation:
|
||||||
|
- Direct Adjustment: Modify/add stories within existing plan
|
||||||
|
- Potential Rollback: Revert completed work to simplify resolution
|
||||||
|
- MVP Review: Reduce scope or modify goals
|
||||||
|
- Provide clear rationale for recommendation
|
||||||
|
- Include effort estimate, risk assessment, and timeline impact
|
||||||
|
|
||||||
|
<action>Section 4: Detailed Change Proposals</action>
|
||||||
|
|
||||||
|
- Include all refined edit proposals from Step 3
|
||||||
|
- Group by artifact type (Stories, PRD, Architecture, UI/UX)
|
||||||
|
- Ensure each change includes before/after and justification
|
||||||
|
|
||||||
|
<action>Section 5: Implementation Handoff</action>
|
||||||
|
|
||||||
|
- Categorize change scope:
|
||||||
|
- Minor: Direct implementation by Developer agent
|
||||||
|
- Moderate: Backlog reorganization needed (PO/DEV)
|
||||||
|
- Major: Fundamental replan required (PM/Architect)
|
||||||
|
- Specify handoff recipients and their responsibilities
|
||||||
|
- Define success criteria for implementation
|
||||||
|
|
||||||
|
<action>Present complete Sprint Change Proposal to user</action>
|
||||||
|
<action>Write Sprint Change Proposal document to {default_output_file}</action>
|
||||||
|
<ask>Review complete proposal. Continue [c] or Edit [e]?</ask>
|
||||||
|
</step>
|
||||||
|
|
||||||
|
<step n="5" goal="Finalize and Route for Implementation">
|
||||||
|
<action>Get explicit user approval for complete proposal</action>
|
||||||
|
<ask>Do you approve this Sprint Change Proposal for implementation? (yes/no/revise)</ask>
|
||||||
|
|
||||||
|
<check if="no or revise">
|
||||||
|
<action>Gather specific feedback on what needs adjustment</action>
|
||||||
|
<action>Return to appropriate step to address concerns</action>
|
||||||
|
<goto step="3">If changes needed to edit proposals</goto>
|
||||||
|
<goto step="4">If changes needed to overall proposal structure</goto>
|
||||||
|
|
||||||
|
</check>
|
||||||
|
|
||||||
|
<check if="yes the proposal is approved by the user">
|
||||||
|
<action>Finalize Sprint Change Proposal document</action>
|
||||||
|
<action>Determine change scope classification:</action>
|
||||||
|
|
||||||
|
- **Minor**: Can be implemented directly by Developer agent
|
||||||
|
- **Moderate**: Requires backlog reorganization and PO/DEV coordination
|
||||||
|
- **Major**: Needs fundamental replan with PM/Architect involvement
|
||||||
|
|
||||||
|
<action>Provide appropriate handoff based on scope:</action>
|
||||||
|
|
||||||
|
</check>
|
||||||
|
|
||||||
|
<check if="Minor scope">
|
||||||
|
<action>Route to: Developer agent for direct implementation</action>
|
||||||
|
<action>Deliverables: Finalized edit proposals and implementation tasks</action>
|
||||||
|
</check>
|
||||||
|
|
||||||
|
<check if="Moderate scope">
|
||||||
|
<action>Route to: Product Owner / Developer agents</action>
|
||||||
|
<action>Deliverables: Sprint Change Proposal + backlog reorganization plan</action>
|
||||||
|
</check>
|
||||||
|
|
||||||
|
<check if="Major scope">
|
||||||
|
<action>Route to: Product Manager / Solution Architect</action>
|
||||||
|
<action>Deliverables: Complete Sprint Change Proposal + escalation notice</action>
|
||||||
|
|
||||||
|
<action>Confirm handoff completion and next steps with user</action>
|
||||||
|
<action>Document handoff in workflow execution log</action>
|
||||||
|
</check>
|
||||||
|
|
||||||
|
</step>
|
||||||
|
|
||||||
|
<step n="6" goal="Workflow Completion">
|
||||||
|
<action>Summarize workflow execution:</action>
|
||||||
|
- Issue addressed: {{change_trigger}}
|
||||||
|
- Change scope: {{scope_classification}}
|
||||||
|
- Artifacts modified: {{list_of_artifacts}}
|
||||||
|
- Routed to: {{handoff_recipients}}
|
||||||
|
|
||||||
|
<action>Confirm all deliverables produced:</action>
|
||||||
|
|
||||||
|
- Sprint Change Proposal document
|
||||||
|
- Specific edit proposals with before/after
|
||||||
|
- Implementation handoff plan
|
||||||
|
|
||||||
|
<action>Report workflow completion to user with personalized message: "Correct Course workflow complete, {user_name}!"</action>
|
||||||
|
<action>Remind user of success criteria and next steps for Developer agent</action>
|
||||||
|
<action>Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` — if the resolved value is non-empty, follow it as the final terminal instruction before exiting.</action>
|
||||||
|
</step>
|
||||||
|
|
||||||
|
</workflow>
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,41 @@
|
||||||
|
# DO NOT EDIT -- overwritten on every update.
|
||||||
|
#
|
||||||
|
# Workflow customization surface for bmad-correct-course. Mirrors the
|
||||||
|
# agent customization shape under the [workflow] namespace.
|
||||||
|
|
||||||
|
[workflow]
|
||||||
|
|
||||||
|
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
||||||
|
# scalars: override wins • arrays (persistent_facts, activation_steps_*): append
|
||||||
|
# arrays-of-tables with `code`/`id`: replace matching items, append new ones.
|
||||||
|
|
||||||
|
# Steps to run before the standard activation (config load, greet).
|
||||||
|
# Overrides append. Use for pre-flight loads, compliance checks, etc.
|
||||||
|
|
||||||
|
activation_steps_prepend = []
|
||||||
|
|
||||||
|
# Steps to run after greet but before the workflow begins.
|
||||||
|
# Overrides append. Use for context-heavy setup that should happen
|
||||||
|
# once the user has been acknowledged.
|
||||||
|
|
||||||
|
activation_steps_append = []
|
||||||
|
|
||||||
|
# Persistent facts the workflow keeps in mind for the whole run
|
||||||
|
# (standards, compliance constraints, stylistic guardrails).
|
||||||
|
# Distinct from the runtime memory sidecar — these are static context
|
||||||
|
# loaded on activation. Overrides append.
|
||||||
|
#
|
||||||
|
# Each entry is either:
|
||||||
|
# - a literal sentence, e.g. "All sprint changes require PO sign-off before execution."
|
||||||
|
# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md"
|
||||||
|
# (glob patterns are supported; the file's contents are loaded and treated as facts).
|
||||||
|
|
||||||
|
persistent_facts = [
|
||||||
|
"file:{project-root}/**/project-context.md",
|
||||||
|
]
|
||||||
|
|
||||||
|
# Scalar: executed when the workflow reaches Step 6 (Workflow Completion),
|
||||||
|
# after the Sprint Change Proposal is finalized and handoff is confirmed. Override wins.
|
||||||
|
# Leave empty for no custom post-completion behavior.
|
||||||
|
|
||||||
|
on_complete = ""
|
||||||
|
|
@ -1,267 +0,0 @@
|
||||||
# Correct Course - Sprint Change Management Workflow
|
|
||||||
|
|
||||||
**Goal:** Manage significant changes during sprint execution by analyzing impact across all project artifacts and producing a structured Sprint Change Proposal.
|
|
||||||
|
|
||||||
**Your Role:** You are a Developer navigating change management. Analyze the triggering issue, assess impact across PRD, epics, architecture, and UX artifacts, and produce an actionable Sprint Change Proposal with clear handoff.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## INITIALIZATION
|
|
||||||
|
|
||||||
### Configuration Loading
|
|
||||||
|
|
||||||
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
|
||||||
|
|
||||||
- `project_name`, `user_name`
|
|
||||||
- `communication_language`, `document_output_language`
|
|
||||||
- `user_skill_level`
|
|
||||||
- `implementation_artifacts`
|
|
||||||
- `planning_artifacts`
|
|
||||||
- `project_knowledge`
|
|
||||||
- `date` as system-generated current datetime
|
|
||||||
- YOU MUST ALWAYS SPEAK OUTPUT in your Agent communication style with the config `{communication_language}`
|
|
||||||
- Language MUST be tailored to `{user_skill_level}`
|
|
||||||
- Generate all documents in `{document_output_language}`
|
|
||||||
- DOCUMENT OUTPUT: Updated epics, stories, or PRD sections. Clear, actionable changes. User skill level (`{user_skill_level}`) affects conversation style ONLY, not document updates.
|
|
||||||
|
|
||||||
### Paths
|
|
||||||
|
|
||||||
- `default_output_file` = `{planning_artifacts}/sprint-change-proposal-{date}.md`
|
|
||||||
|
|
||||||
### Input Files
|
|
||||||
|
|
||||||
| Input | Path | Load Strategy |
|
|
||||||
|-------|------|---------------|
|
|
||||||
| PRD | `{planning_artifacts}/*prd*.md` (whole) or `{planning_artifacts}/*prd*/*.md` (sharded) | FULL_LOAD |
|
|
||||||
| Epics | `{planning_artifacts}/*epic*.md` (whole) or `{planning_artifacts}/*epic*/*.md` (sharded) | FULL_LOAD |
|
|
||||||
| Architecture | `{planning_artifacts}/*architecture*.md` (whole) or `{planning_artifacts}/*architecture*/*.md` (sharded) | FULL_LOAD |
|
|
||||||
| UX Design | `{planning_artifacts}/*ux*.md` (whole) or `{planning_artifacts}/*ux*/*.md` (sharded) | FULL_LOAD |
|
|
||||||
| Spec | `{planning_artifacts}/*spec-*.md` (whole) | FULL_LOAD |
|
|
||||||
| Document Project | `{project_knowledge}/index.md` (sharded) | INDEX_GUIDED |
|
|
||||||
|
|
||||||
### Context
|
|
||||||
|
|
||||||
- Load `**/project-context.md` if it exists
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## EXECUTION
|
|
||||||
|
|
||||||
### Document Discovery - Loading Project Artifacts
|
|
||||||
|
|
||||||
**Strategy**: Course correction needs broad project context to assess change impact accurately. Load all available planning artifacts.
|
|
||||||
|
|
||||||
**Discovery Process for FULL_LOAD documents (PRD, Epics, Architecture, UX Design, Spec):**
|
|
||||||
|
|
||||||
1. **Search for whole document first** - Look for files matching the whole-document pattern (e.g., `*prd*.md`, `*epic*.md`, `*architecture*.md`, `*ux*.md`, `*spec-*.md`)
|
|
||||||
2. **Check for sharded version** - If whole document not found, look for a directory with `index.md` (e.g., `prd/index.md`, `epics/index.md`)
|
|
||||||
3. **If sharded version found**:
|
|
||||||
- Read `index.md` to understand the document structure
|
|
||||||
- Read ALL section files listed in the index
|
|
||||||
- Process the combined content as a single document
|
|
||||||
4. **Priority**: If both whole and sharded versions exist, use the whole document
|
|
||||||
|
|
||||||
**Discovery Process for INDEX_GUIDED documents (Document Project):**
|
|
||||||
|
|
||||||
1. **Search for index file** - Look for `{project_knowledge}/index.md`
|
|
||||||
2. **If found**: Read the index to understand available documentation sections
|
|
||||||
3. **Selectively load sections** based on relevance to the change being analyzed — do NOT load everything, only sections that relate to the impacted areas
|
|
||||||
4. **This document is optional** — skip if `{project_knowledge}` does not exist (greenfield projects)
|
|
||||||
|
|
||||||
**Fuzzy matching**: Be flexible with document names — users may use variations like `prd.md`, `bmm-prd.md`, `product-requirements.md`, etc.
|
|
||||||
|
|
||||||
**Missing documents**: Not all documents may exist. PRD and Epics are essential; Architecture, UX Design, Spec, and Document Project are loaded if available. HALT if PRD or Epics cannot be found.
|
|
||||||
|
|
||||||
<workflow>
|
|
||||||
|
|
||||||
<step n="1" goal="Initialize Change Navigation">
|
|
||||||
<action>Load **/project-context.md for coding standards and project-wide patterns (if exists)</action>
|
|
||||||
<action>Confirm change trigger and gather user description of the issue</action>
|
|
||||||
<action>Ask: "What specific issue or change has been identified that requires navigation?"</action>
|
|
||||||
<action>Verify access to required project documents:</action>
|
|
||||||
- PRD (Product Requirements Document)
|
|
||||||
- Current Epics and Stories
|
|
||||||
- Architecture documentation
|
|
||||||
- UI/UX specifications
|
|
||||||
<action>Ask user for mode preference:</action>
|
|
||||||
- **Incremental** (recommended): Refine each edit collaboratively
|
|
||||||
- **Batch**: Present all changes at once for review
|
|
||||||
<action>Store mode selection for use throughout workflow</action>
|
|
||||||
|
|
||||||
<action if="change trigger is unclear">HALT: "Cannot navigate change without clear understanding of the triggering issue. Please provide specific details about what needs to change and why."</action>
|
|
||||||
|
|
||||||
<action if="core documents are unavailable">HALT: "Need access to project documents (PRD, Epics, Architecture, UI/UX) to assess change impact. Please ensure these documents are accessible."</action>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="2" goal="Execute Change Analysis Checklist">
|
|
||||||
<action>Read fully and follow the systematic analysis from: checklist.md</action>
|
|
||||||
<action>Work through each checklist section interactively with the user</action>
|
|
||||||
<action>Record status for each checklist item:</action>
|
|
||||||
- [x] Done - Item completed successfully
|
|
||||||
- [N/A] Skip - Item not applicable to this change
|
|
||||||
- [!] Action-needed - Item requires attention or follow-up
|
|
||||||
<action>Maintain running notes of findings and impacts discovered</action>
|
|
||||||
<action>Present checklist progress after each major section</action>
|
|
||||||
|
|
||||||
<action if="checklist cannot be completed">Identify blocking issues and work with user to resolve before continuing</action>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="3" goal="Draft Specific Change Proposals">
|
|
||||||
<action>Based on checklist findings, create explicit edit proposals for each identified artifact</action>
|
|
||||||
|
|
||||||
<action>For Story changes:</action>
|
|
||||||
|
|
||||||
- Show old → new text format
|
|
||||||
- Include story ID and section being modified
|
|
||||||
- Provide rationale for each change
|
|
||||||
- Example format:
|
|
||||||
|
|
||||||
```
|
|
||||||
Story: [STORY-123] User Authentication
|
|
||||||
Section: Acceptance Criteria
|
|
||||||
|
|
||||||
OLD:
|
|
||||||
- User can log in with email/password
|
|
||||||
|
|
||||||
NEW:
|
|
||||||
- User can log in with email/password
|
|
||||||
- User can enable 2FA via authenticator app
|
|
||||||
|
|
||||||
Rationale: Security requirement identified during implementation
|
|
||||||
```
|
|
||||||
|
|
||||||
<action>For PRD modifications:</action>
|
|
||||||
|
|
||||||
- Specify exact sections to update
|
|
||||||
- Show current content and proposed changes
|
|
||||||
- Explain impact on MVP scope and requirements
|
|
||||||
|
|
||||||
<action>For Architecture changes:</action>
|
|
||||||
|
|
||||||
- Identify affected components, patterns, or technology choices
|
|
||||||
- Describe diagram updates needed
|
|
||||||
- Note any ripple effects on other components
|
|
||||||
|
|
||||||
<action>For UI/UX specification updates:</action>
|
|
||||||
|
|
||||||
- Reference specific screens or components
|
|
||||||
- Show wireframe or flow changes needed
|
|
||||||
- Connect changes to user experience impact
|
|
||||||
|
|
||||||
<check if="mode is Incremental">
|
|
||||||
<action>Present each edit proposal individually</action>
|
|
||||||
<ask>Review and refine this change? Options: Approve [a], Edit [e], Skip [s]</ask>
|
|
||||||
<action>Iterate on each proposal based on user feedback</action>
|
|
||||||
</check>
|
|
||||||
|
|
||||||
<action if="mode is Batch">Collect all edit proposals and present together at end of step</action>
|
|
||||||
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="4" goal="Generate Sprint Change Proposal">
|
|
||||||
<action>Compile comprehensive Sprint Change Proposal document with following sections:</action>
|
|
||||||
|
|
||||||
<action>Section 1: Issue Summary</action>
|
|
||||||
|
|
||||||
- Clear problem statement describing what triggered the change
|
|
||||||
- Context about when/how the issue was discovered
|
|
||||||
- Evidence or examples demonstrating the issue
|
|
||||||
|
|
||||||
<action>Section 2: Impact Analysis</action>
|
|
||||||
|
|
||||||
- Epic Impact: Which epics are affected and how
|
|
||||||
- Story Impact: Current and future stories requiring changes
|
|
||||||
- Artifact Conflicts: PRD, Architecture, UI/UX documents needing updates
|
|
||||||
- Technical Impact: Code, infrastructure, or deployment implications
|
|
||||||
|
|
||||||
<action>Section 3: Recommended Approach</action>
|
|
||||||
|
|
||||||
- Present chosen path forward from checklist evaluation:
|
|
||||||
- Direct Adjustment: Modify/add stories within existing plan
|
|
||||||
- Potential Rollback: Revert completed work to simplify resolution
|
|
||||||
- MVP Review: Reduce scope or modify goals
|
|
||||||
- Provide clear rationale for recommendation
|
|
||||||
- Include effort estimate, risk assessment, and timeline impact
|
|
||||||
|
|
||||||
<action>Section 4: Detailed Change Proposals</action>
|
|
||||||
|
|
||||||
- Include all refined edit proposals from Step 3
|
|
||||||
- Group by artifact type (Stories, PRD, Architecture, UI/UX)
|
|
||||||
- Ensure each change includes before/after and justification
|
|
||||||
|
|
||||||
<action>Section 5: Implementation Handoff</action>
|
|
||||||
|
|
||||||
- Categorize change scope:
|
|
||||||
- Minor: Direct implementation by Developer agent
|
|
||||||
- Moderate: Backlog reorganization needed (PO/DEV)
|
|
||||||
- Major: Fundamental replan required (PM/Architect)
|
|
||||||
- Specify handoff recipients and their responsibilities
|
|
||||||
- Define success criteria for implementation
|
|
||||||
|
|
||||||
<action>Present complete Sprint Change Proposal to user</action>
|
|
||||||
<action>Write Sprint Change Proposal document to {default_output_file}</action>
|
|
||||||
<ask>Review complete proposal. Continue [c] or Edit [e]?</ask>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="5" goal="Finalize and Route for Implementation">
|
|
||||||
<action>Get explicit user approval for complete proposal</action>
|
|
||||||
<ask>Do you approve this Sprint Change Proposal for implementation? (yes/no/revise)</ask>
|
|
||||||
|
|
||||||
<check if="no or revise">
|
|
||||||
<action>Gather specific feedback on what needs adjustment</action>
|
|
||||||
<action>Return to appropriate step to address concerns</action>
|
|
||||||
<goto step="3">If changes needed to edit proposals</goto>
|
|
||||||
<goto step="4">If changes needed to overall proposal structure</goto>
|
|
||||||
|
|
||||||
</check>
|
|
||||||
|
|
||||||
<check if="yes the proposal is approved by the user">
|
|
||||||
<action>Finalize Sprint Change Proposal document</action>
|
|
||||||
<action>Determine change scope classification:</action>
|
|
||||||
|
|
||||||
- **Minor**: Can be implemented directly by Developer agent
|
|
||||||
- **Moderate**: Requires backlog reorganization and PO/DEV coordination
|
|
||||||
- **Major**: Needs fundamental replan with PM/Architect involvement
|
|
||||||
|
|
||||||
<action>Provide appropriate handoff based on scope:</action>
|
|
||||||
|
|
||||||
</check>
|
|
||||||
|
|
||||||
<check if="Minor scope">
|
|
||||||
<action>Route to: Developer agent for direct implementation</action>
|
|
||||||
<action>Deliverables: Finalized edit proposals and implementation tasks</action>
|
|
||||||
</check>
|
|
||||||
|
|
||||||
<check if="Moderate scope">
|
|
||||||
<action>Route to: Product Owner / Developer agents</action>
|
|
||||||
<action>Deliverables: Sprint Change Proposal + backlog reorganization plan</action>
|
|
||||||
</check>
|
|
||||||
|
|
||||||
<check if="Major scope">
|
|
||||||
<action>Route to: Product Manager / Solution Architect</action>
|
|
||||||
<action>Deliverables: Complete Sprint Change Proposal + escalation notice</action>
|
|
||||||
|
|
||||||
<action>Confirm handoff completion and next steps with user</action>
|
|
||||||
<action>Document handoff in workflow execution log</action>
|
|
||||||
</check>
|
|
||||||
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="6" goal="Workflow Completion">
|
|
||||||
<action>Summarize workflow execution:</action>
|
|
||||||
- Issue addressed: {{change_trigger}}
|
|
||||||
- Change scope: {{scope_classification}}
|
|
||||||
- Artifacts modified: {{list_of_artifacts}}
|
|
||||||
- Routed to: {{handoff_recipients}}
|
|
||||||
|
|
||||||
<action>Confirm all deliverables produced:</action>
|
|
||||||
|
|
||||||
- Sprint Change Proposal document
|
|
||||||
- Specific edit proposals with before/after
|
|
||||||
- Implementation handoff plan
|
|
||||||
|
|
||||||
<action>Report workflow completion to user with personalized message: "Correct Course workflow complete, {user_name}!"</action>
|
|
||||||
<action>Remind user of success criteria and next steps for Developer agent</action>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
</workflow>
|
|
||||||
|
|
@ -3,4 +3,415 @@ name: bmad-create-story
|
||||||
description: 'Creates a dedicated story file with all the context the agent will need to implement it later. Use when the user says "create the next story" or "create story [story identifier]"'
|
description: 'Creates a dedicated story file with all the context the agent will need to implement it later. Use when the user says "create the next story" or "create story [story identifier]"'
|
||||||
---
|
---
|
||||||
|
|
||||||
Follow the instructions in ./workflow.md.
|
# Create Story Workflow
|
||||||
|
|
||||||
|
**Goal:** Create a comprehensive story file that gives the dev agent everything needed for flawless implementation.
|
||||||
|
|
||||||
|
**Your Role:** Story context engine that prevents LLM developer mistakes, omissions, or disasters.
|
||||||
|
- Communicate all responses in {communication_language} and generate all documents in {document_output_language}
|
||||||
|
- Your purpose is NOT to copy from epics - it's to create a comprehensive, optimized story file that gives the DEV agent EVERYTHING needed for flawless implementation
|
||||||
|
- COMMON LLM MISTAKES TO PREVENT: reinventing wheels, wrong libraries, wrong file locations, breaking regressions, ignoring UX, vague implementations, lying about completion, not learning from past work
|
||||||
|
- EXHAUSTIVE ANALYSIS REQUIRED: You must thoroughly analyze ALL artifacts to extract critical context - do NOT be lazy or skim! This is the most important function in the entire development process!
|
||||||
|
- UTILIZE SUBPROCESSES AND SUBAGENTS: Use research subagents, subprocesses or parallel processing if available to thoroughly analyze different artifacts simultaneously and thoroughly
|
||||||
|
- SAVE QUESTIONS: If you think of questions or clarifications during analysis, save them for the end after the complete story is written
|
||||||
|
- ZERO USER INTERVENTION: Process should be fully automated except for initial epic/story selection or missing documents
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- Bare paths (e.g. `discover-inputs.md`) resolve from the skill root.
|
||||||
|
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
||||||
|
- `{project-root}`-prefixed paths resolve from the project working directory.
|
||||||
|
- `{skill-name}` resolves to the skill directory's basename.
|
||||||
|
|
||||||
|
## On Activation
|
||||||
|
|
||||||
|
### Step 1: Resolve the Workflow Block
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
||||||
|
|
||||||
|
**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:
|
||||||
|
|
||||||
|
1. `{skill-root}/customize.toml` — defaults
|
||||||
|
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
||||||
|
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 2: Execute Prepend Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
||||||
|
|
||||||
|
### Step 3: Load Persistent Facts
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 4: Load Config
|
||||||
|
|
||||||
|
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||||
|
|
||||||
|
- `project_name`, `user_name`
|
||||||
|
- `communication_language`, `document_output_language`
|
||||||
|
- `user_skill_level`
|
||||||
|
- `planning_artifacts`, `implementation_artifacts`
|
||||||
|
- `date` as system-generated current datetime
|
||||||
|
|
||||||
|
### Step 5: Greet the User
|
||||||
|
|
||||||
|
Greet `{user_name}`, speaking in `{communication_language}`.
|
||||||
|
|
||||||
|
### Step 6: Execute Append Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_append}` in order.
|
||||||
|
|
||||||
|
Activation is complete. Begin the workflow below.
|
||||||
|
|
||||||
|
## Paths
|
||||||
|
|
||||||
|
- `sprint_status` = `{implementation_artifacts}/sprint-status.yaml`
|
||||||
|
- `epics_file` = `{planning_artifacts}/epics.md`
|
||||||
|
- `prd_file` = `{planning_artifacts}/prd.md`
|
||||||
|
- `architecture_file` = `{planning_artifacts}/architecture.md`
|
||||||
|
- `ux_file` = `{planning_artifacts}/*ux*.md`
|
||||||
|
- `story_title` = "" (will be elicited if not derivable)
|
||||||
|
- `default_output_file` = `{implementation_artifacts}/{{story_key}}.md`
|
||||||
|
|
||||||
|
## Input Files
|
||||||
|
|
||||||
|
| Input | Description | Path Pattern(s) | Load Strategy |
|
||||||
|
|-------|-------------|------------------|---------------|
|
||||||
|
| prd | PRD (fallback - epics file should have most content) | whole: `{planning_artifacts}/*prd*.md`, sharded: `{planning_artifacts}/*prd*/*.md` | SELECTIVE_LOAD |
|
||||||
|
| architecture | Architecture (fallback - epics file should have relevant sections) | whole: `{planning_artifacts}/*architecture*.md`, sharded: `{planning_artifacts}/*architecture*/*.md` | SELECTIVE_LOAD |
|
||||||
|
| ux | UX design (fallback - epics file should have relevant sections) | whole: `{planning_artifacts}/*ux*.md`, sharded: `{planning_artifacts}/*ux*/*.md` | SELECTIVE_LOAD |
|
||||||
|
| epics | Enhanced epics+stories file with BDD and source hints | whole: `{planning_artifacts}/*epic*.md`, sharded: `{planning_artifacts}/*epic*/*.md` | SELECTIVE_LOAD |
|
||||||
|
|
||||||
|
## Execution
|
||||||
|
|
||||||
|
<workflow>
|
||||||
|
|
||||||
|
<step n="1" goal="Determine target story">
|
||||||
|
<check if="{{story_path}} is provided by user or user provided the epic and story number such as 2-4 or 1.6 or epic 1 story 5">
|
||||||
|
<action>Parse user-provided story path: extract epic_num, story_num, story_title from format like "1-2-user-auth"</action>
|
||||||
|
<action>Set {{epic_num}}, {{story_num}}, {{story_key}} from user input</action>
|
||||||
|
<action>GOTO step 2a</action>
|
||||||
|
</check>
|
||||||
|
|
||||||
|
<action>Check if {{sprint_status}} file exists for auto discover</action>
|
||||||
|
<check if="sprint status file does NOT exist">
|
||||||
|
<output>🚫 No sprint status file found and no story specified</output>
|
||||||
|
<output>
|
||||||
|
**Required Options:**
|
||||||
|
1. Run `sprint-planning` to initialize sprint tracking (recommended)
|
||||||
|
2. Provide specific epic-story number to create (e.g., "1-2-user-auth")
|
||||||
|
3. Provide path to story documents if sprint status doesn't exist yet
|
||||||
|
</output>
|
||||||
|
<ask>Choose option [1], provide epic-story number, path to story docs, or [q] to quit:</ask>
|
||||||
|
|
||||||
|
<check if="user chooses 'q'">
|
||||||
|
<action>HALT - No work needed</action>
|
||||||
|
</check>
|
||||||
|
|
||||||
|
<check if="user chooses '1'">
|
||||||
|
<output>Run sprint-planning workflow first to create sprint-status.yaml</output>
|
||||||
|
<action>HALT - User needs to run sprint-planning</action>
|
||||||
|
</check>
|
||||||
|
|
||||||
|
<check if="user provides epic-story number">
|
||||||
|
<action>Parse user input: extract epic_num, story_num, story_title</action>
|
||||||
|
<action>Set {{epic_num}}, {{story_num}}, {{story_key}} from user input</action>
|
||||||
|
<action>GOTO step 2a</action>
|
||||||
|
</check>
|
||||||
|
|
||||||
|
<check if="user provides story docs path">
|
||||||
|
<action>Use user-provided path for story documents</action>
|
||||||
|
<action>GOTO step 2a</action>
|
||||||
|
</check>
|
||||||
|
</check>
|
||||||
|
|
||||||
|
<!-- Auto-discover from sprint status only if no user input -->
|
||||||
|
<check if="no user input provided">
|
||||||
|
<critical>MUST read COMPLETE {sprint_status} file from start to end to preserve order</critical>
|
||||||
|
<action>Load the FULL file: {{sprint_status}}</action>
|
||||||
|
<action>Read ALL lines from beginning to end - do not skip any content</action>
|
||||||
|
<action>Parse the development_status section completely</action>
|
||||||
|
|
||||||
|
<action>Find the FIRST story (by reading in order from top to bottom) where:
|
||||||
|
- Key matches pattern: number-number-name (e.g., "1-2-user-auth")
|
||||||
|
- NOT an epic key (epic-X) or retrospective (epic-X-retrospective)
|
||||||
|
- Status value equals "backlog"
|
||||||
|
</action>
|
||||||
|
|
||||||
|
<check if="no backlog story found">
|
||||||
|
<output>📋 No backlog stories found in sprint-status.yaml
|
||||||
|
|
||||||
|
All stories are either already created, in progress, or done.
|
||||||
|
|
||||||
|
**Options:**
|
||||||
|
1. Run sprint-planning to refresh story tracking
|
||||||
|
2. Load PM agent and run correct-course to add more stories
|
||||||
|
3. Check if current sprint is complete and run retrospective
|
||||||
|
</output>
|
||||||
|
<action>HALT</action>
|
||||||
|
</check>
|
||||||
|
|
||||||
|
<action>Extract from found story key (e.g., "1-2-user-authentication"):
|
||||||
|
- epic_num: first number before dash (e.g., "1")
|
||||||
|
- story_num: second number after first dash (e.g., "2")
|
||||||
|
- story_title: remainder after second dash (e.g., "user-authentication")
|
||||||
|
</action>
|
||||||
|
<action>Set {{story_id}} = "{{epic_num}}.{{story_num}}"</action>
|
||||||
|
<action>Store story_key for later use (e.g., "1-2-user-authentication")</action>
|
||||||
|
|
||||||
|
<!-- Mark epic as in-progress if this is first story -->
|
||||||
|
<action>Check if this is the first story in epic {{epic_num}} by looking for {{epic_num}}-1-* pattern</action>
|
||||||
|
<check if="this is first story in epic {{epic_num}}">
|
||||||
|
<action>Load {{sprint_status}} and check epic-{{epic_num}} status</action>
|
||||||
|
<action>If epic status is "backlog" → update to "in-progress"</action>
|
||||||
|
<action>If epic status is "contexted" (legacy status) → update to "in-progress" (backward compatibility)</action>
|
||||||
|
<action>If epic status is "in-progress" → no change needed</action>
|
||||||
|
<check if="epic status is 'done'">
|
||||||
|
<output>🚫 ERROR: Cannot create story in completed epic</output>
|
||||||
|
<output>Epic {{epic_num}} is marked as 'done'. All stories are complete.</output>
|
||||||
|
<output>If you need to add more work, either:</output>
|
||||||
|
<output>1. Manually change epic status back to 'in-progress' in sprint-status.yaml</output>
|
||||||
|
<output>2. Create a new epic for additional work</output>
|
||||||
|
<action>HALT - Cannot proceed</action>
|
||||||
|
</check>
|
||||||
|
<check if="epic status is not one of: backlog, contexted, in-progress, done">
|
||||||
|
<output>🚫 ERROR: Invalid epic status '{{epic_status}}'</output>
|
||||||
|
<output>Epic {{epic_num}} has invalid status. Expected: backlog, in-progress, or done</output>
|
||||||
|
<output>Please fix sprint-status.yaml manually or run sprint-planning to regenerate</output>
|
||||||
|
<action>HALT - Cannot proceed</action>
|
||||||
|
</check>
|
||||||
|
<output>📊 Epic {{epic_num}} status updated to in-progress</output>
|
||||||
|
</check>
|
||||||
|
|
||||||
|
<action>GOTO step 2a</action>
|
||||||
|
</check>
|
||||||
|
<action>Load the FULL file: {{sprint_status}}</action>
|
||||||
|
<action>Read ALL lines from beginning to end - do not skip any content</action>
|
||||||
|
<action>Parse the development_status section completely</action>
|
||||||
|
|
||||||
|
<action>Find the FIRST story (by reading in order from top to bottom) where:
|
||||||
|
- Key matches pattern: number-number-name (e.g., "1-2-user-auth")
|
||||||
|
- NOT an epic key (epic-X) or retrospective (epic-X-retrospective)
|
||||||
|
- Status value equals "backlog"
|
||||||
|
</action>
|
||||||
|
|
||||||
|
<check if="no backlog story found">
|
||||||
|
<output>No backlog stories found in sprint-status.yaml
|
||||||
|
|
||||||
|
All stories are either already created, in progress, or done.
|
||||||
|
|
||||||
|
**Options:**
|
||||||
|
1. Run sprint-planning to refresh story tracking
|
||||||
|
2. Load PM agent and run correct-course to add more stories
|
||||||
|
3. Check if current sprint is complete and run retrospective
|
||||||
|
</output>
|
||||||
|
<action>HALT</action>
|
||||||
|
</check>
|
||||||
|
|
||||||
|
<action>Extract from found story key (e.g., "1-2-user-authentication"):
|
||||||
|
- epic_num: first number before dash (e.g., "1")
|
||||||
|
- story_num: second number after first dash (e.g., "2")
|
||||||
|
- story_title: remainder after second dash (e.g., "user-authentication")
|
||||||
|
</action>
|
||||||
|
<action>Set {{story_id}} = "{{epic_num}}.{{story_num}}"</action>
|
||||||
|
<action>Store story_key for later use (e.g., "1-2-user-authentication")</action>
|
||||||
|
|
||||||
|
<!-- Mark epic as in-progress if this is first story -->
|
||||||
|
<action>Check if this is the first story in epic {{epic_num}} by looking for {{epic_num}}-1-* pattern</action>
|
||||||
|
<check if="this is first story in epic {{epic_num}}">
|
||||||
|
<action>Load {{sprint_status}} and check epic-{{epic_num}} status</action>
|
||||||
|
<action>If epic status is "backlog" → update to "in-progress"</action>
|
||||||
|
<action>If epic status is "contexted" (legacy status) → update to "in-progress" (backward compatibility)</action>
|
||||||
|
<action>If epic status is "in-progress" → no change needed</action>
|
||||||
|
<check if="epic status is 'done'">
|
||||||
|
<output>ERROR: Cannot create story in completed epic</output>
|
||||||
|
<output>Epic {{epic_num}} is marked as 'done'. All stories are complete.</output>
|
||||||
|
<output>If you need to add more work, either:</output>
|
||||||
|
<output>1. Manually change epic status back to 'in-progress' in sprint-status.yaml</output>
|
||||||
|
<output>2. Create a new epic for additional work</output>
|
||||||
|
<action>HALT - Cannot proceed</action>
|
||||||
|
</check>
|
||||||
|
<check if="epic status is not one of: backlog, contexted, in-progress, done">
|
||||||
|
<output>ERROR: Invalid epic status '{{epic_status}}'</output>
|
||||||
|
<output>Epic {{epic_num}} has invalid status. Expected: backlog, in-progress, or done</output>
|
||||||
|
<output>Please fix sprint-status.yaml manually or run sprint-planning to regenerate</output>
|
||||||
|
<action>HALT - Cannot proceed</action>
|
||||||
|
</check>
|
||||||
|
<output>Epic {{epic_num}} status updated to in-progress</output>
|
||||||
|
</check>
|
||||||
|
|
||||||
|
<action>GOTO step 2a</action>
|
||||||
|
</step>
|
||||||
|
|
||||||
|
<step n="2" goal="Load and analyze core artifacts">
|
||||||
|
<critical>🔬 EXHAUSTIVE ARTIFACT ANALYSIS - This is where you prevent future developer mistakes!</critical>
|
||||||
|
|
||||||
|
<!-- Load all available content through discovery protocol -->
|
||||||
|
<action>Read fully and follow `./discover-inputs.md` to load all input files</action>
|
||||||
|
<note>Available content: {epics_content}, {prd_content}, {architecture_content}, {ux_content}, plus the project-context facts loaded during activation via `persistent_facts`.</note>
|
||||||
|
|
||||||
|
<!-- Analyze epics file for story foundation -->
|
||||||
|
<action>From {epics_content}, extract Epic {{epic_num}} complete context:</action> **EPIC ANALYSIS:** - Epic
|
||||||
|
objectives and business value - ALL stories in this epic for cross-story context - Our specific story's requirements, user story
|
||||||
|
statement, acceptance criteria - Technical requirements and constraints - Dependencies on other stories/epics - Source hints pointing to
|
||||||
|
original documents <!-- Extract specific story requirements -->
|
||||||
|
<action>Extract our story ({{epic_num}}-{{story_num}}) details:</action> **STORY FOUNDATION:** - User story statement
|
||||||
|
(As a, I want, so that) - Detailed acceptance criteria (already BDD formatted) - Technical requirements specific to this story -
|
||||||
|
Business context and value - Success criteria <!-- Previous story analysis for context continuity -->
|
||||||
|
<check if="story_num > 1">
|
||||||
|
<action>Find {{previous_story_num}}: scan {implementation_artifacts} for the story file in epic {{epic_num}} with the highest story number less than {{story_num}}</action>
|
||||||
|
<action>Load previous story file: {implementation_artifacts}/{{epic_num}}-{{previous_story_num}}-*.md</action> **PREVIOUS STORY INTELLIGENCE:** -
|
||||||
|
Dev notes and learnings from previous story - Review feedback and corrections needed - Files that were created/modified and their
|
||||||
|
patterns - Testing approaches that worked/didn't work - Problems encountered and solutions found - Code patterns established <action>Extract
|
||||||
|
all learnings that could impact current story implementation</action>
|
||||||
|
</check>
|
||||||
|
|
||||||
|
<!-- Git intelligence for previous work patterns -->
|
||||||
|
<check
|
||||||
|
if="previous story exists AND git repository detected">
|
||||||
|
<action>Get last 5 commit titles to understand recent work patterns</action>
|
||||||
|
<action>Analyze 1-5 most recent commits for relevance to current story:
|
||||||
|
- Files created/modified
|
||||||
|
- Code patterns and conventions used
|
||||||
|
- Library dependencies added/changed
|
||||||
|
- Architecture decisions implemented
|
||||||
|
- Testing approaches used
|
||||||
|
</action>
|
||||||
|
<action>Extract actionable insights for current story implementation</action>
|
||||||
|
</check>
|
||||||
|
</step>
|
||||||
|
|
||||||
|
<step n="3" goal="Architecture analysis for developer guardrails">
|
||||||
|
<critical>🏗️ ARCHITECTURE INTELLIGENCE - Extract everything the developer MUST follow!</critical> **ARCHITECTURE DOCUMENT ANALYSIS:** <action>Systematically
|
||||||
|
analyze architecture content for story-relevant requirements:</action>
|
||||||
|
|
||||||
|
<!-- Load architecture - single file or sharded -->
|
||||||
|
<check if="architecture file is single file">
|
||||||
|
<action>Load complete {architecture_content}</action>
|
||||||
|
</check>
|
||||||
|
<check if="architecture is sharded to folder">
|
||||||
|
<action>Load architecture index and scan all architecture files</action>
|
||||||
|
</check> **CRITICAL ARCHITECTURE EXTRACTION:** <action>For
|
||||||
|
each architecture section, determine if relevant to this story:</action> - **Technical Stack:** Languages, frameworks, libraries with
|
||||||
|
versions - **Code Structure:** Folder organization, naming conventions, file patterns - **API Patterns:** Service structure, endpoint
|
||||||
|
patterns, data contracts - **Database Schemas:** Tables, relationships, constraints relevant to story - **Security Requirements:**
|
||||||
|
Authentication patterns, authorization rules - **Performance Requirements:** Caching strategies, optimization patterns - **Testing
|
||||||
|
Standards:** Testing frameworks, coverage expectations, test patterns - **Deployment Patterns:** Environment configurations, build
|
||||||
|
processes - **Integration Patterns:** External service integrations, data flows <action>Extract any story-specific requirements that the
|
||||||
|
developer MUST follow</action>
|
||||||
|
<action>Identify any architectural decisions that override previous patterns</action>
|
||||||
|
</step>
|
||||||
|
|
||||||
|
<step n="4" goal="Web research for latest technical specifics">
|
||||||
|
<critical>🌐 ENSURE LATEST TECH KNOWLEDGE - Prevent outdated implementations!</critical> **WEB INTELLIGENCE:** <action>Identify specific
|
||||||
|
technical areas that require latest version knowledge:</action>
|
||||||
|
|
||||||
|
<!-- Check for libraries/frameworks mentioned in architecture -->
|
||||||
|
<action>From architecture analysis, identify specific libraries, APIs, or
|
||||||
|
frameworks</action>
|
||||||
|
<action>For each critical technology, research latest stable version and key changes:
|
||||||
|
- Latest API documentation and breaking changes
|
||||||
|
- Security vulnerabilities or updates
|
||||||
|
- Performance improvements or deprecations
|
||||||
|
- Best practices for current version
|
||||||
|
</action>
|
||||||
|
**EXTERNAL CONTEXT INCLUSION:** <action>Include in story any critical latest information the developer needs:
|
||||||
|
- Specific library versions and why chosen
|
||||||
|
- API endpoints with parameters and authentication
|
||||||
|
- Recent security patches or considerations
|
||||||
|
- Performance optimization techniques
|
||||||
|
- Migration considerations if upgrading
|
||||||
|
</action>
|
||||||
|
</step>
|
||||||
|
|
||||||
|
<step n="5" goal="Create comprehensive story file">
|
||||||
|
<critical>📝 CREATE ULTIMATE STORY FILE - The developer's master implementation guide!</critical>
|
||||||
|
|
||||||
|
<action>Initialize from template.md:
|
||||||
|
{default_output_file}</action>
|
||||||
|
<template-output file="{default_output_file}">story_header</template-output>
|
||||||
|
|
||||||
|
<!-- Story foundation from epics analysis -->
|
||||||
|
<template-output
|
||||||
|
file="{default_output_file}">story_requirements</template-output>
|
||||||
|
|
||||||
|
<!-- Developer context section - MOST IMPORTANT PART -->
|
||||||
|
<template-output file="{default_output_file}">
|
||||||
|
developer_context_section</template-output> **DEV AGENT GUARDRAILS:** <template-output file="{default_output_file}">
|
||||||
|
technical_requirements</template-output>
|
||||||
|
<template-output file="{default_output_file}">architecture_compliance</template-output>
|
||||||
|
<template-output
|
||||||
|
file="{default_output_file}">library_framework_requirements</template-output>
|
||||||
|
<template-output file="{default_output_file}">
|
||||||
|
file_structure_requirements</template-output>
|
||||||
|
<template-output file="{default_output_file}">testing_requirements</template-output>
|
||||||
|
|
||||||
|
<!-- Previous story intelligence -->
|
||||||
|
<check
|
||||||
|
if="previous story learnings available">
|
||||||
|
<template-output file="{default_output_file}">previous_story_intelligence</template-output>
|
||||||
|
</check>
|
||||||
|
|
||||||
|
<!-- Git intelligence -->
|
||||||
|
<check
|
||||||
|
if="git analysis completed">
|
||||||
|
<template-output file="{default_output_file}">git_intelligence_summary</template-output>
|
||||||
|
</check>
|
||||||
|
|
||||||
|
<!-- Latest technical specifics -->
|
||||||
|
<check if="web research completed">
|
||||||
|
<template-output file="{default_output_file}">latest_tech_information</template-output>
|
||||||
|
</check>
|
||||||
|
|
||||||
|
<!-- Project context reference -->
|
||||||
|
<template-output
|
||||||
|
file="{default_output_file}">project_context_reference</template-output>
|
||||||
|
|
||||||
|
<!-- Final status update -->
|
||||||
|
<template-output file="{default_output_file}">
|
||||||
|
story_completion_status</template-output>
|
||||||
|
|
||||||
|
<!-- CRITICAL: Set status to ready-for-dev -->
|
||||||
|
<action>Set story Status to: "ready-for-dev"</action>
|
||||||
|
<action>Add completion note: "Ultimate
|
||||||
|
context engine analysis completed - comprehensive developer guide created"</action>
|
||||||
|
</step>
|
||||||
|
|
||||||
|
<step n="6" goal="Update sprint status and finalize">
|
||||||
|
<action>Validate the newly created story file {default_output_file} against `./checklist.md` and apply any required fixes before finalizing</action>
|
||||||
|
<action>Save story document unconditionally</action>
|
||||||
|
|
||||||
|
<!-- Update sprint status -->
|
||||||
|
<check if="sprint status file exists">
|
||||||
|
<action>Update {{sprint_status}}</action>
|
||||||
|
<action>Load the FULL file and read all development_status entries</action>
|
||||||
|
<action>Find development_status key matching {{story_key}}</action>
|
||||||
|
<action>Verify current status is "backlog" (expected previous state)</action>
|
||||||
|
<action>Update development_status[{{story_key}}] = "ready-for-dev"</action>
|
||||||
|
<action>Update last_updated field to current date</action>
|
||||||
|
<action>Save file, preserving ALL comments and structure including STATUS DEFINITIONS</action>
|
||||||
|
</check>
|
||||||
|
|
||||||
|
<action>Report completion</action>
|
||||||
|
<output>**🎯 ULTIMATE BMad Method STORY CONTEXT CREATED, {user_name}!**
|
||||||
|
|
||||||
|
**Story Details:**
|
||||||
|
- Story ID: {{story_id}}
|
||||||
|
- Story Key: {{story_key}}
|
||||||
|
- File: {{story_file}}
|
||||||
|
- Status: ready-for-dev
|
||||||
|
|
||||||
|
**Next Steps:**
|
||||||
|
1. Review the comprehensive story in {{story_file}}
|
||||||
|
2. Run dev agents `dev-story` for optimized implementation
|
||||||
|
3. Run `code-review` when complete (auto-marks done)
|
||||||
|
4. Optional: If Test Architect module installed, run `/bmad:tea:automate` after `dev-story` to generate guardrail tests
|
||||||
|
|
||||||
|
**The developer now has everything needed for flawless implementation!**
|
||||||
|
</output>
|
||||||
|
<action>Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete` — if the resolved value is non-empty, follow it as the final terminal instruction before exiting.</action>
|
||||||
|
</step>
|
||||||
|
|
||||||
|
</workflow>
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,41 @@
|
||||||
|
# DO NOT EDIT -- overwritten on every update.
|
||||||
|
#
|
||||||
|
# Workflow customization surface for bmad-create-story. Mirrors the
|
||||||
|
# agent customization shape under the [workflow] namespace.
|
||||||
|
|
||||||
|
[workflow]
|
||||||
|
|
||||||
|
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
||||||
|
# scalars: override wins • arrays (persistent_facts, activation_steps_*): append
|
||||||
|
# arrays-of-tables with `code`/`id`: replace matching items, append new ones.
|
||||||
|
|
||||||
|
# Steps to run before the standard activation (config load, greet).
|
||||||
|
# Overrides append. Use for pre-flight loads, compliance checks, etc.
|
||||||
|
|
||||||
|
activation_steps_prepend = []
|
||||||
|
|
||||||
|
# Steps to run after greet but before the workflow begins.
|
||||||
|
# Overrides append. Use for context-heavy setup that should happen
|
||||||
|
# once the user has been acknowledged.
|
||||||
|
|
||||||
|
activation_steps_append = []
|
||||||
|
|
||||||
|
# Persistent facts the workflow keeps in mind for the whole run
|
||||||
|
# (standards, compliance constraints, stylistic guardrails).
|
||||||
|
# Distinct from the runtime memory sidecar — these are static context
|
||||||
|
# loaded on activation. Overrides append.
|
||||||
|
#
|
||||||
|
# Each entry is either:
|
||||||
|
# - a literal sentence, e.g. "All stories must include testable acceptance criteria."
|
||||||
|
# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md"
|
||||||
|
# (glob patterns are supported; the file's contents are loaded and treated as facts).
|
||||||
|
|
||||||
|
persistent_facts = [
|
||||||
|
"file:{project-root}/**/project-context.md",
|
||||||
|
]
|
||||||
|
|
||||||
|
# Scalar: executed when the workflow reaches Step 6 (Update sprint status and finalize),
|
||||||
|
# after the story file is saved and sprint-status.yaml is updated. Override wins.
|
||||||
|
# Leave empty for no custom post-completion behavior.
|
||||||
|
|
||||||
|
on_complete = ""
|
||||||
|
|
@ -1,380 +0,0 @@
|
||||||
# Create Story Workflow
|
|
||||||
|
|
||||||
**Goal:** Create a comprehensive story file that gives the dev agent everything needed for flawless implementation.
|
|
||||||
|
|
||||||
**Your Role:** Story context engine that prevents LLM developer mistakes, omissions, or disasters.
|
|
||||||
- Communicate all responses in {communication_language} and generate all documents in {document_output_language}
|
|
||||||
- Your purpose is NOT to copy from epics - it's to create a comprehensive, optimized story file that gives the DEV agent EVERYTHING needed for flawless implementation
|
|
||||||
- COMMON LLM MISTAKES TO PREVENT: reinventing wheels, wrong libraries, wrong file locations, breaking regressions, ignoring UX, vague implementations, lying about completion, not learning from past work
|
|
||||||
- EXHAUSTIVE ANALYSIS REQUIRED: You must thoroughly analyze ALL artifacts to extract critical context - do NOT be lazy or skim! This is the most important function in the entire development process!
|
|
||||||
- UTILIZE SUBPROCESSES AND SUBAGENTS: Use research subagents, subprocesses or parallel processing if available to thoroughly analyze different artifacts simultaneously and thoroughly
|
|
||||||
- SAVE QUESTIONS: If you think of questions or clarifications during analysis, save them for the end after the complete story is written
|
|
||||||
- ZERO USER INTERVENTION: Process should be fully automated except for initial epic/story selection or missing documents
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## INITIALIZATION
|
|
||||||
|
|
||||||
### Configuration Loading
|
|
||||||
|
|
||||||
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
|
||||||
|
|
||||||
- `project_name`, `user_name`
|
|
||||||
- `communication_language`, `document_output_language`
|
|
||||||
- `user_skill_level`
|
|
||||||
- `planning_artifacts`, `implementation_artifacts`
|
|
||||||
- `date` as system-generated current datetime
|
|
||||||
|
|
||||||
### Paths
|
|
||||||
|
|
||||||
- `sprint_status` = `{implementation_artifacts}/sprint-status.yaml`
|
|
||||||
- `epics_file` = `{planning_artifacts}/epics.md`
|
|
||||||
- `prd_file` = `{planning_artifacts}/prd.md`
|
|
||||||
- `architecture_file` = `{planning_artifacts}/architecture.md`
|
|
||||||
- `ux_file` = `{planning_artifacts}/*ux*.md`
|
|
||||||
- `story_title` = "" (will be elicited if not derivable)
|
|
||||||
- `project_context` = `**/project-context.md` (load if exists)
|
|
||||||
- `default_output_file` = `{implementation_artifacts}/{{story_key}}.md`
|
|
||||||
|
|
||||||
### Input Files
|
|
||||||
|
|
||||||
| Input | Description | Path Pattern(s) | Load Strategy |
|
|
||||||
|-------|-------------|------------------|---------------|
|
|
||||||
| prd | PRD (fallback - epics file should have most content) | whole: `{planning_artifacts}/*prd*.md`, sharded: `{planning_artifacts}/*prd*/*.md` | SELECTIVE_LOAD |
|
|
||||||
| architecture | Architecture (fallback - epics file should have relevant sections) | whole: `{planning_artifacts}/*architecture*.md`, sharded: `{planning_artifacts}/*architecture*/*.md` | SELECTIVE_LOAD |
|
|
||||||
| ux | UX design (fallback - epics file should have relevant sections) | whole: `{planning_artifacts}/*ux*.md`, sharded: `{planning_artifacts}/*ux*/*.md` | SELECTIVE_LOAD |
|
|
||||||
| epics | Enhanced epics+stories file with BDD and source hints | whole: `{planning_artifacts}/*epic*.md`, sharded: `{planning_artifacts}/*epic*/*.md` | SELECTIVE_LOAD |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## EXECUTION
|
|
||||||
|
|
||||||
<workflow>
|
|
||||||
|
|
||||||
<step n="1" goal="Determine target story">
|
|
||||||
<check if="{{story_path}} is provided by user or user provided the epic and story number such as 2-4 or 1.6 or epic 1 story 5">
|
|
||||||
<action>Parse user-provided story path: extract epic_num, story_num, story_title from format like "1-2-user-auth"</action>
|
|
||||||
<action>Set {{epic_num}}, {{story_num}}, {{story_key}} from user input</action>
|
|
||||||
<action>GOTO step 2a</action>
|
|
||||||
</check>
|
|
||||||
|
|
||||||
<action>Check if {{sprint_status}} file exists for auto discover</action>
|
|
||||||
<check if="sprint status file does NOT exist">
|
|
||||||
<output>🚫 No sprint status file found and no story specified</output>
|
|
||||||
<output>
|
|
||||||
**Required Options:**
|
|
||||||
1. Run `sprint-planning` to initialize sprint tracking (recommended)
|
|
||||||
2. Provide specific epic-story number to create (e.g., "1-2-user-auth")
|
|
||||||
3. Provide path to story documents if sprint status doesn't exist yet
|
|
||||||
</output>
|
|
||||||
<ask>Choose option [1], provide epic-story number, path to story docs, or [q] to quit:</ask>
|
|
||||||
|
|
||||||
<check if="user chooses 'q'">
|
|
||||||
<action>HALT - No work needed</action>
|
|
||||||
</check>
|
|
||||||
|
|
||||||
<check if="user chooses '1'">
|
|
||||||
<output>Run sprint-planning workflow first to create sprint-status.yaml</output>
|
|
||||||
<action>HALT - User needs to run sprint-planning</action>
|
|
||||||
</check>
|
|
||||||
|
|
||||||
<check if="user provides epic-story number">
|
|
||||||
<action>Parse user input: extract epic_num, story_num, story_title</action>
|
|
||||||
<action>Set {{epic_num}}, {{story_num}}, {{story_key}} from user input</action>
|
|
||||||
<action>GOTO step 2a</action>
|
|
||||||
</check>
|
|
||||||
|
|
||||||
<check if="user provides story docs path">
|
|
||||||
<action>Use user-provided path for story documents</action>
|
|
||||||
<action>GOTO step 2a</action>
|
|
||||||
</check>
|
|
||||||
</check>
|
|
||||||
|
|
||||||
<!-- Auto-discover from sprint status only if no user input -->
|
|
||||||
<check if="no user input provided">
|
|
||||||
<critical>MUST read COMPLETE {sprint_status} file from start to end to preserve order</critical>
|
|
||||||
<action>Load the FULL file: {{sprint_status}}</action>
|
|
||||||
<action>Read ALL lines from beginning to end - do not skip any content</action>
|
|
||||||
<action>Parse the development_status section completely</action>
|
|
||||||
|
|
||||||
<action>Find the FIRST story (by reading in order from top to bottom) where:
|
|
||||||
- Key matches pattern: number-number-name (e.g., "1-2-user-auth")
|
|
||||||
- NOT an epic key (epic-X) or retrospective (epic-X-retrospective)
|
|
||||||
- Status value equals "backlog"
|
|
||||||
</action>
|
|
||||||
|
|
||||||
<check if="no backlog story found">
|
|
||||||
<output>📋 No backlog stories found in sprint-status.yaml
|
|
||||||
|
|
||||||
All stories are either already created, in progress, or done.
|
|
||||||
|
|
||||||
**Options:**
|
|
||||||
1. Run sprint-planning to refresh story tracking
|
|
||||||
2. Load PM agent and run correct-course to add more stories
|
|
||||||
3. Check if current sprint is complete and run retrospective
|
|
||||||
</output>
|
|
||||||
<action>HALT</action>
|
|
||||||
</check>
|
|
||||||
|
|
||||||
<action>Extract from found story key (e.g., "1-2-user-authentication"):
|
|
||||||
- epic_num: first number before dash (e.g., "1")
|
|
||||||
- story_num: second number after first dash (e.g., "2")
|
|
||||||
- story_title: remainder after second dash (e.g., "user-authentication")
|
|
||||||
</action>
|
|
||||||
<action>Set {{story_id}} = "{{epic_num}}.{{story_num}}"</action>
|
|
||||||
<action>Store story_key for later use (e.g., "1-2-user-authentication")</action>
|
|
||||||
|
|
||||||
<!-- Mark epic as in-progress if this is first story -->
|
|
||||||
<action>Check if this is the first story in epic {{epic_num}} by looking for {{epic_num}}-1-* pattern</action>
|
|
||||||
<check if="this is first story in epic {{epic_num}}">
|
|
||||||
<action>Load {{sprint_status}} and check epic-{{epic_num}} status</action>
|
|
||||||
<action>If epic status is "backlog" → update to "in-progress"</action>
|
|
||||||
<action>If epic status is "contexted" (legacy status) → update to "in-progress" (backward compatibility)</action>
|
|
||||||
<action>If epic status is "in-progress" → no change needed</action>
|
|
||||||
<check if="epic status is 'done'">
|
|
||||||
<output>🚫 ERROR: Cannot create story in completed epic</output>
|
|
||||||
<output>Epic {{epic_num}} is marked as 'done'. All stories are complete.</output>
|
|
||||||
<output>If you need to add more work, either:</output>
|
|
||||||
<output>1. Manually change epic status back to 'in-progress' in sprint-status.yaml</output>
|
|
||||||
<output>2. Create a new epic for additional work</output>
|
|
||||||
<action>HALT - Cannot proceed</action>
|
|
||||||
</check>
|
|
||||||
<check if="epic status is not one of: backlog, contexted, in-progress, done">
|
|
||||||
<output>🚫 ERROR: Invalid epic status '{{epic_status}}'</output>
|
|
||||||
<output>Epic {{epic_num}} has invalid status. Expected: backlog, in-progress, or done</output>
|
|
||||||
<output>Please fix sprint-status.yaml manually or run sprint-planning to regenerate</output>
|
|
||||||
<action>HALT - Cannot proceed</action>
|
|
||||||
</check>
|
|
||||||
<output>📊 Epic {{epic_num}} status updated to in-progress</output>
|
|
||||||
</check>
|
|
||||||
|
|
||||||
<action>GOTO step 2a</action>
|
|
||||||
</check>
|
|
||||||
<action>Load the FULL file: {{sprint_status}}</action>
|
|
||||||
<action>Read ALL lines from beginning to end - do not skip any content</action>
|
|
||||||
<action>Parse the development_status section completely</action>
|
|
||||||
|
|
||||||
<action>Find the FIRST story (by reading in order from top to bottom) where:
|
|
||||||
- Key matches pattern: number-number-name (e.g., "1-2-user-auth")
|
|
||||||
- NOT an epic key (epic-X) or retrospective (epic-X-retrospective)
|
|
||||||
- Status value equals "backlog"
|
|
||||||
</action>
|
|
||||||
|
|
||||||
<check if="no backlog story found">
|
|
||||||
<output>No backlog stories found in sprint-status.yaml
|
|
||||||
|
|
||||||
All stories are either already created, in progress, or done.
|
|
||||||
|
|
||||||
**Options:**
|
|
||||||
1. Run sprint-planning to refresh story tracking
|
|
||||||
2. Load PM agent and run correct-course to add more stories
|
|
||||||
3. Check if current sprint is complete and run retrospective
|
|
||||||
</output>
|
|
||||||
<action>HALT</action>
|
|
||||||
</check>
|
|
||||||
|
|
||||||
<action>Extract from found story key (e.g., "1-2-user-authentication"):
|
|
||||||
- epic_num: first number before dash (e.g., "1")
|
|
||||||
- story_num: second number after first dash (e.g., "2")
|
|
||||||
- story_title: remainder after second dash (e.g., "user-authentication")
|
|
||||||
</action>
|
|
||||||
<action>Set {{story_id}} = "{{epic_num}}.{{story_num}}"</action>
|
|
||||||
<action>Store story_key for later use (e.g., "1-2-user-authentication")</action>
|
|
||||||
|
|
||||||
<!-- Mark epic as in-progress if this is first story -->
|
|
||||||
<action>Check if this is the first story in epic {{epic_num}} by looking for {{epic_num}}-1-* pattern</action>
|
|
||||||
<check if="this is first story in epic {{epic_num}}">
|
|
||||||
<action>Load {{sprint_status}} and check epic-{{epic_num}} status</action>
|
|
||||||
<action>If epic status is "backlog" → update to "in-progress"</action>
|
|
||||||
<action>If epic status is "contexted" (legacy status) → update to "in-progress" (backward compatibility)</action>
|
|
||||||
<action>If epic status is "in-progress" → no change needed</action>
|
|
||||||
<check if="epic status is 'done'">
|
|
||||||
<output>ERROR: Cannot create story in completed epic</output>
|
|
||||||
<output>Epic {{epic_num}} is marked as 'done'. All stories are complete.</output>
|
|
||||||
<output>If you need to add more work, either:</output>
|
|
||||||
<output>1. Manually change epic status back to 'in-progress' in sprint-status.yaml</output>
|
|
||||||
<output>2. Create a new epic for additional work</output>
|
|
||||||
<action>HALT - Cannot proceed</action>
|
|
||||||
</check>
|
|
||||||
<check if="epic status is not one of: backlog, contexted, in-progress, done">
|
|
||||||
<output>ERROR: Invalid epic status '{{epic_status}}'</output>
|
|
||||||
<output>Epic {{epic_num}} has invalid status. Expected: backlog, in-progress, or done</output>
|
|
||||||
<output>Please fix sprint-status.yaml manually or run sprint-planning to regenerate</output>
|
|
||||||
<action>HALT - Cannot proceed</action>
|
|
||||||
</check>
|
|
||||||
<output>Epic {{epic_num}} status updated to in-progress</output>
|
|
||||||
</check>
|
|
||||||
|
|
||||||
<action>GOTO step 2a</action>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="2" goal="Load and analyze core artifacts">
|
|
||||||
<critical>🔬 EXHAUSTIVE ARTIFACT ANALYSIS - This is where you prevent future developer mistakes!</critical>
|
|
||||||
|
|
||||||
<!-- Load all available content through discovery protocol -->
|
|
||||||
<action>Read fully and follow `./discover-inputs.md` to load all input files</action>
|
|
||||||
<note>Available content: {epics_content}, {prd_content}, {architecture_content}, {ux_content},
|
|
||||||
{project_context}</note>
|
|
||||||
|
|
||||||
<!-- Analyze epics file for story foundation -->
|
|
||||||
<action>From {epics_content}, extract Epic {{epic_num}} complete context:</action> **EPIC ANALYSIS:** - Epic
|
|
||||||
objectives and business value - ALL stories in this epic for cross-story context - Our specific story's requirements, user story
|
|
||||||
statement, acceptance criteria - Technical requirements and constraints - Dependencies on other stories/epics - Source hints pointing to
|
|
||||||
original documents <!-- Extract specific story requirements -->
|
|
||||||
<action>Extract our story ({{epic_num}}-{{story_num}}) details:</action> **STORY FOUNDATION:** - User story statement
|
|
||||||
(As a, I want, so that) - Detailed acceptance criteria (already BDD formatted) - Technical requirements specific to this story -
|
|
||||||
Business context and value - Success criteria <!-- Previous story analysis for context continuity -->
|
|
||||||
<check if="story_num > 1">
|
|
||||||
<action>Find {{previous_story_num}}: scan {implementation_artifacts} for the story file in epic {{epic_num}} with the highest story number less than {{story_num}}</action>
|
|
||||||
<action>Load previous story file: {implementation_artifacts}/{{epic_num}}-{{previous_story_num}}-*.md</action> **PREVIOUS STORY INTELLIGENCE:** -
|
|
||||||
Dev notes and learnings from previous story - Review feedback and corrections needed - Files that were created/modified and their
|
|
||||||
patterns - Testing approaches that worked/didn't work - Problems encountered and solutions found - Code patterns established <action>Extract
|
|
||||||
all learnings that could impact current story implementation</action>
|
|
||||||
</check>
|
|
||||||
|
|
||||||
<!-- Git intelligence for previous work patterns -->
|
|
||||||
<check
|
|
||||||
if="previous story exists AND git repository detected">
|
|
||||||
<action>Get last 5 commit titles to understand recent work patterns</action>
|
|
||||||
<action>Analyze 1-5 most recent commits for relevance to current story:
|
|
||||||
- Files created/modified
|
|
||||||
- Code patterns and conventions used
|
|
||||||
- Library dependencies added/changed
|
|
||||||
- Architecture decisions implemented
|
|
||||||
- Testing approaches used
|
|
||||||
</action>
|
|
||||||
<action>Extract actionable insights for current story implementation</action>
|
|
||||||
</check>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="3" goal="Architecture analysis for developer guardrails">
|
|
||||||
<critical>🏗️ ARCHITECTURE INTELLIGENCE - Extract everything the developer MUST follow!</critical> **ARCHITECTURE DOCUMENT ANALYSIS:** <action>Systematically
|
|
||||||
analyze architecture content for story-relevant requirements:</action>
|
|
||||||
|
|
||||||
<!-- Load architecture - single file or sharded -->
|
|
||||||
<check if="architecture file is single file">
|
|
||||||
<action>Load complete {architecture_content}</action>
|
|
||||||
</check>
|
|
||||||
<check if="architecture is sharded to folder">
|
|
||||||
<action>Load architecture index and scan all architecture files</action>
|
|
||||||
</check> **CRITICAL ARCHITECTURE EXTRACTION:** <action>For
|
|
||||||
each architecture section, determine if relevant to this story:</action> - **Technical Stack:** Languages, frameworks, libraries with
|
|
||||||
versions - **Code Structure:** Folder organization, naming conventions, file patterns - **API Patterns:** Service structure, endpoint
|
|
||||||
patterns, data contracts - **Database Schemas:** Tables, relationships, constraints relevant to story - **Security Requirements:**
|
|
||||||
Authentication patterns, authorization rules - **Performance Requirements:** Caching strategies, optimization patterns - **Testing
|
|
||||||
Standards:** Testing frameworks, coverage expectations, test patterns - **Deployment Patterns:** Environment configurations, build
|
|
||||||
processes - **Integration Patterns:** External service integrations, data flows <action>Extract any story-specific requirements that the
|
|
||||||
developer MUST follow</action>
|
|
||||||
<action>Identify any architectural decisions that override previous patterns</action>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="4" goal="Web research for latest technical specifics">
|
|
||||||
<critical>🌐 ENSURE LATEST TECH KNOWLEDGE - Prevent outdated implementations!</critical> **WEB INTELLIGENCE:** <action>Identify specific
|
|
||||||
technical areas that require latest version knowledge:</action>
|
|
||||||
|
|
||||||
<!-- Check for libraries/frameworks mentioned in architecture -->
|
|
||||||
<action>From architecture analysis, identify specific libraries, APIs, or
|
|
||||||
frameworks</action>
|
|
||||||
<action>For each critical technology, research latest stable version and key changes:
|
|
||||||
- Latest API documentation and breaking changes
|
|
||||||
- Security vulnerabilities or updates
|
|
||||||
- Performance improvements or deprecations
|
|
||||||
- Best practices for current version
|
|
||||||
</action>
|
|
||||||
**EXTERNAL CONTEXT INCLUSION:** <action>Include in story any critical latest information the developer needs:
|
|
||||||
- Specific library versions and why chosen
|
|
||||||
- API endpoints with parameters and authentication
|
|
||||||
- Recent security patches or considerations
|
|
||||||
- Performance optimization techniques
|
|
||||||
- Migration considerations if upgrading
|
|
||||||
</action>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="5" goal="Create comprehensive story file">
|
|
||||||
<critical>📝 CREATE ULTIMATE STORY FILE - The developer's master implementation guide!</critical>
|
|
||||||
|
|
||||||
<action>Initialize from template.md:
|
|
||||||
{default_output_file}</action>
|
|
||||||
<template-output file="{default_output_file}">story_header</template-output>
|
|
||||||
|
|
||||||
<!-- Story foundation from epics analysis -->
|
|
||||||
<template-output
|
|
||||||
file="{default_output_file}">story_requirements</template-output>
|
|
||||||
|
|
||||||
<!-- Developer context section - MOST IMPORTANT PART -->
|
|
||||||
<template-output file="{default_output_file}">
|
|
||||||
developer_context_section</template-output> **DEV AGENT GUARDRAILS:** <template-output file="{default_output_file}">
|
|
||||||
technical_requirements</template-output>
|
|
||||||
<template-output file="{default_output_file}">architecture_compliance</template-output>
|
|
||||||
<template-output
|
|
||||||
file="{default_output_file}">library_framework_requirements</template-output>
|
|
||||||
<template-output file="{default_output_file}">
|
|
||||||
file_structure_requirements</template-output>
|
|
||||||
<template-output file="{default_output_file}">testing_requirements</template-output>
|
|
||||||
|
|
||||||
<!-- Previous story intelligence -->
|
|
||||||
<check
|
|
||||||
if="previous story learnings available">
|
|
||||||
<template-output file="{default_output_file}">previous_story_intelligence</template-output>
|
|
||||||
</check>
|
|
||||||
|
|
||||||
<!-- Git intelligence -->
|
|
||||||
<check
|
|
||||||
if="git analysis completed">
|
|
||||||
<template-output file="{default_output_file}">git_intelligence_summary</template-output>
|
|
||||||
</check>
|
|
||||||
|
|
||||||
<!-- Latest technical specifics -->
|
|
||||||
<check if="web research completed">
|
|
||||||
<template-output file="{default_output_file}">latest_tech_information</template-output>
|
|
||||||
</check>
|
|
||||||
|
|
||||||
<!-- Project context reference -->
|
|
||||||
<template-output
|
|
||||||
file="{default_output_file}">project_context_reference</template-output>
|
|
||||||
|
|
||||||
<!-- Final status update -->
|
|
||||||
<template-output file="{default_output_file}">
|
|
||||||
story_completion_status</template-output>
|
|
||||||
|
|
||||||
<!-- CRITICAL: Set status to ready-for-dev -->
|
|
||||||
<action>Set story Status to: "ready-for-dev"</action>
|
|
||||||
<action>Add completion note: "Ultimate
|
|
||||||
context engine analysis completed - comprehensive developer guide created"</action>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
<step n="6" goal="Update sprint status and finalize">
|
|
||||||
<action>Validate the newly created story file {default_output_file} against `./checklist.md` and apply any required fixes before finalizing</action>
|
|
||||||
<action>Save story document unconditionally</action>
|
|
||||||
|
|
||||||
<!-- Update sprint status -->
|
|
||||||
<check if="sprint status file exists">
|
|
||||||
<action>Update {{sprint_status}}</action>
|
|
||||||
<action>Load the FULL file and read all development_status entries</action>
|
|
||||||
<action>Find development_status key matching {{story_key}}</action>
|
|
||||||
<action>Verify current status is "backlog" (expected previous state)</action>
|
|
||||||
<action>Update development_status[{{story_key}}] = "ready-for-dev"</action>
|
|
||||||
<action>Update last_updated field to current date</action>
|
|
||||||
<action>Save file, preserving ALL comments and structure including STATUS DEFINITIONS</action>
|
|
||||||
</check>
|
|
||||||
|
|
||||||
<action>Report completion</action>
|
|
||||||
<output>**🎯 ULTIMATE BMad Method STORY CONTEXT CREATED, {user_name}!**
|
|
||||||
|
|
||||||
**Story Details:**
|
|
||||||
- Story ID: {{story_id}}
|
|
||||||
- Story Key: {{story_key}}
|
|
||||||
- File: {{story_file}}
|
|
||||||
- Status: ready-for-dev
|
|
||||||
|
|
||||||
**Next Steps:**
|
|
||||||
1. Review the comprehensive story in {{story_file}}
|
|
||||||
2. Run dev agents `dev-story` for optimized implementation
|
|
||||||
3. Run `code-review` when complete (auto-marks done)
|
|
||||||
4. Optional: If Test Architect module installed, run `/bmad:tea:automate` after `dev-story` to generate guardrail tests
|
|
||||||
|
|
||||||
**The developer now has everything needed for flawless implementation!**
|
|
||||||
</output>
|
|
||||||
</step>
|
|
||||||
|
|
||||||
</workflow>
|
|
||||||
|
|
@ -3,4 +3,174 @@ name: bmad-qa-generate-e2e-tests
|
||||||
description: 'Generate end to end automated tests for existing features. Use when the user says "create qa automated tests for [feature]"'
|
description: 'Generate end to end automated tests for existing features. Use when the user says "create qa automated tests for [feature]"'
|
||||||
---
|
---
|
||||||
|
|
||||||
Follow the instructions in ./workflow.md.
|
# QA Generate E2E Tests Workflow
|
||||||
|
|
||||||
|
**Goal:** Generate automated API and E2E tests for implemented code.
|
||||||
|
|
||||||
|
**Your Role:** You are a QA automation engineer. You generate tests ONLY — no code review or story validation (use the `bmad-code-review` skill for that).
|
||||||
|
|
||||||
|
## Conventions
|
||||||
|
|
||||||
|
- Bare paths (e.g. `checklist.md`) resolve from the skill root.
|
||||||
|
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
||||||
|
- `{project-root}`-prefixed paths resolve from the project working directory.
|
||||||
|
- `{skill-name}` resolves to the skill directory's basename.
|
||||||
|
|
||||||
|
## On Activation
|
||||||
|
|
||||||
|
### Step 1: Resolve the Workflow Block
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
||||||
|
|
||||||
|
**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:
|
||||||
|
|
||||||
|
1. `{skill-root}/customize.toml` — defaults
|
||||||
|
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
||||||
|
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 2: Execute Prepend Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
||||||
|
|
||||||
|
### Step 3: Load Persistent Facts
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### Step 4: Load Config
|
||||||
|
|
||||||
|
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||||
|
|
||||||
|
- `project_name`, `user_name`
|
||||||
|
- `communication_language`, `document_output_language`
|
||||||
|
- `implementation_artifacts`
|
||||||
|
- `date` as system-generated current datetime
|
||||||
|
- YOU MUST ALWAYS SPEAK OUTPUT in your Agent communication style with the config `{communication_language}`
|
||||||
|
|
||||||
|
### Step 5: Greet the User
|
||||||
|
|
||||||
|
Greet `{user_name}`, speaking in `{communication_language}`.
|
||||||
|
|
||||||
|
### Step 6: Execute Append Steps
|
||||||
|
|
||||||
|
Execute each entry in `{workflow.activation_steps_append}` in order.
|
||||||
|
|
||||||
|
Activation is complete. Begin the workflow below.
|
||||||
|
|
||||||
|
## Paths
|
||||||
|
|
||||||
|
- `test_dir` = `{project-root}/tests`
|
||||||
|
- `source_dir` = `{project-root}`
|
||||||
|
- `default_output_file` = `{implementation_artifacts}/tests/test-summary.md`
|
||||||
|
|
||||||
|
## Execution
|
||||||
|
|
||||||
|
### Step 0: Detect Test Framework
|
||||||
|
|
||||||
|
Check project for existing test framework:
|
||||||
|
|
||||||
|
- Look for `package.json` dependencies (playwright, jest, vitest, cypress, etc.)
|
||||||
|
- Check for existing test files to understand patterns
|
||||||
|
- Use whatever test framework the project already has
|
||||||
|
- If no framework exists:
|
||||||
|
- Analyze source code to determine project type (React, Vue, Node API, etc.)
|
||||||
|
- Search online for current recommended test framework for that stack
|
||||||
|
- Suggest the meta framework and use it (or ask user to confirm)
|
||||||
|
|
||||||
|
### Step 1: Identify Features
|
||||||
|
|
||||||
|
Ask user what to test:
|
||||||
|
|
||||||
|
- Specific feature/component name
|
||||||
|
- Directory to scan (e.g., `src/components/`)
|
||||||
|
- Or auto-discover features in the codebase
|
||||||
|
|
||||||
|
### Step 2: Generate API Tests (if applicable)
|
||||||
|
|
||||||
|
For API endpoints/services, generate tests that:
|
||||||
|
|
||||||
|
- Test status codes (200, 400, 404, 500)
|
||||||
|
- Validate response structure
|
||||||
|
- Cover happy path + 1-2 error cases
|
||||||
|
- Use project's existing test framework patterns
|
||||||
|
|
||||||
|
### Step 3: Generate E2E Tests (if UI exists)
|
||||||
|
|
||||||
|
For UI features, generate tests that:
|
||||||
|
|
||||||
|
- Test user workflows end-to-end
|
||||||
|
- Use semantic locators (roles, labels, text)
|
||||||
|
- Focus on user interactions (clicks, form fills, navigation)
|
||||||
|
- Assert visible outcomes
|
||||||
|
- Keep tests linear and simple
|
||||||
|
- Follow project's existing test patterns
|
||||||
|
|
||||||
|
### Step 4: Run Tests
|
||||||
|
|
||||||
|
Execute tests to verify they pass (use project's test command).
|
||||||
|
|
||||||
|
If failures occur, fix them immediately.
|
||||||
|
|
||||||
|
### Step 5: Create Summary
|
||||||
|
|
||||||
|
Output markdown summary:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
# Test Automation Summary
|
||||||
|
|
||||||
|
## Generated Tests
|
||||||
|
|
||||||
|
### API Tests
|
||||||
|
- [x] tests/api/endpoint.spec.ts - Endpoint validation
|
||||||
|
|
||||||
|
### E2E Tests
|
||||||
|
- [x] tests/e2e/feature.spec.ts - User workflow
|
||||||
|
|
||||||
|
## Coverage
|
||||||
|
- API endpoints: 5/10 covered
|
||||||
|
- UI features: 3/8 covered
|
||||||
|
|
||||||
|
## Next Steps
|
||||||
|
- Run tests in CI
|
||||||
|
- Add more edge cases as needed
|
||||||
|
```
|
||||||
|
|
||||||
|
## Keep It Simple
|
||||||
|
|
||||||
|
**Do:**
|
||||||
|
|
||||||
|
- Use standard test framework APIs
|
||||||
|
- Focus on happy path + critical errors
|
||||||
|
- Write readable, maintainable tests
|
||||||
|
- Run tests to verify they pass
|
||||||
|
|
||||||
|
**Avoid:**
|
||||||
|
|
||||||
|
- Complex fixture composition
|
||||||
|
- Over-engineering
|
||||||
|
- Unnecessary abstractions
|
||||||
|
|
||||||
|
**For Advanced Features:**
|
||||||
|
|
||||||
|
If the project needs:
|
||||||
|
|
||||||
|
- Risk-based test strategy
|
||||||
|
- Test design planning
|
||||||
|
- Quality gates and NFR assessment
|
||||||
|
- Comprehensive coverage analysis
|
||||||
|
- Advanced testing patterns and utilities
|
||||||
|
|
||||||
|
> **Install Test Architect (TEA) module**: <https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/>
|
||||||
|
|
||||||
|
## Output
|
||||||
|
|
||||||
|
Save summary to: `{default_output_file}`
|
||||||
|
|
||||||
|
**Done!** Tests generated and verified. Validate against `./checklist.md`.
|
||||||
|
|
||||||
|
## On Complete
|
||||||
|
|
||||||
|
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete`
|
||||||
|
|
||||||
|
If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting.
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,41 @@
|
||||||
|
# DO NOT EDIT -- overwritten on every update.
|
||||||
|
#
|
||||||
|
# Workflow customization surface for bmad-qa-generate-e2e-tests. Mirrors the
|
||||||
|
# agent customization shape under the [workflow] namespace.
|
||||||
|
|
||||||
|
[workflow]
|
||||||
|
|
||||||
|
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
||||||
|
# scalars: override wins • arrays (persistent_facts, activation_steps_*): append
|
||||||
|
# arrays-of-tables with `code`/`id`: replace matching items, append new ones.
|
||||||
|
|
||||||
|
# Steps to run before the standard activation (config load, greet).
|
||||||
|
# Overrides append. Use for pre-flight loads, compliance checks, etc.
|
||||||
|
|
||||||
|
activation_steps_prepend = []
|
||||||
|
|
||||||
|
# Steps to run after greet but before the workflow begins.
|
||||||
|
# Overrides append. Use for context-heavy setup that should happen
|
||||||
|
# once the user has been acknowledged.
|
||||||
|
|
||||||
|
activation_steps_append = []
|
||||||
|
|
||||||
|
# Persistent facts the workflow keeps in mind for the whole run
|
||||||
|
# (standards, compliance constraints, stylistic guardrails).
|
||||||
|
# Distinct from the runtime memory sidecar — these are static context
|
||||||
|
# loaded on activation. Overrides append.
|
||||||
|
#
|
||||||
|
# Each entry is either:
|
||||||
|
# - a literal sentence, e.g. "All tests must follow the project's existing test framework patterns."
|
||||||
|
# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md"
|
||||||
|
# (glob patterns are supported; the file's contents are loaded and treated as facts).
|
||||||
|
|
||||||
|
persistent_facts = [
|
||||||
|
"file:{project-root}/**/project-context.md",
|
||||||
|
]
|
||||||
|
|
||||||
|
# Scalar: executed when the workflow reaches Step 5 (Create Summary),
|
||||||
|
# after all tests pass and the summary document is saved. Override wins.
|
||||||
|
# Leave empty for no custom post-completion behavior.
|
||||||
|
|
||||||
|
on_complete = ""
|
||||||
|
|
@ -1,136 +0,0 @@
|
||||||
# QA Generate E2E Tests Workflow
|
|
||||||
|
|
||||||
**Goal:** Generate automated API and E2E tests for implemented code.
|
|
||||||
|
|
||||||
**Your Role:** You are a QA automation engineer. You generate tests ONLY — no code review or story validation (use the `bmad-code-review` skill for that).
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## INITIALIZATION
|
|
||||||
|
|
||||||
### Configuration Loading
|
|
||||||
|
|
||||||
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
|
||||||
|
|
||||||
- `project_name`, `user_name`
|
|
||||||
- `communication_language`, `document_output_language`
|
|
||||||
- `implementation_artifacts`
|
|
||||||
- `date` as system-generated current datetime
|
|
||||||
- YOU MUST ALWAYS SPEAK OUTPUT in your Agent communication style with the config `{communication_language}`
|
|
||||||
|
|
||||||
### Paths
|
|
||||||
|
|
||||||
- `test_dir` = `{project-root}/tests`
|
|
||||||
- `source_dir` = `{project-root}`
|
|
||||||
- `default_output_file` = `{implementation_artifacts}/tests/test-summary.md`
|
|
||||||
|
|
||||||
### Context
|
|
||||||
|
|
||||||
- `project_context` = `**/project-context.md` (load if exists)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## EXECUTION
|
|
||||||
|
|
||||||
### Step 0: Detect Test Framework
|
|
||||||
|
|
||||||
Check project for existing test framework:
|
|
||||||
|
|
||||||
- Look for `package.json` dependencies (playwright, jest, vitest, cypress, etc.)
|
|
||||||
- Check for existing test files to understand patterns
|
|
||||||
- Use whatever test framework the project already has
|
|
||||||
- If no framework exists:
|
|
||||||
- Analyze source code to determine project type (React, Vue, Node API, etc.)
|
|
||||||
- Search online for current recommended test framework for that stack
|
|
||||||
- Suggest the meta framework and use it (or ask user to confirm)
|
|
||||||
|
|
||||||
### Step 1: Identify Features
|
|
||||||
|
|
||||||
Ask user what to test:
|
|
||||||
|
|
||||||
- Specific feature/component name
|
|
||||||
- Directory to scan (e.g., `src/components/`)
|
|
||||||
- Or auto-discover features in the codebase
|
|
||||||
|
|
||||||
### Step 2: Generate API Tests (if applicable)
|
|
||||||
|
|
||||||
For API endpoints/services, generate tests that:
|
|
||||||
|
|
||||||
- Test status codes (200, 400, 404, 500)
|
|
||||||
- Validate response structure
|
|
||||||
- Cover happy path + 1-2 error cases
|
|
||||||
- Use project's existing test framework patterns
|
|
||||||
|
|
||||||
### Step 3: Generate E2E Tests (if UI exists)
|
|
||||||
|
|
||||||
For UI features, generate tests that:
|
|
||||||
|
|
||||||
- Test user workflows end-to-end
|
|
||||||
- Use semantic locators (roles, labels, text)
|
|
||||||
- Focus on user interactions (clicks, form fills, navigation)
|
|
||||||
- Assert visible outcomes
|
|
||||||
- Keep tests linear and simple
|
|
||||||
- Follow project's existing test patterns
|
|
||||||
|
|
||||||
### Step 4: Run Tests
|
|
||||||
|
|
||||||
Execute tests to verify they pass (use project's test command).
|
|
||||||
|
|
||||||
If failures occur, fix them immediately.
|
|
||||||
|
|
||||||
### Step 5: Create Summary
|
|
||||||
|
|
||||||
Output markdown summary:
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
# Test Automation Summary
|
|
||||||
|
|
||||||
## Generated Tests
|
|
||||||
|
|
||||||
### API Tests
|
|
||||||
- [x] tests/api/endpoint.spec.ts - Endpoint validation
|
|
||||||
|
|
||||||
### E2E Tests
|
|
||||||
- [x] tests/e2e/feature.spec.ts - User workflow
|
|
||||||
|
|
||||||
## Coverage
|
|
||||||
- API endpoints: 5/10 covered
|
|
||||||
- UI features: 3/8 covered
|
|
||||||
|
|
||||||
## Next Steps
|
|
||||||
- Run tests in CI
|
|
||||||
- Add more edge cases as needed
|
|
||||||
```
|
|
||||||
|
|
||||||
## Keep It Simple
|
|
||||||
|
|
||||||
**Do:**
|
|
||||||
|
|
||||||
- Use standard test framework APIs
|
|
||||||
- Focus on happy path + critical errors
|
|
||||||
- Write readable, maintainable tests
|
|
||||||
- Run tests to verify they pass
|
|
||||||
|
|
||||||
**Avoid:**
|
|
||||||
|
|
||||||
- Complex fixture composition
|
|
||||||
- Over-engineering
|
|
||||||
- Unnecessary abstractions
|
|
||||||
|
|
||||||
**For Advanced Features:**
|
|
||||||
|
|
||||||
If the project needs:
|
|
||||||
|
|
||||||
- Risk-based test strategy
|
|
||||||
- Test design planning
|
|
||||||
- Quality gates and NFR assessment
|
|
||||||
- Comprehensive coverage analysis
|
|
||||||
- Advanced testing patterns and utilities
|
|
||||||
|
|
||||||
> **Install Test Architect (TEA) module**: <https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/>
|
|
||||||
|
|
||||||
## Output
|
|
||||||
|
|
||||||
Save summary to: `{default_output_file}`
|
|
||||||
|
|
||||||
**Done!** Tests generated and verified. Validate against `./checklist.md`.
|
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,41 @@
|
||||||
|
# DO NOT EDIT -- overwritten on every update.
|
||||||
|
#
|
||||||
|
# Workflow customization surface for bmad-retrospective. Mirrors the
|
||||||
|
# agent customization shape under the [workflow] namespace.
|
||||||
|
|
||||||
|
[workflow]
|
||||||
|
|
||||||
|
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
||||||
|
# scalars: override wins • arrays (persistent_facts, activation_steps_*): append
|
||||||
|
# arrays-of-tables with `code`/`id`: replace matching items, append new ones.
|
||||||
|
|
||||||
|
# Steps to run before the standard activation (config load, greet).
|
||||||
|
# Overrides append. Use for pre-flight loads, compliance checks, etc.
|
||||||
|
|
||||||
|
activation_steps_prepend = []
|
||||||
|
|
||||||
|
# Steps to run after greet but before the workflow begins.
|
||||||
|
# Overrides append. Use for context-heavy setup that should happen
|
||||||
|
# once the user has been acknowledged.
|
||||||
|
|
||||||
|
activation_steps_append = []
|
||||||
|
|
||||||
|
# Persistent facts the workflow keeps in mind for the whole run
|
||||||
|
# (standards, compliance constraints, stylistic guardrails).
|
||||||
|
# Distinct from the runtime memory sidecar — these are static context
|
||||||
|
# loaded on activation. Overrides append.
|
||||||
|
#
|
||||||
|
# Each entry is either:
|
||||||
|
# - a literal sentence, e.g. "All retrospectives must produce SMART action items with named owners."
|
||||||
|
# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md"
|
||||||
|
# (glob patterns are supported; the file's contents are loaded and treated as facts).
|
||||||
|
|
||||||
|
persistent_facts = [
|
||||||
|
"file:{project-root}/**/project-context.md",
|
||||||
|
]
|
||||||
|
|
||||||
|
# Scalar: executed when the workflow reaches Step 12 (Final Summary and Handoff),
|
||||||
|
# after the retrospective document is saved and sprint-status is updated. Override wins.
|
||||||
|
# Leave empty for no custom post-completion behavior.
|
||||||
|
|
||||||
|
on_complete = ""
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,111 @@
|
||||||
|
---
|
||||||
|
name: bmad-customize
|
||||||
|
description: Authors and updates customization overrides for installed BMad skills. Use when the user says 'customize bmad', 'override a skill', 'change agent behavior', or 'customize a workflow'.
|
||||||
|
---
|
||||||
|
|
||||||
|
# BMad Customize
|
||||||
|
|
||||||
|
Translate the user's intent into a correctly-placed TOML override file under `{project-root}/_bmad/custom/` for a customizable agent or workflow skill. Discover, route, author, write, verify.
|
||||||
|
|
||||||
|
Scope v1: per-skill `[agent]` overrides (`bmad-agent-<role>.toml` / `.user.toml`) and per-skill `[workflow]` overrides (`bmad-<workflow>.toml` / `.user.toml`). Central config (`{project-root}/_bmad/custom/config.toml`) is out of scope — point users at the [How to Customize BMad guide](https://docs.bmad-method.org/how-to/customize-bmad/).
|
||||||
|
|
||||||
|
When the target's `customize.toml` doesn't expose what the user wants, say so plainly. Don't invent fields.
|
||||||
|
|
||||||
|
## Preflight
|
||||||
|
|
||||||
|
- No `{project-root}/_bmad/` → BMad isn't installed. Say so, stop.
|
||||||
|
- `{project-root}/_bmad/scripts/resolve_customization.py` missing → continue, but Step 6 verify falls back to manual merge.
|
||||||
|
- Both present → proceed.
|
||||||
|
|
||||||
|
## Activation
|
||||||
|
|
||||||
|
Load `_bmad/config.toml` and `_bmad/config.user.toml` from `{project-root}` for `user_name` (default `BMad`) and `communication_language` (default `English`). Greet. If the user's invocation already names a target skill AND a specific change, jump to Step 3.
|
||||||
|
|
||||||
|
## Step 1: Classify intent
|
||||||
|
|
||||||
|
- **Directed** — specific skill + specific change → Step 3.
|
||||||
|
- **Exploratory** — "what can I customize?" → Step 2.
|
||||||
|
- **Audit/iterate** — wants to review or change something already customized → Step 2, lead with skills that have existing overrides; read the existing override in Step 3 before composing.
|
||||||
|
- **Cross-cutting** — could live on multiple surfaces → Step 3, choose agent vs workflow explicitly with the user.
|
||||||
|
|
||||||
|
## Step 2: Discovery
|
||||||
|
|
||||||
|
```
|
||||||
|
python3 {skill-root}/scripts/list_customizable_skills.py --project-root {project-root}
|
||||||
|
```
|
||||||
|
|
||||||
|
Use `--extra-root <path>` (repeatable) if the user has skills installed in additional locations.
|
||||||
|
|
||||||
|
Group the returned `agents` and `workflows` for the user; for each show name, description, whether `has_team_override` or `has_user_override` is true. Surface any `errors[]`. For audit/iterate intents, lead with already-overridden entries.
|
||||||
|
|
||||||
|
Empty list: show `scanned_roots`, ask whether skills live elsewhere (offer `--extra-root`); otherwise stop.
|
||||||
|
|
||||||
|
## Step 3: Determine the right surface
|
||||||
|
|
||||||
|
Read the target's `customize.toml`. Top-level `[agent]` or `[workflow]` block defines the surface.
|
||||||
|
|
||||||
|
If a team or user override already exists, read it first and summarize what's already overridden before composing.
|
||||||
|
|
||||||
|
**Cross-cutting intent — walk both surfaces with the user:**
|
||||||
|
- Every workflow a given agent runs → agent surface (e.g. `bmad-agent-pm.toml` with `persistent_facts`, `principles`).
|
||||||
|
- One workflow only → workflow surface (e.g. `bmad-create-prd.toml` with `activation_steps_prepend`).
|
||||||
|
- Several specific workflows → multiple workflow overrides in sequence, not an agent override.
|
||||||
|
|
||||||
|
**Single-surface heuristic:**
|
||||||
|
- Workflow-level: template swap, output path, step-specific behavior, or a named scalar already exposed (`*_template`, `on_complete`). Surgical, reliable.
|
||||||
|
- Agent-level: persona, communication style, org-wide facts, menu changes, behavior that should apply to every workflow the agent dispatches.
|
||||||
|
|
||||||
|
When ambiguous, present both with tradeoff, recommend one, let the user decide.
|
||||||
|
|
||||||
|
Intent outside the exposed surface (step logic, ordering, anything not in `customize.toml`): say so; offer `activation_steps_prepend`/`append` or `persistent_facts` as approximations, or recommend `bmad-builder` to create a custom skill.
|
||||||
|
|
||||||
|
## Step 4: Compose the override
|
||||||
|
|
||||||
|
Translate plain-English into TOML against the target's `customize.toml` fields. If an existing override was read, frame the change as additive.
|
||||||
|
|
||||||
|
Merge semantics:
|
||||||
|
- **Scalars** (`icon`, `role`, `*_template`, `on_complete`) — override wins.
|
||||||
|
- **Append arrays** (`persistent_facts`, `activation_steps_prepend`/`append`, `principles`) — team/user entries append in order.
|
||||||
|
- **Keyed arrays of tables** (menu items with `code` or `id`) — matching keys replace, new keys append.
|
||||||
|
|
||||||
|
Overrides are sparse: only the fields being changed. Never copy the whole `customize.toml`.
|
||||||
|
|
||||||
|
**Template swap** (`*_template` scalar): offer to copy the default template to `{project-root}/_bmad/custom/{skill-name}-{purpose}-template.md`, point the override at the new path, offer to help edit it.
|
||||||
|
|
||||||
|
## Step 5: Team or user placement
|
||||||
|
|
||||||
|
Under `{project-root}/_bmad/custom/`:
|
||||||
|
- `{skill-name}.toml` — team, committed. Policies, org conventions, compliance.
|
||||||
|
- `{skill-name}.user.toml` — user, gitignored. Personal tone, private facts, shortcuts.
|
||||||
|
|
||||||
|
Default by character (policy → team, personal → user), confirm before writing.
|
||||||
|
|
||||||
|
## Step 6: Show, confirm, write, verify
|
||||||
|
|
||||||
|
1. Show the full TOML. If the file exists, show a diff. Never silently overwrite.
|
||||||
|
2. Wait for explicit yes.
|
||||||
|
3. Write. Create `{project-root}/_bmad/custom/` if needed.
|
||||||
|
4. Verify:
|
||||||
|
```
|
||||||
|
python3 {project-root}/_bmad/scripts/resolve_customization.py --skill <install-path> --key <agent-or-workflow>
|
||||||
|
```
|
||||||
|
Show the merged output, point out the changed fields.
|
||||||
|
|
||||||
|
**Resolver missing or fails:** read whichever layers exist — `<install-path>/customize.toml` (base), `{project-root}/_bmad/custom/{skill-name}.toml` (team), `{project-root}/_bmad/custom/{skill-name}.user.toml` (user) — apply base → team → user with the same merge rules (scalars override, tables deep-merge, `code`/`id`-keyed arrays merge by key, all other arrays append), describe how the changed fields resolve.
|
||||||
|
|
||||||
|
**Verify shows override didn't land** (field unchanged, merge conflict, file not picked up): re-enter Step 4 with the verify output as context. Usually wrong field name, wrong merge mode (scalar vs array), or wrong scope.
|
||||||
|
5. Summarize what changed, where the file lives, how to iterate. Remind the user to commit team overrides.
|
||||||
|
|
||||||
|
## Complete when
|
||||||
|
|
||||||
|
- Override file written (or user explicitly aborted).
|
||||||
|
- User has seen resolver output (or manual fallback merge summary).
|
||||||
|
- User has acknowledged the summary.
|
||||||
|
|
||||||
|
Otherwise the skill isn't done — finish or tell the user they're exiting incomplete.
|
||||||
|
|
||||||
|
## When this skill can't help
|
||||||
|
|
||||||
|
- **Central config** (`{project-root}/_bmad/custom/config.toml`) — see the [How to Customize BMad guide](https://docs.bmad-method.org/how-to/customize-bmad/).
|
||||||
|
- **Step logic, ordering, behavior not in `customize.toml`** — open a feature request, or use `bmad-builder` to create a custom skill. Offer to help with either.
|
||||||
|
- **Skills without a `customize.toml`** — not customizable.
|
||||||
|
|
@ -0,0 +1,231 @@
|
||||||
|
#!/usr/bin/env python3
|
||||||
|
# /// script
|
||||||
|
# requires-python = ">=3.11"
|
||||||
|
# ///
|
||||||
|
"""Enumerate customizable BMad skills installed alongside this one.
|
||||||
|
|
||||||
|
Scans a skills directory (by default: the directory this script's own skill
|
||||||
|
lives in, derived from __file__), finds every sibling directory containing a
|
||||||
|
`customize.toml`, classifies each as agent and/or workflow based on its
|
||||||
|
top-level blocks, reads the skill's SKILL.md frontmatter description for a
|
||||||
|
one-liner, and checks whether override files already exist in
|
||||||
|
`{project-root}/_bmad/custom/`.
|
||||||
|
|
||||||
|
Skills in BMad are loaded either from a project-local location (e.g. the
|
||||||
|
project's `.claude/skills/` or `.cursor/skills/`) or from a user-global
|
||||||
|
location (e.g. `~/.claude/skills/`). We do not hardcode those paths — the
|
||||||
|
running skill's own location is the source of truth for sibling discovery.
|
||||||
|
`--extra-root` is available for the rare case where skills live in multiple
|
||||||
|
locations on the same machine.
|
||||||
|
|
||||||
|
Output: JSON to stdout. Non-empty `errors[]` in the payload is non-fatal
|
||||||
|
by contract — the scanner surfaces malformed TOML, missing roots, and
|
||||||
|
skills with no customization block as data for the caller to display,
|
||||||
|
and still exits 0. Exit 2 is reserved for invocation errors (e.g.
|
||||||
|
missing or unreadable `--project-root`) where no useful payload can be
|
||||||
|
produced.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import json
|
||||||
|
import re
|
||||||
|
import sys
|
||||||
|
import tomllib
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
# Top-level TOML blocks that indicate a customization surface.
|
||||||
|
SURFACE_KEYS = ("agent", "workflow")
|
||||||
|
|
||||||
|
FRONTMATTER_RE = re.compile(r"^---\s*\n(.*?)\n---\s*\n", re.DOTALL)
|
||||||
|
|
||||||
|
|
||||||
|
def default_skills_root() -> Path:
|
||||||
|
"""Derive the skills root from this script's location.
|
||||||
|
|
||||||
|
Layout assumption: {skills_root}/bmad-customize/scripts/list_customizable_skills.py.
|
||||||
|
So the skills root is three parents up from this file.
|
||||||
|
"""
|
||||||
|
return Path(__file__).resolve().parent.parent.parent
|
||||||
|
|
||||||
|
|
||||||
|
def read_frontmatter_description(skill_md: Path) -> str:
|
||||||
|
"""Extract the `description:` value from a SKILL.md YAML frontmatter block.
|
||||||
|
|
||||||
|
Returns an empty string if the file is missing, unreadable, or has no
|
||||||
|
description field. Intentionally permissive — this is metadata for a
|
||||||
|
human-facing list, not a validation target.
|
||||||
|
"""
|
||||||
|
if not skill_md.is_file():
|
||||||
|
return ""
|
||||||
|
try:
|
||||||
|
text = skill_md.read_text(encoding="utf-8")
|
||||||
|
except (OSError, UnicodeDecodeError):
|
||||||
|
return ""
|
||||||
|
m = FRONTMATTER_RE.match(text)
|
||||||
|
if not m:
|
||||||
|
return ""
|
||||||
|
for line in m.group(1).splitlines():
|
||||||
|
stripped = line.strip()
|
||||||
|
if stripped.startswith("description:"):
|
||||||
|
value = stripped[len("description:") :].strip()
|
||||||
|
# Strip surrounding quotes if present.
|
||||||
|
if (value.startswith("'") and value.endswith("'")) or (
|
||||||
|
value.startswith('"') and value.endswith('"')
|
||||||
|
):
|
||||||
|
value = value[1:-1]
|
||||||
|
return value
|
||||||
|
return ""
|
||||||
|
|
||||||
|
|
||||||
|
def load_customize(toml_path: Path) -> dict | None:
|
||||||
|
"""Return the parsed TOML, or None if unreadable."""
|
||||||
|
try:
|
||||||
|
with toml_path.open("rb") as f:
|
||||||
|
return tomllib.load(f)
|
||||||
|
except (OSError, tomllib.TOMLDecodeError):
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def scan_skills(
|
||||||
|
skills_roots: list[Path],
|
||||||
|
project_root: Path,
|
||||||
|
) -> dict:
|
||||||
|
"""Scan each skills root for directories that contain a customize.toml."""
|
||||||
|
agents: list[dict] = []
|
||||||
|
workflows: list[dict] = []
|
||||||
|
errors: list[str] = []
|
||||||
|
scanned_roots: list[str] = []
|
||||||
|
seen_names: set[str] = set()
|
||||||
|
custom_dir = project_root / "_bmad" / "custom"
|
||||||
|
|
||||||
|
for root in skills_roots:
|
||||||
|
if not root.is_dir():
|
||||||
|
errors.append(f"skills root does not exist: {root}")
|
||||||
|
continue
|
||||||
|
scanned_roots.append(str(root))
|
||||||
|
|
||||||
|
for skill_dir in sorted(p for p in root.iterdir() if p.is_dir()):
|
||||||
|
customize_toml = skill_dir / "customize.toml"
|
||||||
|
if not customize_toml.is_file():
|
||||||
|
continue
|
||||||
|
|
||||||
|
data = load_customize(customize_toml)
|
||||||
|
if data is None:
|
||||||
|
errors.append(f"failed to parse {customize_toml}")
|
||||||
|
continue
|
||||||
|
|
||||||
|
skill_name = skill_dir.name
|
||||||
|
# If a skill with this name was already found in an earlier
|
||||||
|
# root, skip it — roots are scanned in the order provided, so
|
||||||
|
# the first occurrence wins.
|
||||||
|
if skill_name in seen_names:
|
||||||
|
continue
|
||||||
|
seen_names.add(skill_name)
|
||||||
|
|
||||||
|
description = read_frontmatter_description(skill_dir / "SKILL.md")
|
||||||
|
team_override = custom_dir / f"{skill_name}.toml"
|
||||||
|
user_override = custom_dir / f"{skill_name}.user.toml"
|
||||||
|
|
||||||
|
entry_base = {
|
||||||
|
"name": skill_name,
|
||||||
|
"install_path": str(skill_dir),
|
||||||
|
"skills_root": str(root),
|
||||||
|
"description": description,
|
||||||
|
"has_team_override": team_override.is_file(),
|
||||||
|
"has_user_override": user_override.is_file(),
|
||||||
|
"team_override_path": str(team_override),
|
||||||
|
"user_override_path": str(user_override),
|
||||||
|
}
|
||||||
|
|
||||||
|
# A skill may expose an agent surface, a workflow surface, or
|
||||||
|
# both. Emit one entry per surface so the caller can group cleanly.
|
||||||
|
surfaces_found = [k for k in SURFACE_KEYS if k in data]
|
||||||
|
if not surfaces_found:
|
||||||
|
errors.append(
|
||||||
|
f"no [agent] or [workflow] block in {customize_toml}"
|
||||||
|
)
|
||||||
|
continue
|
||||||
|
for surface in surfaces_found:
|
||||||
|
entry = dict(entry_base)
|
||||||
|
entry["surface"] = surface
|
||||||
|
if surface == "agent":
|
||||||
|
agents.append(entry)
|
||||||
|
else:
|
||||||
|
workflows.append(entry)
|
||||||
|
|
||||||
|
return {
|
||||||
|
"project_root": str(project_root),
|
||||||
|
"scanned_roots": scanned_roots,
|
||||||
|
"custom_dir": str(custom_dir),
|
||||||
|
"agents": agents,
|
||||||
|
"workflows": workflows,
|
||||||
|
"errors": errors,
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def parse_args(argv: list[str]) -> argparse.Namespace:
|
||||||
|
parser = argparse.ArgumentParser(
|
||||||
|
description=(
|
||||||
|
"List customizable BMad skills installed alongside this one, "
|
||||||
|
"grouped by surface (agent vs workflow), with override status "
|
||||||
|
"looked up against {project-root}/_bmad/custom/."
|
||||||
|
)
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--project-root",
|
||||||
|
required=True,
|
||||||
|
help="Absolute path to the project root (the folder containing _bmad/).",
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--skills-root",
|
||||||
|
default=None,
|
||||||
|
help=(
|
||||||
|
"Override the primary skills directory to scan. Defaults to the "
|
||||||
|
"directory this script's own skill lives in."
|
||||||
|
),
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--extra-root",
|
||||||
|
action="append",
|
||||||
|
default=[],
|
||||||
|
metavar="PATH",
|
||||||
|
help=(
|
||||||
|
"Additional skills directory to include (repeatable). Useful "
|
||||||
|
"when skills live in multiple locations on the same machine "
|
||||||
|
"(e.g. project-local plus a user-global install)."
|
||||||
|
),
|
||||||
|
)
|
||||||
|
return parser.parse_args(argv)
|
||||||
|
|
||||||
|
|
||||||
|
def main(argv: list[str]) -> int:
|
||||||
|
args = parse_args(argv)
|
||||||
|
project_root = Path(args.project_root).expanduser().resolve()
|
||||||
|
if not project_root.is_dir():
|
||||||
|
print(
|
||||||
|
f"error: project-root does not exist or is not a directory: {project_root}",
|
||||||
|
file=sys.stderr,
|
||||||
|
)
|
||||||
|
return 2
|
||||||
|
|
||||||
|
primary = (
|
||||||
|
Path(args.skills_root).expanduser().resolve()
|
||||||
|
if args.skills_root
|
||||||
|
else default_skills_root()
|
||||||
|
)
|
||||||
|
extras = [Path(p).expanduser().resolve() for p in args.extra_root]
|
||||||
|
# Deduplicate in order of appearance.
|
||||||
|
roots: list[Path] = []
|
||||||
|
for root in [primary, *extras]:
|
||||||
|
if root not in roots:
|
||||||
|
roots.append(root)
|
||||||
|
|
||||||
|
result = scan_skills(roots, project_root)
|
||||||
|
print(json.dumps(result, indent=2, sort_keys=True))
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
sys.exit(main(sys.argv[1:]))
|
||||||
|
|
@ -0,0 +1,249 @@
|
||||||
|
#!/usr/bin/env python3
|
||||||
|
# /// script
|
||||||
|
# requires-python = ">=3.11"
|
||||||
|
# ///
|
||||||
|
"""Unit tests for list_customizable_skills.py.
|
||||||
|
|
||||||
|
Exercises the scanner against a synthesized install tree:
|
||||||
|
- an agent-only customize.toml
|
||||||
|
- a workflow-only customize.toml
|
||||||
|
- a customize.toml that exposes both surfaces
|
||||||
|
- a skill directory with no customize.toml (ignored)
|
||||||
|
- a pre-existing team override in _bmad/custom/
|
||||||
|
- malformed TOML (surfaces as an error without aborting)
|
||||||
|
- multiple skills roots (e.g. project-local + user-global mix)
|
||||||
|
|
||||||
|
Run: python3 scripts/tests/test_list_customizable_skills.py
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import importlib.util
|
||||||
|
import json
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
import tempfile
|
||||||
|
import unittest
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
SCRIPT = Path(__file__).resolve().parent.parent / "list_customizable_skills.py"
|
||||||
|
|
||||||
|
|
||||||
|
def _load_module():
|
||||||
|
spec = importlib.util.spec_from_file_location("list_customizable_skills", SCRIPT)
|
||||||
|
module = importlib.util.module_from_spec(spec)
|
||||||
|
spec.loader.exec_module(module) # type: ignore[union-attr]
|
||||||
|
return module
|
||||||
|
|
||||||
|
|
||||||
|
MODULE = _load_module()
|
||||||
|
|
||||||
|
|
||||||
|
def _make_skill(parent: Path, name: str, body: str, skill_md: str | None = None) -> Path:
|
||||||
|
skill_dir = parent / name
|
||||||
|
skill_dir.mkdir(parents=True, exist_ok=True)
|
||||||
|
(skill_dir / "customize.toml").write_text(body, encoding="utf-8")
|
||||||
|
if skill_md is not None:
|
||||||
|
(skill_dir / "SKILL.md").write_text(skill_md, encoding="utf-8")
|
||||||
|
return skill_dir
|
||||||
|
|
||||||
|
|
||||||
|
class ScannerTest(unittest.TestCase):
|
||||||
|
def setUp(self):
|
||||||
|
self.tmp = tempfile.TemporaryDirectory()
|
||||||
|
self.root = Path(self.tmp.name)
|
||||||
|
self.skills = self.root / "skills"
|
||||||
|
self.skills.mkdir(parents=True)
|
||||||
|
self.custom = self.root / "_bmad" / "custom"
|
||||||
|
self.custom.mkdir(parents=True)
|
||||||
|
|
||||||
|
def tearDown(self):
|
||||||
|
self.tmp.cleanup()
|
||||||
|
|
||||||
|
def test_agent_only_skill_detected(self):
|
||||||
|
_make_skill(
|
||||||
|
self.skills,
|
||||||
|
"bmad-agent-pm",
|
||||||
|
"[agent]\nicon = \"🧠\"\n",
|
||||||
|
"---\nname: bmad-agent-pm\ndescription: Product manager.\n---\n",
|
||||||
|
)
|
||||||
|
result = MODULE.scan_skills([self.skills], self.root)
|
||||||
|
self.assertEqual(len(result["agents"]), 1)
|
||||||
|
self.assertEqual(len(result["workflows"]), 0)
|
||||||
|
entry = result["agents"][0]
|
||||||
|
self.assertEqual(entry["name"], "bmad-agent-pm")
|
||||||
|
self.assertEqual(entry["surface"], "agent")
|
||||||
|
self.assertEqual(entry["description"], "Product manager.")
|
||||||
|
self.assertFalse(entry["has_team_override"])
|
||||||
|
self.assertFalse(entry["has_user_override"])
|
||||||
|
|
||||||
|
def test_workflow_only_skill_detected(self):
|
||||||
|
_make_skill(
|
||||||
|
self.skills,
|
||||||
|
"bmad-create-prd",
|
||||||
|
"[workflow]\npersistent_facts = []\n",
|
||||||
|
"---\nname: bmad-create-prd\ndescription: 'Create a PRD.'\n---\n",
|
||||||
|
)
|
||||||
|
result = MODULE.scan_skills([self.skills], self.root)
|
||||||
|
self.assertEqual(len(result["agents"]), 0)
|
||||||
|
self.assertEqual(len(result["workflows"]), 1)
|
||||||
|
entry = result["workflows"][0]
|
||||||
|
self.assertEqual(entry["description"], "Create a PRD.")
|
||||||
|
|
||||||
|
def test_dual_surface_skill_emits_two_entries(self):
|
||||||
|
_make_skill(
|
||||||
|
self.skills,
|
||||||
|
"bmad-dual",
|
||||||
|
"[agent]\nicon = \"x\"\n\n[workflow]\npersistent_facts = []\n",
|
||||||
|
"---\nname: bmad-dual\ndescription: Dual.\n---\n",
|
||||||
|
)
|
||||||
|
result = MODULE.scan_skills([self.skills], self.root)
|
||||||
|
self.assertEqual(len(result["agents"]), 1)
|
||||||
|
self.assertEqual(len(result["workflows"]), 1)
|
||||||
|
self.assertEqual(result["agents"][0]["name"], "bmad-dual")
|
||||||
|
self.assertEqual(result["workflows"][0]["name"], "bmad-dual")
|
||||||
|
|
||||||
|
def test_skill_without_customize_toml_ignored(self):
|
||||||
|
(self.skills / "bmad-plain").mkdir()
|
||||||
|
(self.skills / "bmad-plain" / "SKILL.md").write_text("# plain\n")
|
||||||
|
result = MODULE.scan_skills([self.skills], self.root)
|
||||||
|
self.assertEqual(len(result["agents"]) + len(result["workflows"]), 0)
|
||||||
|
self.assertEqual(result["errors"], [])
|
||||||
|
|
||||||
|
def test_existing_team_override_flagged(self):
|
||||||
|
_make_skill(
|
||||||
|
self.skills,
|
||||||
|
"bmad-agent-pm",
|
||||||
|
"[agent]\nicon = \"x\"\n",
|
||||||
|
"---\nname: bmad-agent-pm\ndescription: PM.\n---\n",
|
||||||
|
)
|
||||||
|
(self.custom / "bmad-agent-pm.toml").write_text("[agent]\n")
|
||||||
|
result = MODULE.scan_skills([self.skills], self.root)
|
||||||
|
entry = result["agents"][0]
|
||||||
|
self.assertTrue(entry["has_team_override"])
|
||||||
|
self.assertFalse(entry["has_user_override"])
|
||||||
|
|
||||||
|
def test_missing_surface_block_reports_error(self):
|
||||||
|
_make_skill(self.skills, "bmad-broken", "[not_a_surface]\nfoo = 1\n")
|
||||||
|
result = MODULE.scan_skills([self.skills], self.root)
|
||||||
|
self.assertEqual(len(result["agents"]) + len(result["workflows"]), 0)
|
||||||
|
self.assertEqual(len(result["errors"]), 1)
|
||||||
|
self.assertIn("no [agent] or [workflow] block", result["errors"][0])
|
||||||
|
|
||||||
|
def test_malformed_toml_reports_error_without_aborting(self):
|
||||||
|
skill_dir = self.skills / "bmad-bad"
|
||||||
|
skill_dir.mkdir()
|
||||||
|
(skill_dir / "customize.toml").write_text("this is not [valid toml\n")
|
||||||
|
# Plus a good sibling to confirm scanning continues.
|
||||||
|
_make_skill(
|
||||||
|
self.skills,
|
||||||
|
"bmad-good",
|
||||||
|
"[agent]\nicon = \"x\"\n",
|
||||||
|
"---\nname: bmad-good\ndescription: Good.\n---\n",
|
||||||
|
)
|
||||||
|
result = MODULE.scan_skills([self.skills], self.root)
|
||||||
|
self.assertEqual(len(result["agents"]), 1)
|
||||||
|
self.assertEqual(result["agents"][0]["name"], "bmad-good")
|
||||||
|
self.assertTrue(any("failed to parse" in e for e in result["errors"]))
|
||||||
|
|
||||||
|
def test_description_with_double_quotes_stripped(self):
|
||||||
|
_make_skill(
|
||||||
|
self.skills,
|
||||||
|
"bmad-q",
|
||||||
|
"[agent]\nicon = \"x\"\n",
|
||||||
|
'---\nname: bmad-q\ndescription: "Double-quoted desc."\n---\n',
|
||||||
|
)
|
||||||
|
result = MODULE.scan_skills([self.skills], self.root)
|
||||||
|
self.assertEqual(result["agents"][0]["description"], "Double-quoted desc.")
|
||||||
|
|
||||||
|
def test_multiple_skills_roots_are_merged(self):
|
||||||
|
extra_root = self.root / "extra-skills"
|
||||||
|
extra_root.mkdir()
|
||||||
|
_make_skill(
|
||||||
|
self.skills,
|
||||||
|
"bmad-agent-pm",
|
||||||
|
"[agent]\nicon = \"x\"\n",
|
||||||
|
"---\nname: bmad-agent-pm\ndescription: PM.\n---\n",
|
||||||
|
)
|
||||||
|
_make_skill(
|
||||||
|
extra_root,
|
||||||
|
"bmad-agent-dev",
|
||||||
|
"[agent]\nicon = \"y\"\n",
|
||||||
|
"---\nname: bmad-agent-dev\ndescription: Dev.\n---\n",
|
||||||
|
)
|
||||||
|
result = MODULE.scan_skills([self.skills, extra_root], self.root)
|
||||||
|
names = {a["name"] for a in result["agents"]}
|
||||||
|
self.assertEqual(names, {"bmad-agent-pm", "bmad-agent-dev"})
|
||||||
|
self.assertEqual(len(result["scanned_roots"]), 2)
|
||||||
|
|
||||||
|
def test_duplicate_skill_name_across_roots_first_wins(self):
|
||||||
|
extra_root = self.root / "extra-skills"
|
||||||
|
extra_root.mkdir()
|
||||||
|
_make_skill(
|
||||||
|
self.skills,
|
||||||
|
"bmad-agent-pm",
|
||||||
|
"[agent]\nicon = \"primary\"\n",
|
||||||
|
"---\nname: bmad-agent-pm\ndescription: Primary.\n---\n",
|
||||||
|
)
|
||||||
|
_make_skill(
|
||||||
|
extra_root,
|
||||||
|
"bmad-agent-pm",
|
||||||
|
"[agent]\nicon = \"duplicate\"\n",
|
||||||
|
"---\nname: bmad-agent-pm\ndescription: Duplicate.\n---\n",
|
||||||
|
)
|
||||||
|
result = MODULE.scan_skills([self.skills, extra_root], self.root)
|
||||||
|
self.assertEqual(len(result["agents"]), 1)
|
||||||
|
self.assertEqual(result["agents"][0]["description"], "Primary.")
|
||||||
|
self.assertEqual(result["agents"][0]["skills_root"], str(self.skills))
|
||||||
|
|
||||||
|
def test_missing_skills_root_reports_error(self):
|
||||||
|
result = MODULE.scan_skills(
|
||||||
|
[self.root / "does-not-exist", self.skills],
|
||||||
|
self.root,
|
||||||
|
)
|
||||||
|
self.assertTrue(any("skills root does not exist" in e for e in result["errors"]))
|
||||||
|
|
||||||
|
def test_cli_emits_valid_json_and_exits_zero(self):
|
||||||
|
_make_skill(
|
||||||
|
self.skills,
|
||||||
|
"bmad-agent-pm",
|
||||||
|
"[agent]\nicon = \"x\"\n",
|
||||||
|
"---\nname: bmad-agent-pm\ndescription: PM.\n---\n",
|
||||||
|
)
|
||||||
|
proc = subprocess.run(
|
||||||
|
[
|
||||||
|
sys.executable,
|
||||||
|
str(SCRIPT),
|
||||||
|
"--project-root",
|
||||||
|
str(self.root),
|
||||||
|
"--skills-root",
|
||||||
|
str(self.skills),
|
||||||
|
],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
self.assertEqual(proc.returncode, 0, proc.stderr)
|
||||||
|
payload = json.loads(proc.stdout)
|
||||||
|
self.assertEqual(len(payload["agents"]), 1)
|
||||||
|
|
||||||
|
def test_cli_exits_two_on_missing_project_root(self):
|
||||||
|
proc = subprocess.run(
|
||||||
|
[
|
||||||
|
sys.executable,
|
||||||
|
str(SCRIPT),
|
||||||
|
"--project-root",
|
||||||
|
str(self.root / "does-not-exist"),
|
||||||
|
"--skills-root",
|
||||||
|
str(self.skills),
|
||||||
|
],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
self.assertEqual(proc.returncode, 2)
|
||||||
|
self.assertIn("does not exist", proc.stderr)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
|
|
@ -10,3 +10,4 @@ Core,bmad-editorial-review-structure,Editorial Review - Structure,ES,Use when do
|
||||||
Core,bmad-review-adversarial-general,Adversarial Review,AR,"Use for quality assurance or before finalizing deliverables. Code Review in other modules runs this automatically, but also useful for document reviews.",[path],anytime,,,false,,
|
Core,bmad-review-adversarial-general,Adversarial Review,AR,"Use for quality assurance or before finalizing deliverables. Code Review in other modules runs this automatically, but also useful for document reviews.",[path],anytime,,,false,,
|
||||||
Core,bmad-review-edge-case-hunter,Edge Case Hunter Review,ECH,Use alongside adversarial review for orthogonal coverage — method-driven not attitude-driven.,[path],anytime,,,false,,
|
Core,bmad-review-edge-case-hunter,Edge Case Hunter Review,ECH,Use alongside adversarial review for orthogonal coverage — method-driven not attitude-driven.,[path],anytime,,,false,,
|
||||||
Core,bmad-distillator,Distillator,DG,Use when you need token-efficient distillates that preserve all information for downstream LLM consumption.,[path],anytime,,,false,adjacent to source document or specified output_path,distillate markdown file(s)
|
Core,bmad-distillator,Distillator,DG,Use when you need token-efficient distillates that preserve all information for downstream LLM consumption.,[path],anytime,,,false,adjacent to source document or specified output_path,distillate markdown file(s)
|
||||||
|
Core,bmad-customize,BMad Customize,BC,"Use when you want to change how an agent or workflow behaves — add persistent facts, swap templates, insert activation hooks, or customize menus. Scans what's customizable, picks the right scope (agent vs workflow), writes the override to _bmad/custom/, and verifies the merge. No TOML hand-authoring required.",,anytime,,,false,{project-root}/_bmad/custom,TOML override files
|
||||||
|
|
|
||||||
|
Can't render this file because it has a wrong number of fields in line 3.
|
Loading…
Reference in New Issue