chore: update documentation to reflect recent architectural changes and improve clarity
This commit is contained in:
@@ -3,7 +3,7 @@ name: 'step-01-init'
|
||||
description: 'Initialize the product brief workflow by detecting continuation state and setting up the document'
|
||||
|
||||
# File References
|
||||
nextStepFile: './step-02-vision.md'
|
||||
nextStepFile: '{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md'
|
||||
outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md'
|
||||
|
||||
# Template References
|
||||
@@ -73,7 +73,7 @@ If the document exists and has frontmatter with `stepsCompleted`:
|
||||
|
||||
**Continuation Protocol:**
|
||||
|
||||
- **STOP immediately** and load `./step-01b-continue.md`
|
||||
- **STOP immediately** and load `{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md`
|
||||
- Do not proceed with any initialization tasks
|
||||
- Let step-01b handle all continuation logic
|
||||
- This is an auto-proceed situation - no user choice needed
|
||||
|
||||
@@ -95,9 +95,9 @@ Does this look right, or do you want to make any adjustments before we proceed?"
|
||||
**Next Step Logic:**
|
||||
Based on `lastStep` value, determine which step to load next:
|
||||
|
||||
- If `lastStep = 1` → Load `./step-02-vision.md`
|
||||
- If `lastStep = 2` → Load `./step-03-users.md`
|
||||
- If `lastStep = 3` → Load `./step-04-metrics.md`
|
||||
- If `lastStep = 1` → Load `{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md`
|
||||
- If `lastStep = 2` → Load `{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md`
|
||||
- If `lastStep = 3` → Load `{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md`
|
||||
- Continue this pattern for all steps
|
||||
- If `lastStep = 6` → Workflow already complete
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@ name: 'step-02-vision'
|
||||
description: 'Discover and define the core product vision, problem statement, and unique value proposition'
|
||||
|
||||
# File References
|
||||
nextStepFile: './step-03-users.md'
|
||||
nextStepFile: '{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md'
|
||||
outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md'
|
||||
|
||||
# Task References
|
||||
|
||||
@@ -3,7 +3,7 @@ name: 'step-03-users'
|
||||
description: 'Define target users with rich personas and map their key interactions with the product'
|
||||
|
||||
# File References
|
||||
nextStepFile: './step-04-metrics.md'
|
||||
nextStepFile: '{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md'
|
||||
outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md'
|
||||
|
||||
# Task References
|
||||
|
||||
@@ -3,7 +3,7 @@ name: 'step-04-metrics'
|
||||
description: 'Define comprehensive success metrics that include user success, business objectives, and key performance indicators'
|
||||
|
||||
# File References
|
||||
nextStepFile: './step-05-scope.md'
|
||||
nextStepFile: '{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md'
|
||||
outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md'
|
||||
|
||||
# Task References
|
||||
|
||||
@@ -3,7 +3,7 @@ name: 'step-05-scope'
|
||||
description: 'Define MVP scope with clear boundaries and outline future vision while managing scope creep'
|
||||
|
||||
# File References
|
||||
nextStepFile: './step-06-complete.md'
|
||||
nextStepFile: '{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md'
|
||||
outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md'
|
||||
|
||||
# Task References
|
||||
|
||||
@@ -128,7 +128,7 @@ Recap that the brief captures everything needed to guide subsequent product deve
|
||||
|
||||
### 5. Suggest next steps
|
||||
|
||||
Product Brief complete. Read fully and follow: `_bmad/core/tasks/help.md` with argument `Validate PRD`.
|
||||
Product Brief complete. Read fully and follow: `{project-root}/_bmad/core/tasks/help.md`
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
name: create-product-brief
|
||||
description: Create comprehensive product briefs through collaborative step-by-step discovery as creative Business Analyst working with the user as peers.
|
||||
description: 'Create product brief through collaborative discovery. Use when the user says "lets create a product brief" or "help me create a project brief"'
|
||||
---
|
||||
|
||||
# Product Brief Workflow
|
||||
|
||||
@@ -78,7 +78,7 @@ For **{{research_topic}}**, I will research:
|
||||
|
||||
- Document scope confirmation in research file
|
||||
- Update frontmatter: `stepsCompleted: [1]`
|
||||
- Load: `./step-02-domain-analysis.md`
|
||||
- Load: `{project-root}/_bmad/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -132,6 +132,6 @@ When user selects 'C', append scope confirmation:
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C', load `./step-02-domain-analysis.md` to begin industry analysis.
|
||||
After user selects 'C', load `{project-root}/_bmad/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md` to begin industry analysis.
|
||||
|
||||
Remember: This is SCOPE CONFIRMATION ONLY - no actual domain research yet, just confirming the research approach and scope!
|
||||
|
||||
@@ -171,7 +171,7 @@ _Source: [URL]_
|
||||
|
||||
- **CONTENT ALREADY WRITTEN TO DOCUMENT**
|
||||
- Update frontmatter: `stepsCompleted: [1, 2]`
|
||||
- Load: `./step-03-competitive-landscape.md`
|
||||
- Load: `{project-root}/_bmad/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -224,6 +224,6 @@ Content is already written to document when generated in step 4. No additional a
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C', load `./step-03-competitive-landscape.md` to analyze competitive landscape, key players, and ecosystem analysis for {{research_topic}}.
|
||||
After user selects 'C', load `{project-root}/_bmad/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md` to analyze competitive landscape, key players, and ecosystem analysis for {{research_topic}}.
|
||||
|
||||
Remember: Always write research content to document immediately and search the web to verify facts!
|
||||
|
||||
@@ -180,7 +180,7 @@ _Source: [URL]_
|
||||
|
||||
- **CONTENT ALREADY WRITTEN TO DOCUMENT**
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3]`
|
||||
- Load: `./step-04-regulatory-focus.md`
|
||||
- Load: `{project-root}/_bmad/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -233,6 +233,6 @@ Content is already written to document when generated in step 4. No additional a
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C', load `./step-04-regulatory-focus.md` to analyze regulatory requirements, compliance frameworks, and legal considerations for {{research_topic}}.
|
||||
After user selects 'C', load `{project-root}/_bmad/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md` to analyze regulatory requirements, compliance frameworks, and legal considerations for {{research_topic}}.
|
||||
|
||||
Remember: Always write research content to document immediately and search the web to verify facts!
|
||||
|
||||
@@ -155,7 +155,7 @@ Show the generated regulatory analysis and present continue option:
|
||||
|
||||
- **CONTENT ALREADY WRITTEN TO DOCUMENT**
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4]`
|
||||
- Load: `./step-05-technical-trends.md`
|
||||
- Load: `{project-root}/_bmad/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -201,6 +201,6 @@ Content is already written to document when generated in step 5. No additional a
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-05-technical-trends.md` to analyze technical trends and innovations in the domain.
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md` to analyze technical trends and innovations in the domain.
|
||||
|
||||
Remember: Search the web to verify regulatory facts and provide practical implementation considerations!
|
||||
|
||||
@@ -174,7 +174,7 @@ Show the generated technical analysis and present complete option:
|
||||
|
||||
- **CONTENT ALREADY WRITTEN TO DOCUMENT**
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5]`
|
||||
- Load: `./step-06-research-synthesis.md`
|
||||
- Load: `{project-root}/_bmad/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
|
||||
@@ -373,6 +373,7 @@ _This comprehensive research document serves as an authoritative reference on {{
|
||||
|
||||
#### If 'C' (Complete Research):
|
||||
|
||||
- **Replace** the template placeholder `[Research overview and methodology will be appended here]` in the `## Research Overview` section near the top of the document with a concise 2-3 paragraph overview summarizing the research scope, key findings, and a pointer to the full executive summary in the Research Synthesis section
|
||||
- Append the complete document to the research file
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5]`
|
||||
- Complete the domain research workflow
|
||||
@@ -380,7 +381,7 @@ _This comprehensive research document serves as an authoritative reference on {{
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the complete comprehensive research document using the full structure above.
|
||||
When user selects 'C', append the complete comprehensive research document using the full structure above. Also replace the `[Research overview and methodology will be appended here]` placeholder in the Research Overview section at the top of the document.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
|
||||
@@ -138,7 +138,7 @@ Show initial scope document and present continue option:
|
||||
|
||||
- Update frontmatter: `stepsCompleted: [1]`
|
||||
- Add confirmation note to document: "Scope confirmed by user on {{date}}"
|
||||
- Load: `./step-02-customer-behavior.md`
|
||||
- Load: `{project-root}/_bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md`
|
||||
|
||||
#### If 'Modify':
|
||||
|
||||
@@ -177,6 +177,6 @@ This step ensures:
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user confirmation and scope finalization, load `./step-02-customer-insights.md` to begin detailed market research with customer insights analysis.
|
||||
After user confirmation and scope finalization, load `{project-root}/_bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md` to begin detailed market research with customer insights analysis.
|
||||
|
||||
Remember: Init steps confirm understanding and scope, not generate research content!
|
||||
|
||||
@@ -179,7 +179,7 @@ _Source: [URL]_
|
||||
|
||||
- **CONTENT ALREADY WRITTEN TO DOCUMENT**
|
||||
- Update frontmatter: `stepsCompleted: [1, 2]`
|
||||
- Load: `./step-03-customer-pain-points.md`
|
||||
- Load: `{project-root}/_bmad/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -232,6 +232,6 @@ Content is already written to document when generated in step 4. No additional a
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C', load `./step-03-customer-pain-points.md` to analyze customer pain points, challenges, and unmet needs for {{research_topic}}.
|
||||
After user selects 'C', load `{project-root}/_bmad/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md` to analyze customer pain points, challenges, and unmet needs for {{research_topic}}.
|
||||
|
||||
Remember: Always write research content to document immediately and emphasize current customer data with rigorous source verification!
|
||||
|
||||
@@ -190,7 +190,7 @@ _Source: [URL]_
|
||||
|
||||
- **CONTENT ALREADY WRITTEN TO DOCUMENT**
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3]`
|
||||
- Load: `./step-04-customer-decisions.md`
|
||||
- Load: `{project-root}/_bmad/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -244,6 +244,6 @@ Content is already written to document when generated in step 4. No additional a
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C', load `./step-04-customer-decisions.md` to analyze customer decision processes, journey mapping, and decision factors for {{research_topic}}.
|
||||
After user selects 'C', load `{project-root}/_bmad/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md` to analyze customer decision processes, journey mapping, and decision factors for {{research_topic}}.
|
||||
|
||||
Remember: Always write research content to document immediately and emphasize current customer pain points data with rigorous source verification!
|
||||
|
||||
@@ -200,7 +200,7 @@ _Source: [URL]_
|
||||
|
||||
- **CONTENT ALREADY WRITTEN TO DOCUMENT**
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4]`
|
||||
- Load: `./step-05-competitive-analysis.md`
|
||||
- Load: `{project-root}/_bmad/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -254,6 +254,6 @@ Content is already written to document when generated in step 4. No additional a
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C', load `./step-05-competitive-analysis.md` to analyze competitive landscape, market positioning, and competitive strategies for {{research_topic}}.
|
||||
After user selects 'C', load `{project-root}/_bmad/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md` to analyze competitive landscape, market positioning, and competitive strategies for {{research_topic}}.
|
||||
|
||||
Remember: Always write research content to document immediately and emphasize current customer decision data with rigorous source verification!
|
||||
|
||||
@@ -389,13 +389,14 @@ _This comprehensive market research document serves as an authoritative market r
|
||||
|
||||
#### If 'C' (Complete Research):
|
||||
|
||||
- **Replace** the template placeholder `[Research overview and methodology will be appended here]` in the `## Research Overview` section near the top of the document with a concise 2-3 paragraph overview summarizing the research scope, key findings, and a pointer to the full executive summary in the Research Synthesis section
|
||||
- Append the final content to the research document
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4]`
|
||||
- Complete the market research workflow
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the research document using the structure from step 4.
|
||||
When user selects 'C', append the content directly to the research document using the structure from step 4. Also replace the `[Research overview and methodology will be appended here]` placeholder in the Research Overview section at the top of the document.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
|
||||
@@ -78,7 +78,7 @@ For **{{research_topic}}**, I will research:
|
||||
|
||||
- Document scope confirmation in research file
|
||||
- Update frontmatter: `stepsCompleted: [1]`
|
||||
- Load: `./step-02-technical-overview.md`
|
||||
- Load: `{project-root}/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -132,6 +132,6 @@ When user selects 'C', append scope confirmation:
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C', load `./step-02-technical-overview.md` to begin technology stack analysis.
|
||||
After user selects 'C', load `{project-root}/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md` to begin technology stack analysis.
|
||||
|
||||
Remember: This is SCOPE CONFIRMATION ONLY - no actual technical research yet, just confirming the research approach and scope!
|
||||
|
||||
@@ -180,7 +180,7 @@ _Source: [URL]_
|
||||
|
||||
- **CONTENT ALREADY WRITTEN TO DOCUMENT**
|
||||
- Update frontmatter: `stepsCompleted: [1, 2]`
|
||||
- Load: `./step-03-integration-patterns.md`
|
||||
- Load: `{project-root}/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -234,6 +234,6 @@ Content is already written to document when generated in step 4. No additional a
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C', load `./step-03-integration-patterns.md` to analyze APIs, communication protocols, and system interoperability for {{research_topic}}.
|
||||
After user selects 'C', load `{project-root}/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md` to analyze APIs, communication protocols, and system interoperability for {{research_topic}}.
|
||||
|
||||
Remember: Always write research content to document immediately and emphasize current technology data with rigorous source verification!
|
||||
|
||||
@@ -189,7 +189,7 @@ _Source: [URL]_
|
||||
|
||||
- **CONTENT ALREADY WRITTEN TO DOCUMENT**
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3]`
|
||||
- Load: `./step-04-architectural-patterns.md`
|
||||
- Load: `{project-root}/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -243,6 +243,6 @@ Content is already written to document when generated in step 4. No additional a
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C', load `./step-04-architectural-patterns.md` to analyze architectural patterns, design decisions, and system structures for {{research_topic}}.
|
||||
After user selects 'C', load `{project-root}/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md` to analyze architectural patterns, design decisions, and system structures for {{research_topic}}.
|
||||
|
||||
Remember: Always write research content to document immediately and emphasize current integration data with rigorous source verification!
|
||||
|
||||
@@ -156,7 +156,7 @@ Show the generated architectural patterns and present continue option:
|
||||
|
||||
- Append the final content to the research document
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4]`
|
||||
- Load: `./step-05-implementation-research.md`
|
||||
- Load: `{project-root}/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -197,6 +197,6 @@ When user selects 'C', append the content directly to the research document usin
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-05-implementation-research.md` to focus on implementation approaches and technology adoption.
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md` to focus on implementation approaches and technology adoption.
|
||||
|
||||
Remember: Always emphasize current architectural data and rigorous source verification!
|
||||
|
||||
@@ -179,7 +179,7 @@ Show the generated implementation research and present continue option:
|
||||
|
||||
- Append the final content to the research document
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5]`
|
||||
- Load: `./step-06-research-synthesis.md`
|
||||
- Load: `{project-root}/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -230,4 +230,4 @@ When 'C' is selected:
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C', load `./step-06-research-synthesis.md` to produce the comprehensive technical research document with narrative introduction, detailed TOC, and executive summary.
|
||||
After user selects 'C', load `{project-root}/_bmad/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md` to produce the comprehensive technical research document with narrative introduction, detailed TOC, and executive summary.
|
||||
|
||||
@@ -416,6 +416,7 @@ _This comprehensive technical research document serves as an authoritative techn
|
||||
|
||||
#### If 'C' (Complete Research):
|
||||
|
||||
- **Replace** the template placeholder `[Research overview and methodology will be appended here]` in the `## Research Overview` section near the top of the document with a concise 2-3 paragraph overview summarizing the research scope, key findings, and a pointer to the full executive summary in the Research Synthesis section
|
||||
- Append the complete technical document to the research file
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6]`
|
||||
- Complete the technical research workflow
|
||||
@@ -423,7 +424,7 @@ _This comprehensive technical research document serves as an authoritative techn
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the complete comprehensive technical research document using the full structure above.
|
||||
When user selects 'C', append the complete comprehensive technical research document using the full structure above. Also replace the `[Research overview and methodology will be appended here]` placeholder in the Research Overview section at the top of the document.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
name: domain-research
|
||||
description: Conduct domain research covering industry analysis, regulations, technology trends, and ecosystem dynamics using current web data and verified sources.
|
||||
description: 'Conduct domain and industry research. Use when the user says "lets create a research report on [domain or industry]"'
|
||||
---
|
||||
|
||||
# Domain Research Workflow
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
name: market-research
|
||||
description: Conduct market research covering market size, growth, competition, and customer insights using current web data and verified sources.
|
||||
description: 'Conduct market research on competition and customers. Use when the user says "create a market research report about [business idea]".'
|
||||
---
|
||||
|
||||
# Market Research Workflow
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
name: technical-research
|
||||
description: Conduct technical research covering technology evaluation, architecture decisions, and implementation approaches using current web data and verified sources.
|
||||
description: 'Conduct technical research on technologies and architecture. Use when the user says "create a technical research report on [topic]".'
|
||||
---
|
||||
|
||||
# Technical Research Workflow
|
||||
|
||||
@@ -79,9 +79,8 @@ Review the frontmatter to understand:
|
||||
**Example:**
|
||||
- If `stepsCompleted = ["step-01-init.md", "step-02-discovery.md", "step-03-success.md"]`
|
||||
- Last element is `"step-03-success.md"`
|
||||
- Load `step-03-success.md`, read its frontmatter
|
||||
- Find `nextStepFile: './step-04-journeys.md'`
|
||||
- Next step to load is `./step-04-journeys.md`
|
||||
- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-03-success.md`, read its frontmatter
|
||||
- Read fully and follow: `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-04-journeys.md`
|
||||
|
||||
### 4. Handle Workflow Completion
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@ name: 'step-02-discovery'
|
||||
description: 'Discover project type, domain, and context through collaborative dialogue'
|
||||
|
||||
# File References
|
||||
nextStepFile: './step-02b-vision.md'
|
||||
nextStepFile: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02b-vision.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
|
||||
# Data Files
|
||||
|
||||
@@ -3,7 +3,7 @@ name: 'step-02b-vision'
|
||||
description: 'Discover the product vision and differentiator through collaborative dialogue'
|
||||
|
||||
# File References
|
||||
nextStepFile: './step-02c-executive-summary.md'
|
||||
nextStepFile: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02c-executive-summary.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
|
||||
# Task References
|
||||
|
||||
@@ -3,7 +3,7 @@ name: 'step-02c-executive-summary'
|
||||
description: 'Generate and append the Executive Summary section to the PRD document'
|
||||
|
||||
# File References
|
||||
nextStepFile: './step-03-success.md'
|
||||
nextStepFile: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-03-success.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
|
||||
# Task References
|
||||
|
||||
@@ -3,7 +3,7 @@ name: 'step-03-success'
|
||||
description: 'Define comprehensive success criteria covering user, business, and technical success'
|
||||
|
||||
# File References
|
||||
nextStepFile: './step-04-journeys.md'
|
||||
nextStepFile: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-04-journeys.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
|
||||
# Task References
|
||||
@@ -221,6 +221,6 @@ If working in regulated domains (healthcare, fintech, govtech):
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-04-journeys.md` to map user journeys.
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-04-journeys.md` to map user journeys.
|
||||
|
||||
Remember: Do NOT proceed to step-04 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
||||
@@ -3,7 +3,7 @@ name: 'step-04-journeys'
|
||||
description: 'Map ALL user types that interact with the system with narrative story-based journeys'
|
||||
|
||||
# File References
|
||||
nextStepFile: './step-05-domain.md'
|
||||
nextStepFile: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-05-domain.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
|
||||
# Task References
|
||||
@@ -208,6 +208,6 @@ When user selects 'C', append the content directly to the document using the str
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-05-domain.md`.
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-05-domain.md`.
|
||||
|
||||
Remember: Do NOT proceed to step-05 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
||||
@@ -3,9 +3,9 @@ name: 'step-05-domain'
|
||||
description: 'Explore domain-specific requirements for complex domains (optional step)'
|
||||
|
||||
# File References
|
||||
nextStepFile: './step-06-innovation.md'
|
||||
nextStepFile: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-06-innovation.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
domainComplexityCSV: '../data/domain-complexity.csv'
|
||||
domainComplexityCSV: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/data/domain-complexity.csv'
|
||||
|
||||
# Task References
|
||||
advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
|
||||
|
||||
@@ -3,11 +3,11 @@ name: 'step-06-innovation'
|
||||
description: 'Detect and explore innovative aspects of the product (optional step)'
|
||||
|
||||
# File References
|
||||
nextStepFile: './step-07-project-type.md'
|
||||
nextStepFile: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-07-project-type.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
|
||||
# Data Files
|
||||
projectTypesCSV: '../data/project-types.csv'
|
||||
projectTypesCSV: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/data/project-types.csv'
|
||||
|
||||
# Task References
|
||||
advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
|
||||
|
||||
@@ -3,7 +3,7 @@ name: 'step-07-project-type'
|
||||
description: 'Conduct project-type specific discovery using CSV-driven guidance'
|
||||
|
||||
# File References
|
||||
nextStepFile: './step-08-scoping.md'
|
||||
nextStepFile: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-08-scoping.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
|
||||
# Data Files
|
||||
|
||||
@@ -3,7 +3,7 @@ name: 'step-08-scoping'
|
||||
description: 'Define MVP boundaries and prioritize features across development phases'
|
||||
|
||||
# File References
|
||||
nextStepFile: './step-09-functional.md'
|
||||
nextStepFile: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-09-functional.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
|
||||
# Task References
|
||||
|
||||
@@ -3,7 +3,7 @@ name: 'step-09-functional'
|
||||
description: 'Synthesize all discovery into comprehensive functional requirements'
|
||||
|
||||
# File References
|
||||
nextStepFile: './step-10-nonfunctional.md'
|
||||
nextStepFile: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-10-nonfunctional.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
|
||||
# Task References
|
||||
|
||||
@@ -3,7 +3,7 @@ name: 'step-10-nonfunctional'
|
||||
description: 'Define quality attributes that matter for this specific product'
|
||||
|
||||
# File References
|
||||
nextStepFile: './step-11-polish.md'
|
||||
nextStepFile: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-11-polish.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
|
||||
# Task References
|
||||
|
||||
@@ -3,9 +3,9 @@ name: 'step-11-polish'
|
||||
description: 'Optimize and polish the complete PRD document for flow, coherence, and readability'
|
||||
|
||||
# File References
|
||||
nextStepFile: './step-12-complete.md'
|
||||
nextStepFile: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-12-complete.md'
|
||||
outputFile: '{planning_artifacts}/prd.md'
|
||||
purposeFile: '../data/prd-purpose.md'
|
||||
purposeFile: '{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/data/prd-purpose.md'
|
||||
|
||||
# Task References
|
||||
advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
|
||||
@@ -212,6 +212,6 @@ When user selects 'C', replace the entire document content with the polished ver
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and polished document is saved, load `./step-12-complete.md` to complete the workflow.
|
||||
After user selects 'C' and polished document is saved, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-12-complete.md` to complete the workflow.
|
||||
|
||||
Remember: Do NOT proceed to step-12 until user explicitly selects 'C' from the A/P/C menu and polished document is saved!
|
||||
|
||||
@@ -87,7 +87,7 @@ Offer validation workflows to ensure PRD is ready for implementation:
|
||||
|
||||
### 4. Suggest Next Workflows
|
||||
|
||||
PRD complete. Read fully and follow: `_bmad/core/tasks/help.md` with argument `Create PRD`.
|
||||
PRD complete. Read fully and follow: `{project-root}/_bmad/core/tasks/help.md`
|
||||
|
||||
### 5. Final Completion Confirmation
|
||||
|
||||
|
||||
@@ -197,7 +197,7 @@ Display:
|
||||
- **IF X (Exit):**
|
||||
- Display: "**Validation Report Saved:** {validationReportPath}"
|
||||
- Display: "**Summary:** {overall status} - {recommendation}"
|
||||
- PRD Validation complete. Read fully and follow: `_bmad/core/tasks/help.md` with argument `Validate PRD`.
|
||||
- PRD Validation complete. Read fully and follow: `{project-root}/_bmad/core/tasks/help.md`
|
||||
|
||||
- **IF Any other:** Help user, then redisplay menu
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
name: create-prd
|
||||
description: Create a comprehensive PRD (Product Requirements Document) through structured workflow facilitation
|
||||
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"'
|
||||
main_config: '{project-root}/_bmad/bmm/config.yaml'
|
||||
nextStep: './steps-c/step-01-init.md'
|
||||
---
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
name: edit-prd
|
||||
description: Edit and improve an existing PRD - enhance clarity, completeness, and quality
|
||||
description: 'Edit an existing PRD. Use when the user says "edit this PRD".'
|
||||
main_config: '{project-root}/_bmad/bmm/config.yaml'
|
||||
editWorkflow: './steps-e/step-e-01-discovery.md'
|
||||
---
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
name: validate-prd
|
||||
description: Validate an existing PRD against BMAD standards - comprehensive review for completeness, clarity, and quality
|
||||
description: 'Validate a PRD against standards. Use when the user says "validate this PRD" or "run PRD validation"'
|
||||
main_config: '{project-root}/_bmad/bmm/config.yaml'
|
||||
validateWorkflow: './steps-v/step-v-01-discovery.md'
|
||||
---
|
||||
|
||||
@@ -44,7 +44,7 @@ First, check if the output document already exists:
|
||||
|
||||
If the document exists and has frontmatter with `stepsCompleted`:
|
||||
|
||||
- **STOP here** and load `./step-01b-continue.md` immediately
|
||||
- **STOP here** and load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md` immediately
|
||||
- Do not proceed with any initialization tasks
|
||||
- Let step-01b handle the continuation logic
|
||||
|
||||
@@ -110,7 +110,7 @@ Do you have any other documents you'd like me to include, or shall we continue t
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects [C] to continue, ensure the file `{planning_artifacts}/ux-design-specification.md` has been created and saved, and then load `./step-02-discovery.md` to begin the UX discovery phase.
|
||||
After user selects [C] to continue, ensure the file `{planning_artifacts}/ux-design-specification.md` has been created and saved, and then load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md` to begin the UX discovery phase.
|
||||
|
||||
Remember: Do NOT proceed to step-02 until output file has been updated and user explicitly selects [C] to continue!
|
||||
|
||||
|
||||
@@ -72,9 +72,9 @@ Does this look right, or do you want to make any adjustments before we proceed?"
|
||||
|
||||
Based on `lastStep` value, determine which step to load next:
|
||||
|
||||
- If `lastStep = 1` → Load `./step-02-discovery.md`
|
||||
- If `lastStep = 2` → Load `./step-03-core-experience.md`
|
||||
- If `lastStep = 3` → Load `./step-04-emotional-response.md`
|
||||
- If `lastStep = 1` → Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md`
|
||||
- If `lastStep = 2` → Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md`
|
||||
- If `lastStep = 3` → Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md`
|
||||
- Continue this pattern for all steps
|
||||
- If `lastStep` indicates final step → Workflow already complete
|
||||
|
||||
|
||||
@@ -155,11 +155,11 @@ Show the generated project understanding content and present choices:
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2]`
|
||||
- Load `./step-03-core-experience.md`
|
||||
- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
When user selects 'C', append the content directly to the document. Only after the content is saved to document, read fully and follow: `./step-03-core-experience.md`.
|
||||
When user selects 'C', append the content directly to the document. Only after the content is saved to document, read fully and follow: `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md`.
|
||||
|
||||
## SUCCESS METRICS:
|
||||
|
||||
|
||||
@@ -179,7 +179,7 @@ Show the generated core experience content and present choices:
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-04-emotional-response.md`
|
||||
- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -211,6 +211,6 @@ When user selects 'C', append the content directly to the document using the str
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-04-emotional-response.md` to define desired emotional responses.
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md` to define desired emotional responses.
|
||||
|
||||
Remember: Do NOT proceed to step-04 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
||||
@@ -182,7 +182,7 @@ Show the generated emotional response content and present choices:
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-05-inspiration.md`
|
||||
- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -214,6 +214,6 @@ When user selects 'C', append the content directly to the document using the str
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-05-inspiration.md` to analyze UX patterns from inspiring products.
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md` to analyze UX patterns from inspiring products.
|
||||
|
||||
Remember: Do NOT proceed to step-05 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
||||
@@ -197,7 +197,7 @@ Show the generated inspiration analysis content and present choices:
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Read fully and follow: `./step-06-design-system.md`
|
||||
- Read fully and follow: `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -229,6 +229,6 @@ When user selects 'C', append the content directly to the document using the str
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-06-design-system.md` to choose the appropriate design system approach.
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md` to choose the appropriate design system approach.
|
||||
|
||||
Remember: Do NOT proceed to step-06 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
||||
@@ -215,7 +215,7 @@ Show the generated design system content and present choices:
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-07-defining-experience.md`
|
||||
- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -247,6 +247,6 @@ When user selects 'C', append the content directly to the document using the str
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-07-defining-experience.md` to define the core user interaction.
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md` to define the core user interaction.
|
||||
|
||||
Remember: Do NOT proceed to step-07 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
||||
@@ -217,7 +217,7 @@ Show the generated defining experience content and present choices:
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-08-visual-foundation.md`
|
||||
- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -249,6 +249,6 @@ When user selects 'C', append the content directly to the document using the str
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-08-visual-foundation.md` to establish visual design foundation.
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md` to establish visual design foundation.
|
||||
|
||||
Remember: Do NOT proceed to step-08 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
||||
@@ -187,7 +187,7 @@ Show the generated visual foundation content and present choices:
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-09-design-directions.md`
|
||||
- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -219,6 +219,6 @@ When user selects 'C', append the content directly to the document using the str
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-09-design-directions.md` to generate design direction mockups.
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md` to generate design direction mockups.
|
||||
|
||||
Remember: Do NOT proceed to step-09 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
||||
@@ -187,7 +187,7 @@ Show the generated design direction content and present choices:
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-10-user-journeys.md`
|
||||
- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -219,6 +219,6 @@ When user selects 'C', append the content directly to the document using the str
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-10-user-journeys.md` to design user journey flows.
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md` to design user journey flows.
|
||||
|
||||
Remember: Do NOT proceed to step-10 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
||||
@@ -205,7 +205,7 @@ Show the generated user journey content and present choices:
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-11-component-strategy.md`
|
||||
- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -236,6 +236,6 @@ When user selects 'C', append the content directly to the document using the str
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-11-component-strategy.md` to define component library strategy.
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md` to define component library strategy.
|
||||
|
||||
Remember: Do NOT proceed to step-11 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
||||
@@ -211,7 +211,7 @@ Show the generated component strategy content and present choices:
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-12-ux-patterns.md`
|
||||
- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -243,6 +243,6 @@ When user selects 'C', append the content directly to the document using the str
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-12-ux-patterns.md` to define UX consistency patterns.
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md` to define UX consistency patterns.
|
||||
|
||||
Remember: Do NOT proceed to step-12 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
||||
@@ -200,7 +200,7 @@ Show the generated UX patterns content and present choices:
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-13-responsive-accessibility.md`
|
||||
- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -232,6 +232,6 @@ When user selects 'C', append the content directly to the document using the str
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-13-responsive-accessibility.md` to define responsive design and accessibility strategy.
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md` to define responsive design and accessibility strategy.
|
||||
|
||||
Remember: Do NOT proceed to step-13 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
||||
@@ -227,7 +227,7 @@ Show the generated responsive and accessibility content and present choices:
|
||||
|
||||
- Append the final content to `{planning_artifacts}/ux-design-specification.md`
|
||||
- Update frontmatter: append step to end of stepsCompleted array
|
||||
- Load `./step-14-complete.md`
|
||||
- Load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -259,6 +259,6 @@ When user selects 'C', append the content directly to the document using the str
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-14-complete.md` to finalize the UX design workflow.
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md` to finalize the UX design workflow.
|
||||
|
||||
Remember: Do NOT proceed to step-14 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
||||
@@ -82,7 +82,7 @@ Update the main workflow status file:
|
||||
|
||||
### 3. Suggest Next Steps
|
||||
|
||||
UX Design complete. Read fully and follow: `_bmad/core/tasks/help.md` with argument `Create UX`.
|
||||
UX Design complete. Read fully and follow: `{project-root}/_bmad/core/tasks/help.md`
|
||||
|
||||
### 5. Final Completion Confirmation
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
name: create-ux-design
|
||||
description: Work with a peer UX Design expert to plan your applications UX patterns, look and feel.
|
||||
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"'
|
||||
---
|
||||
|
||||
# Create UX Design Workflow
|
||||
@@ -39,4 +39,4 @@ Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||
## EXECUTION
|
||||
|
||||
- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
|
||||
- Read fully and follow: `steps/step-01-init.md` to begin the UX design workflow.
|
||||
- Read fully and follow: `{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md` to begin the UX design workflow.
|
||||
|
||||
@@ -109,7 +109,7 @@ The assessment found [number] issues requiring attention. Review the detailed re
|
||||
|
||||
The implementation readiness workflow is now complete. The report contains all findings and recommendations for the user to consider.
|
||||
|
||||
Implementation Readiness complete. Read fully and follow: `_bmad/core/tasks/help.md` with argument `implementation readiness`.
|
||||
Implementation Readiness complete. Read fully and follow: `{project-root}/_bmad/core/tasks/help.md`
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
name: check-implementation-readiness
|
||||
description: 'Critical validation workflow that assesses PRD, Architecture, and Epics & Stories for completeness and alignment before implementation. Uses adversarial review approach to find gaps and issues.'
|
||||
description: 'Validate PRD, UX, Architecture and Epics specs are complete. Use when the user says "check implementation readiness".'
|
||||
---
|
||||
|
||||
# Implementation Readiness
|
||||
@@ -51,4 +51,4 @@ Load and read full config from {project-root}/_bmad/bmm/config.yaml and resolve:
|
||||
|
||||
### 2. First Step EXECUTION
|
||||
|
||||
Read fully and follow: `./step-01-document-discovery.md` to begin the workflow.
|
||||
Read fully and follow: `./steps/step-01-document-discovery.md` to begin the workflow.
|
||||
|
||||
@@ -44,7 +44,7 @@ First, check if the output document already exists:
|
||||
|
||||
If the document exists and has frontmatter with `stepsCompleted`:
|
||||
|
||||
- **STOP here** and load `./step-01b-continue.md` immediately
|
||||
- **STOP here** and load `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md` immediately
|
||||
- Do not proceed with any initialization tasks
|
||||
- Let step-01b handle the continuation logic
|
||||
|
||||
@@ -148,6 +148,6 @@ Ready to begin architectural decision making. Do you have any other documents yo
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects [C] to continue, only after ensuring all the template output has been created, then load `./step-02-context.md` to analyze the project context and begin architectural decision making.
|
||||
After user selects [C] to continue, only after ensuring all the template output has been created, then load `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md` to analyze the project context and begin architectural decision making.
|
||||
|
||||
Remember: Do NOT proceed to step-02 until user explicitly selects [C] from the menu and setup is confirmed!
|
||||
|
||||
@@ -85,7 +85,7 @@ Show the user their current progress:
|
||||
|
||||
- Identify the next step based on `stepsCompleted`
|
||||
- Load the appropriate step file to continue
|
||||
- Example: If `stepsCompleted: [1, 2, 3]`, load `step-04-decisions.md`
|
||||
- Example: If `stepsCompleted: [1, 2, 3]`, load `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md`
|
||||
|
||||
#### If 'C' (Continue to next logical step):
|
||||
|
||||
@@ -103,7 +103,7 @@ Show the user their current progress:
|
||||
#### If 'X' (Start over):
|
||||
|
||||
- Confirm: "This will delete all existing architectural decisions. Are you sure? (y/n)"
|
||||
- If confirmed: Delete existing document and return to step-01-init.md
|
||||
- If confirmed: Delete existing document and read fully and follow: `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md`
|
||||
- If not confirmed: Return to continuation menu
|
||||
|
||||
### 4. Navigate to Selected Step
|
||||
@@ -161,4 +161,13 @@ After user makes choice:
|
||||
|
||||
After user selects their continuation option, load the appropriate step file based on their choice. The step file will handle the detailed work from that point forward.
|
||||
|
||||
Valid step files to load:
|
||||
- `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md`
|
||||
- `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md`
|
||||
- `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md`
|
||||
- `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md`
|
||||
- `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md`
|
||||
- `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md`
|
||||
- `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md`
|
||||
|
||||
Remember: The goal is smooth, transparent resumption that respects the work already done while giving the user control over how to proceed.
|
||||
|
||||
@@ -188,7 +188,7 @@ Show the generated content and present choices:
|
||||
|
||||
- Append the final content to `{planning_artifacts}/architecture.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2]`
|
||||
- Load `./step-03-starter.md`
|
||||
- Load `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -219,6 +219,6 @@ When user selects 'C', append the content directly to the document using the str
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-03-starter.md` to evaluate starter template options.
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md` to evaluate starter template options.
|
||||
|
||||
Remember: Do NOT proceed to step-03 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
||||
@@ -232,7 +232,6 @@ Prepare the content to append to the document:
|
||||
```bash
|
||||
{{full_starter_command_with_options}}
|
||||
```
|
||||
````
|
||||
|
||||
**Architectural Decisions Provided by Starter:**
|
||||
|
||||
@@ -256,7 +255,7 @@ Prepare the content to append to the document:
|
||||
|
||||
**Note:** Project initialization using this command should be the first implementation story.
|
||||
|
||||
```
|
||||
````
|
||||
|
||||
### 9. Present Content and Menu
|
||||
|
||||
@@ -295,7 +294,7 @@ Show the generated content and present choices:
|
||||
|
||||
- Append the final content to `{planning_artifacts}/architecture.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3]`
|
||||
- Load `./step-04-decisions.md`
|
||||
- Load `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -325,7 +324,6 @@ When user selects 'C', append the content directly to the document using the str
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-04-decisions.md` to begin making specific architectural decisions.
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md` to begin making specific architectural decisions.
|
||||
|
||||
Remember: Do NOT proceed to step-04 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
```
|
||||
|
||||
@@ -282,7 +282,7 @@ Show the generated decisions content and present choices:
|
||||
|
||||
- Append the final content to `{planning_artifacts}/architecture.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4]`
|
||||
- Load `./step-05-patterns.md`
|
||||
- Load `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -313,6 +313,6 @@ When user selects 'C', append the content directly to the document using the str
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-05-patterns.md` to define implementation patterns that ensure consistency across AI agents.
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md` to define implementation patterns that ensure consistency across AI agents.
|
||||
|
||||
Remember: Do NOT proceed to step-05 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
||||
@@ -323,7 +323,7 @@ Show the generated patterns content and present choices:
|
||||
|
||||
- Append the final content to `{planning_artifacts}/architecture.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5]`
|
||||
- Load `./step-06-structure.md`
|
||||
- Load `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -354,6 +354,6 @@ When user selects 'C', append the content directly to the document using the str
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-06-structure.md` to define the complete project structure.
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md` to define the complete project structure.
|
||||
|
||||
Remember: Do NOT proceed to step-06 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
||||
@@ -343,7 +343,7 @@ Show the generated project structure content and present choices:
|
||||
|
||||
- Append the final content to `{planning_artifacts}/architecture.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6]`
|
||||
- Load `./step-07-validation.md`
|
||||
- Load `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -374,6 +374,6 @@ When user selects 'C', append the content directly to the document using the str
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-07-validation.md` to validate architectural coherence and completeness.
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md` to validate architectural coherence and completeness.
|
||||
|
||||
Remember: Do NOT proceed to step-07 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
||||
@@ -323,7 +323,7 @@ Show the validation results and present choices:
|
||||
|
||||
- Append the final content to `{planning_artifacts}/architecture.md`
|
||||
- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5, 6, 7]`
|
||||
- Load `./step-08-complete.md`
|
||||
- Load `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md`
|
||||
|
||||
## APPEND TO DOCUMENT:
|
||||
|
||||
@@ -354,6 +354,6 @@ When user selects 'C', append the content directly to the document using the str
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects 'C' and content is saved to document, load `./step-08-complete.md` to complete the workflow and provide implementation guidance.
|
||||
After user selects 'C' and content is saved to document, load `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md` to complete the workflow and provide implementation guidance.
|
||||
|
||||
Remember: Do NOT proceed to step-08 until user explicitly selects 'C' from the A/P/C menu and content is saved!
|
||||
|
||||
@@ -41,7 +41,7 @@ completedAt: '{{current_date}}'
|
||||
|
||||
### 3. Next Steps Guidance
|
||||
|
||||
Architecture complete. Read fully and follow: `_bmad/core/tasks/help.md` with argument `Create Architecture`.
|
||||
Architecture complete. Read fully and follow: `{project-root}/_bmad/core/tasks/help.md`
|
||||
|
||||
Upon Completion of task output: offer to answer any questions about the Architecture Document.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
name: create-architecture
|
||||
description: Collaborative architectural decision facilitation for AI-agent consistency. Replaces template-driven architecture with intelligent, adaptive conversation that produces a decision-focused architecture document optimized for preventing agent conflicts.
|
||||
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"'
|
||||
---
|
||||
|
||||
# Architecture Workflow
|
||||
@@ -36,7 +36,7 @@ Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||
|
||||
### Paths
|
||||
|
||||
- `installed_path` = `{project-root}/_bmad/bmm/workflows/3-solutioning/architecture`
|
||||
- `installed_path` = `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture`
|
||||
- `template_path` = `{installed_path}/architecture-decision-template.md`
|
||||
- `data_files_path` = `{installed_path}/data/`
|
||||
|
||||
@@ -44,6 +44,6 @@ Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||
|
||||
## EXECUTION
|
||||
|
||||
Read fully and follow: `steps/step-01-init.md` to begin the workflow.
|
||||
Read fully and follow: `{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md` to begin the workflow.
|
||||
|
||||
**Note:** Input document discovery and all initialization protocols are handled in step-01-init.md.
|
||||
|
||||
@@ -144,6 +144,6 @@ If all validations pass:
|
||||
|
||||
When C is selected, the workflow is complete and the epics.md is ready for development.
|
||||
|
||||
Epics and Stories complete. Read fully and follow: `_bmad/core/tasks/help.md` with argument `Create Epics and Stories`.
|
||||
Epics and Stories complete. Read fully and follow: `{project-root}/_bmad/core/tasks/help.md`
|
||||
|
||||
Upon Completion of task output: offer to answer any questions about the Epics and Stories.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
name: create-epics-and-stories
|
||||
description: 'Transform PRD requirements and Architecture decisions into comprehensive stories organized by user value. This workflow requires completed PRD + Architecture documents (UX recommended if UI exists) and breaks down requirements into implementation-ready epics and user stories that incorporate all available technical and design context. Creates detailed, actionable stories with complete acceptance criteria for development teams.'
|
||||
description: 'Break requirements into epics and user stories. Use when the user says "create the epics and stories list"'
|
||||
---
|
||||
|
||||
# Create Epics and Stories
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
# Review Story Workflow
|
||||
name: code-review
|
||||
description: "Perform an ADVERSARIAL Senior Developer code review that finds 3-10 specific problems in every story. Challenges everything: code quality, test coverage, architecture compliance, security, performance. NEVER accepts `looks good` - must find minimum issues and can auto-fix with user approval."
|
||||
author: "BMad"
|
||||
description: 'Perform adversarial code review finding specific issues. Use when the user says "run code review" or "review this code"'
|
||||
|
||||
# Critical variables from config
|
||||
config_source: "{project-root}/_bmad/bmm/config.yaml"
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
# Correct Course - Sprint Change Management Workflow
|
||||
name: "correct-course"
|
||||
description: "Navigate significant changes during sprint execution by analyzing impact, proposing solutions, and routing for implementation"
|
||||
author: "BMad Method"
|
||||
description: 'Manage significant changes during sprint execution. Use when the user says "correct course" or "propose sprint change"'
|
||||
|
||||
config_source: "{project-root}/_bmad/bmm/config.yaml"
|
||||
user_name: "{config_source}:user_name"
|
||||
|
||||
@@ -33,7 +33,7 @@ This is a COMPETITION to create the **ULTIMATE story context** that makes LLM de
|
||||
|
||||
### **When Running from Create-Story Workflow:**
|
||||
|
||||
- The `{project-root}/_bmad/core/tasks/validate-workflow.xml` framework will automatically:
|
||||
- The `{project-root}/_bmad/core/tasks/workflow.xml` framework will automatically:
|
||||
- Load this checklist file
|
||||
- Load the newly created story file (`{story_file_path}`)
|
||||
- Load workflow variables from `{installed_path}/workflow.yaml`
|
||||
@@ -63,7 +63,7 @@ You will systematically re-do the entire story creation process, but with a crit
|
||||
|
||||
1. **Load the workflow configuration**: `{installed_path}/workflow.yaml` for variable inclusion
|
||||
2. **Load the story file**: `{story_file_path}` (provided by user or discovered)
|
||||
3. **Load validation framework**: `{project-root}/_bmad/core/tasks/validate-workflow.xml`
|
||||
3. **Load validation framework**: `{project-root}/_bmad/core/tasks/workflow.xml`
|
||||
4. **Extract metadata**: epic_num, story_num, story_key, story_title from story file
|
||||
5. **Resolve all workflow variables**: implementation_artifacts, epics_file, architecture_file, etc.
|
||||
6. **Understand current status**: What story implementation guidance is currently provided?
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
name: create-story
|
||||
description: "Create the next user story from epics+stories with enhanced context analysis and direct ready-for-dev marking"
|
||||
author: "BMad"
|
||||
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]"'
|
||||
|
||||
# Critical variables from config
|
||||
config_source: "{project-root}/_bmad/bmm/config.yaml"
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
name: dev-story
|
||||
description: "Execute a story by implementing tasks/subtasks, writing tests, validating, and updating the story file per acceptance criteria"
|
||||
author: "BMad"
|
||||
description: 'Execute story implementation following a context filled story spec file. Use when the user says "dev this story [story file]" or "implement the next story in the sprint plan"'
|
||||
|
||||
# Critical variables from config
|
||||
config_source: "{project-root}/_bmad/bmm/config.yaml"
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
# Retrospective - Epic Completion Review Workflow
|
||||
name: "retrospective"
|
||||
description: "Run after epic completion to review overall success, extract lessons learned, and explore if new information emerged that might impact the next epic"
|
||||
author: "BMad"
|
||||
description: 'Post-epic review to extract lessons and assess success. Use when the user says "run a retrospective" or "lets retro the epic [epic]"'
|
||||
|
||||
config_source: "{project-root}/_bmad/bmm/config.yaml"
|
||||
user_name: "{config_source}:user_name"
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
name: sprint-planning
|
||||
description: "Generate and manage the sprint status tracking file for Phase 4 implementation, extracting all epics and stories from epic files and tracking their status through the development lifecycle"
|
||||
description: 'Generate sprint status tracking from epics. Use when the user says "run sprint planning" or "generate sprint plan"'
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables from config
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Sprint Status - Implementation Tracker
|
||||
name: sprint-status
|
||||
description: "Summarize sprint-status.yaml, surface risks, and route to the right implementation workflow."
|
||||
description: 'Summarize sprint status and surface risks. Use when the user says "check sprint status" or "show sprint status"'
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables from config
|
||||
|
||||
@@ -50,7 +50,7 @@ Analyze the user's input to determine mode:
|
||||
- Load the spec, extract tasks/context/AC
|
||||
- Set `{execution_mode}` = "tech-spec"
|
||||
- Set `{tech_spec_path}` = provided path
|
||||
- **NEXT:** Read fully and follow: `step-03-execute.md`
|
||||
- **NEXT:** Read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md`
|
||||
|
||||
**Mode B: Direct Instructions**
|
||||
|
||||
@@ -91,7 +91,7 @@ Display: "**Select:** [P] Plan first (tech-spec) [E] Execute directly"
|
||||
#### Menu Handling Logic:
|
||||
|
||||
- IF P: Direct user to `{quick_spec_workflow}`. **EXIT Quick Dev.**
|
||||
- IF E: Ask for any additional guidance, then **NEXT:** Read fully and follow: `step-02-context-gathering.md`
|
||||
- IF E: Ask for any additional guidance, then **NEXT:** Read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md`
|
||||
|
||||
#### EXECUTION RULES:
|
||||
|
||||
@@ -114,7 +114,7 @@ Display:
|
||||
|
||||
- IF P: Direct to `{quick_spec_workflow}`. **EXIT Quick Dev.**
|
||||
- IF W: Direct user to run the PRD workflow instead. **EXIT Quick Dev.**
|
||||
- IF E: Ask for guidance, then **NEXT:** Read fully and follow: `step-02-context-gathering.md`
|
||||
- IF E: Ask for guidance, then **NEXT:** Read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md`
|
||||
|
||||
#### EXECUTION RULES:
|
||||
|
||||
@@ -137,7 +137,7 @@ Display:
|
||||
|
||||
- IF P: Direct to `{quick_spec_workflow}`. **EXIT Quick Dev.**
|
||||
- IF W: Direct user to run the PRD workflow instead. **EXIT Quick Dev.**
|
||||
- IF E: Ask for guidance, then **NEXT:** Read fully and follow: `step-02-context-gathering.md`
|
||||
- IF E: Ask for guidance, then **NEXT:** Read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md`
|
||||
|
||||
#### EXECUTION RULES:
|
||||
|
||||
@@ -150,8 +150,8 @@ Display:
|
||||
|
||||
**CRITICAL:** When this step completes, explicitly state which step to load:
|
||||
|
||||
- Mode A (tech-spec): "**NEXT:** read fully and follow: `step-03-execute.md`"
|
||||
- Mode B (direct, [E] selected): "**NEXT:** Read fully and follow: `step-02-context-gathering.md`"
|
||||
- Mode A (tech-spec): "**NEXT:** read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md`"
|
||||
- Mode B (direct, [E] selected): "**NEXT:** Read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md`"
|
||||
- Escalation ([P] or [W]): "**EXITING Quick Dev.** Follow the directed workflow."
|
||||
|
||||
---
|
||||
|
||||
@@ -97,7 +97,7 @@ Ready to execute? (y/n/adjust)
|
||||
|
||||
**CRITICAL:** When user confirms ready, explicitly state:
|
||||
|
||||
- **y:** "**NEXT:** Read fully and follow: `step-03-execute.md`"
|
||||
- **y:** "**NEXT:** Read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md`"
|
||||
- **n/adjust:** Continue gathering context, then re-present plan
|
||||
|
||||
---
|
||||
|
||||
@@ -89,7 +89,7 @@ For each task:
|
||||
|
||||
## NEXT STEP
|
||||
|
||||
When ALL tasks are complete (or halted on blocker), read fully and follow: `step-04-self-check.md`.
|
||||
When ALL tasks are complete (or halted on blocker), read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md`.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -89,7 +89,7 @@ Proceeding to adversarial code review...
|
||||
|
||||
## NEXT STEP
|
||||
|
||||
Proceed immediately to `step-05-adversarial-review.md`.
|
||||
Proceed immediately to `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md`.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -83,7 +83,7 @@ If TodoWrite or similar tool is available, turn each finding into a TODO, includ
|
||||
|
||||
## NEXT STEP
|
||||
|
||||
With findings in hand, read fully and follow: `step-06-resolve-findings.md` for user to choose resolution approach.
|
||||
With findings in hand, read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md` for user to choose resolution approach.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
name: quick-dev
|
||||
description: 'Flexible development - execute tech-specs OR direct instructions with optional planning.'
|
||||
description: 'Implement a Quick Tech Spec for small changes or features. Use when the user provides a quick tech spec and says "implement this quick spec" or "proceed with implementation of [quick tech spec]"'
|
||||
---
|
||||
|
||||
# Quick Dev Workflow
|
||||
@@ -47,4 +47,4 @@ Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||
|
||||
## EXECUTION
|
||||
|
||||
Read fully and follow: `steps/step-01-mode-detection.md` to begin the workflow.
|
||||
Read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md` to begin the workflow.
|
||||
|
||||
@@ -2,8 +2,6 @@
|
||||
name: 'step-01-understand'
|
||||
description: 'Analyze the requirement delta between current state and what user wants to build'
|
||||
|
||||
nextStepFile: './step-02-investigate.md'
|
||||
skipToStepFile: './step-03-generate.md'
|
||||
templateFile: '../tech-spec-template.md'
|
||||
wipFile: '{implementation_artifacts}/tech-spec-wip.md'
|
||||
---
|
||||
@@ -56,9 +54,9 @@ a) **Menu Handling:**
|
||||
|
||||
- **[Y] Continue existing:**
|
||||
- Jump directly to the appropriate step based on `stepsCompleted`:
|
||||
- `[1]` → Load `{nextStepFile}` (Step 2)
|
||||
- `[1, 2]` → Load `{skipToStepFile}` (Step 3)
|
||||
- `[1, 2, 3]` → Load `./step-04-review.md` (Step 4)
|
||||
- `[1]` → Read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md` (Step 2)
|
||||
- `[1, 2]` → Read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md` (Step 3)
|
||||
- `[1, 2, 3]` → Read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md` (Step 4)
|
||||
- **[N] Archive and start fresh:**
|
||||
- Rename `{wipFile}` to `{implementation_artifacts}/tech-spec-{slug}-archived-{date}.md`
|
||||
|
||||
@@ -169,7 +167,7 @@ b) **HALT and wait for user selection.**
|
||||
|
||||
- IF A: Read fully and follow: `{advanced_elicitation}` with current tech-spec content, process enhanced insights, ask user "Accept improvements? (y/n)", if yes update WIP file then redisplay menu, if no keep original then redisplay menu
|
||||
- IF P: Read fully and follow: `{party_mode_exec}` with current tech-spec content, process collaborative insights, ask user "Accept changes? (y/n)", if yes update WIP file then redisplay menu, if no keep original then redisplay menu
|
||||
- IF C: Verify `{wipFile}` has `stepsCompleted: [1]`, then read fully and follow: `{nextStepFile}`
|
||||
- IF C: Verify `{wipFile}` has `stepsCompleted: [1]`, then read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md`
|
||||
- IF Any other comments or queries: respond helpfully then redisplay menu
|
||||
|
||||
#### EXECUTION RULES:
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
name: 'step-02-investigate'
|
||||
description: 'Map technical constraints and anchor points within the codebase'
|
||||
|
||||
nextStepFile: './step-03-generate.md'
|
||||
wipFile: '{implementation_artifacts}/tech-spec-wip.md'
|
||||
---
|
||||
|
||||
@@ -122,7 +121,7 @@ Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Ge
|
||||
|
||||
- IF A: Read fully and follow: `{advanced_elicitation}` with current tech-spec content, process enhanced insights, ask user "Accept improvements? (y/n)", if yes update WIP file then redisplay menu, if no keep original then redisplay menu
|
||||
- IF P: Read fully and follow: `{party_mode_exec}` with current tech-spec content, process collaborative insights, ask user "Accept changes? (y/n)", if yes update WIP file then redisplay menu, if no keep original then redisplay menu
|
||||
- IF C: Verify frontmatter updated with `stepsCompleted: [1, 2]`, then read fully and follow: `{nextStepFile}`
|
||||
- IF C: Verify frontmatter updated with `stepsCompleted: [1, 2]`, then read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md`
|
||||
- IF Any other comments or queries: respond helpfully then redisplay menu
|
||||
|
||||
#### EXECUTION RULES:
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
name: 'step-03-generate'
|
||||
description: 'Build the implementation plan based on the technical mapping of constraints'
|
||||
|
||||
nextStepFile: './step-04-review.md'
|
||||
wipFile: '{implementation_artifacts}/tech-spec-wip.md'
|
||||
---
|
||||
|
||||
@@ -113,7 +112,7 @@ stepsCompleted: [1, 2, 3]
|
||||
---
|
||||
```
|
||||
|
||||
c) **Read fully and follow: `{nextStepFile}` (Step 4)**
|
||||
c) **Read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md` (Step 4)**
|
||||
|
||||
## REQUIRED OUTPUTS:
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
name: quick-spec
|
||||
description: Conversational spec engineering - ask questions, investigate code, produce implementation-ready tech-spec.
|
||||
description: 'Very quick process to create implementation-ready quick specs for small changes or features. Use when the user says "create a quick spec" or "generate a quick tech spec"'
|
||||
main_config: '{project-root}/_bmad/bmm/config.yaml'
|
||||
|
||||
# Checkpoint handler paths
|
||||
@@ -76,4 +76,4 @@ Load and read full config from `{main_config}` and resolve:
|
||||
|
||||
### 2. First Step Execution
|
||||
|
||||
Read fully and follow: `steps/step-01-understand.md` to begin the workflow.
|
||||
Read fully and follow: `{project-root}/_bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md` to begin the workflow.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Document Project Workflow Configuration
|
||||
name: "document-project"
|
||||
version: "1.2.0"
|
||||
description: "Analyzes and documents brownfield projects by scanning codebase, architecture, and patterns to create comprehensive reference documentation for AI-assisted development"
|
||||
description: 'Document brownfield projects for AI context. Use when the user says "document this project" or "generate project docs"'
|
||||
author: "BMad"
|
||||
|
||||
# Critical variables
|
||||
|
||||
@@ -179,6 +179,6 @@ Ready to create/update your project context. This will help AI agents implement
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After user selects [C] to continue, load `./step-02-generate.md` to collaboratively generate the specific project context rules.
|
||||
After user selects [C] to continue, load `{project-root}/_bmad/bmm/workflows/generate-project-context/steps/step-02-generate.md` to collaboratively generate the specific project context rules.
|
||||
|
||||
Remember: Do NOT proceed to step-02 until user explicitly selects [C] from the menu and discovery is confirmed and the initial file has been written as directed in this discovery step!
|
||||
|
||||
@@ -313,6 +313,6 @@ When user selects 'C' for a category, append the content directly to `{output_fo
|
||||
|
||||
## NEXT STEP:
|
||||
|
||||
After completing all rule categories and user selects 'C' for the final category, load `./step-03-complete.md` to finalize the project context file.
|
||||
After completing all rule categories and user selects 'C' for the final category, load `{project-root}/_bmad/bmm/workflows/generate-project-context/steps/step-03-complete.md` to finalize the project context file.
|
||||
|
||||
Remember: Do NOT proceed to step-03 until all categories are complete and user explicitly selects 'C' for each!
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
name: generate-project-context
|
||||
description: Creates a concise project-context.md file with critical rules and patterns that AI agents must follow when implementing code. Optimized for LLM context efficiency.
|
||||
description: 'Create project-context.md with AI rules. Use when the user says "generate project context" or "create project context"'
|
||||
---
|
||||
|
||||
# Generate Project Context Workflow
|
||||
@@ -44,6 +44,6 @@ Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
||||
|
||||
## EXECUTION
|
||||
|
||||
Load and execute `steps/step-01-discover.md` to begin the workflow.
|
||||
Load and execute `{project-root}/_bmad/bmm/workflows/generate-project-context/steps/step-01-discover.md` to begin the workflow.
|
||||
|
||||
**Note:** Input document discovery and initialization protocols are handled in step-01-discover.md.
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user