chore: update documentation to reflect recent architectural changes and improve clarity

This commit is contained in:
Sepehr
2026-03-10 22:59:04 +01:00
parent d88914a44f
commit 891c4ba436
530 changed files with 2544 additions and 1513 deletions

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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`
---

View File

@@ -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

View File

@@ -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!

View File

@@ -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!

View File

@@ -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!

View File

@@ -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!

View File

@@ -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:

View File

@@ -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:

View File

@@ -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!

View File

@@ -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!

View File

@@ -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!

View File

@@ -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!

View File

@@ -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:

View File

@@ -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!

View File

@@ -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!

View File

@@ -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!

View File

@@ -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!

View File

@@ -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.

View File

@@ -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:

View File

@@ -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

View File

@@ -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

View File

@@ -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