docs: massive documentation overhaul + introduce Paige (Documentation Guide agent)

## 📚 Complete Documentation Restructure

**BMM Documentation Hub Created:**
- New centralized documentation system at `src/modules/bmm/docs/`
- 18 comprehensive guides organized by topic (7000+ lines total)
- Clear learning paths for greenfield, brownfield, and quick spec flows
- Professional technical writing standards throughout

**New Documentation:**
- `README.md` - Complete documentation hub with navigation
- `quick-start.md` - 15-minute getting started guide
- `agents-guide.md` - Comprehensive 12-agent reference (45 min read)
- `party-mode.md` - Multi-agent collaboration guide (20 min read)
- `scale-adaptive-system.md` - Deep dive on Levels 0-4 (42 min read)
- `brownfield-guide.md` - Existing codebase development (53 min read)
- `quick-spec-flow.md` - Rapid Level 0-1 development (26 min read)
- `workflows-analysis.md` - Phase 1 workflows (12 min read)
- `workflows-planning.md` - Phase 2 workflows (19 min read)
- `workflows-solutioning.md` - Phase 3 workflows (13 min read)
- `workflows-implementation.md` - Phase 4 workflows (33 min read)
- `workflows-testing.md` - Testing & QA workflows (29 min read)
- `workflow-architecture-reference.md` - Architecture workflow deep-dive
- `workflow-document-project-reference.md` - Document-project workflow reference
- `enterprise-agentic-development.md` - Team collaboration patterns
- `faq.md` - Comprehensive Q&A covering all topics
- `glossary.md` - Complete terminology reference
- `troubleshooting.md` - Common issues and solutions

**Documentation Improvements:**
- Removed all version/date footers (git handles versioning)
- Agent customization docs now include full rebuild process
- Cross-referenced links between all guides
- Reading time estimates for all major docs
- Consistent professional formatting and structure

**Consolidated & Streamlined:**
- Module README (`src/modules/bmm/README.md`) streamlined to lean signpost
- Root README polished with better hierarchy and clear CTAs
- Moved docs from root `docs/` to module-specific locations
- Better separation of user docs vs. developer reference

## 🤖 New Agent: Paige (Documentation Guide)

**Role:** Technical documentation specialist and information architect

**Expertise:**
- Professional technical writing standards
- Documentation structure and organization
- Information architecture and navigation
- User-focused content design
- Style guide enforcement

**Status:** Work in progress - Paige will evolve as documentation needs grow

**Integration:**
- Listed in agents-guide.md, glossary.md, FAQ
- Available for all phases (documentation is continuous)
- Can be customized like all BMM agents

## 🔧 Additional Changes

- Updated agent manifest with Paige
- Updated workflow manifest with new documentation workflows
- Fixed workflow-to-agent mappings across all guides
- Improved root README with clearer Quick Start section
- Better module structure explanations
- Enhanced community links with Discord channel names

**Total Impact:**
- 18 new/restructured documentation files
- 7000+ lines of professional technical documentation
- Complete navigation system with cross-references
- Clear learning paths for all user types
- Foundation for knowledge base (coming in beta)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Brian Madison
2025-11-02 21:18:33 -06:00
parent 8a00f8ad70
commit cfedecbd53
359 changed files with 72374 additions and 809 deletions

View File

@@ -0,0 +1,180 @@
# Product Brief Workflow
## Overview
Interactive product brief creation workflow that guides users through defining their product vision with multiple input sources and conversational collaboration. Supports both structured interactive mode and rapid "YOLO" mode for quick draft generation.
## Key Features
- **Dual Mode Operation** - Interactive step-by-step or rapid draft generation
- **Multi-Input Support** - Integrates market research, competitive analysis, and brainstorming results
- **Conversational Design** - Guides users through strategic thinking with probing questions
- **Executive Summary Generation** - Creates compelling summaries for stakeholder communication
- **Comprehensive Coverage** - Addresses all critical product planning dimensions
- **Stakeholder Ready** - Generates professional briefs suitable for PM handoff
## Usage
### Basic Invocation
```bash
workflow product-brief
```
### With Input Documents
```bash
# With market research
workflow product-brief --input market-research.md
# With multiple inputs
workflow product-brief --input market-research.md --input competitive-analysis.md
```
### Configuration
- **brief_format**: "comprehensive" (full detail) or "executive" (3-page limit)
- **autonomous**: false (requires user collaboration)
- **output_folder**: Location for generated brief
## Workflow Structure
### Files Included
```
product-brief/
├── workflow.yaml # Configuration and metadata
├── instructions.md # Interactive workflow steps
├── template.md # Product brief document structure
├── checklist.md # Validation criteria
└── README.md # This file
```
## Workflow Process
### Phase 1: Initialization and Context (Steps 0-2)
- **Project Setup**: Captures project name and basic context
- **Input Gathering**: Collects and analyzes available documents
- **Mode Selection**: Chooses interactive or YOLO collaboration approach
- **Context Extraction**: Identifies core problems and opportunities
### Phase 2: Interactive Development (Steps 3-12) - Interactive Mode
- **Problem Definition**: Deep dive into user pain points and market gaps
- **Solution Articulation**: Develops clear value proposition and approach
- **User Segmentation**: Defines primary and secondary target audiences
- **Success Metrics**: Establishes measurable goals and KPIs
- **MVP Scoping**: Ruthlessly defines minimum viable features
- **Financial Planning**: Assesses ROI and strategic alignment
- **Technical Context**: Captures platform and technology considerations
- **Risk Assessment**: Identifies constraints, assumptions, and unknowns
### Phase 3: Rapid Generation (Steps 3-4) - YOLO Mode
- **Complete Draft**: Generates full brief based on initial context
- **Iterative Refinement**: User-guided section improvements
- **Quality Validation**: Ensures completeness and consistency
### Phase 4: Finalization (Steps 13-15)
- **Executive Summary**: Creates compelling overview for stakeholders
- **Supporting Materials**: Compiles research summaries and references
- **Final Review**: Quality check and handoff preparation
## Output
### Generated Files
- **Primary output**: product-brief-{project_name}-{date}.md
- **Supporting files**: Research summaries and stakeholder input documentation
### Output Structure
1. **Executive Summary** - High-level product concept and value proposition
2. **Problem Statement** - Detailed problem analysis with evidence
3. **Proposed Solution** - Core approach and key differentiators
4. **Target Users** - Primary and secondary user segments with personas
5. **Goals and Success Metrics** - Business objectives and measurable KPIs
6. **MVP Scope** - Must-have features and out-of-scope items
7. **Post-MVP Vision** - Phase 2 features and long-term roadmap
8. **Financial Impact** - Investment requirements and ROI projections
9. **Strategic Alignment** - Connection to company OKRs and initiatives
10. **Technical Considerations** - Platform requirements and preferences
11. **Constraints and Assumptions** - Resource limits and key assumptions
12. **Risks and Open Questions** - Risk assessment and research needs
13. **Supporting Materials** - Research summaries and references
## Requirements
No special requirements - designed to work with or without existing documentation.
## Best Practices
### Before Starting
1. **Gather Available Research**: Collect any market research, competitive analysis, or user feedback
2. **Define Stakeholder Audience**: Know who will use this brief for decision-making
3. **Set Time Boundaries**: Interactive mode requires 60-90 minutes for quality results
### During Execution
1. **Be Specific**: Avoid generic statements - provide concrete examples and data
2. **Think Strategically**: Focus on "why" and "what" rather than "how"
3. **Challenge Assumptions**: Use the conversation to test and refine your thinking
4. **Scope Ruthlessly**: Resist feature creep in MVP definition
### After Completion
1. **Validate with Checklist**: Use included criteria to ensure completeness
2. **Stakeholder Review**: Share executive summary first, then full brief
3. **Iterate Based on Feedback**: Product briefs should evolve with new insights
## Troubleshooting
### Common Issues
**Issue**: Brief lacks specificity or contains vague statements
- **Solution**: Restart problem definition with concrete examples and measurable impacts
- **Check**: Ensure each section answers "so what?" and provides actionable insights
**Issue**: MVP scope is too large or undefined
- **Solution**: Use the "what's the minimum to validate core hypothesis?" filter
- **Check**: Verify that each MVP feature is truly essential for initial value delivery
**Issue**: Missing strategic context or business justification
- **Solution**: Return to financial impact and strategic alignment sections
- **Check**: Ensure connection to company goals and clear ROI potential
## Customization
To customize this workflow:
1. **Modify Questions**: Update instructions.md to add industry-specific or company-specific prompts
2. **Adjust Template**: Customize template.md sections for organizational brief standards
3. **Add Validation**: Extend checklist.md with company-specific quality criteria
4. **Configure Modes**: Adjust brief_format settings for different output styles
## Version History
- **v6.0.0** - Interactive conversational design with dual modes
- Interactive and YOLO mode support
- Multi-input document integration
- Executive summary generation
- Strategic alignment focus
## Support
For issues or questions:
- Review the workflow creation guide at `/bmad/bmb/workflows/create-workflow/workflow-creation-guide.md`
- Validate output using `checklist.md`
- Consider running market research workflow first if lacking business context
- Consult BMAD documentation for product planning methodology
---
_Part of the BMad Method v6 - BMM (Method) Module_

View File

@@ -0,0 +1,115 @@
# Product Brief Validation Checklist
## Document Structure
- [ ] All required sections are present (Executive Summary through Appendices)
- [ ] No placeholder text remains (e.g., [TODO], [NEEDS CONFIRMATION], {{variable}})
- [ ] Document follows the standard brief template format
- [ ] Sections are properly numbered and formatted with headers
- [ ] Cross-references between sections are accurate
## Executive Summary Quality
- [ ] Product concept is explained in 1-2 clear sentences
- [ ] Primary problem is clearly identified
- [ ] Target market is specifically named (not generic)
- [ ] Value proposition is compelling and differentiated
- [ ] Summary accurately reflects the full document content
## Problem Statement
- [ ] Current state pain points are specific and measurable
- [ ] Impact is quantified where possible (time, money, opportunities)
- [ ] Explanation of why existing solutions fall short is provided
- [ ] Urgency for solving the problem now is justified
- [ ] Problem is validated with evidence or data points
## Solution Definition
- [ ] Core approach is clearly explained without implementation details
- [ ] Key differentiators from existing solutions are identified
- [ ] Explanation of why this will succeed is compelling
- [ ] Solution aligns directly with stated problems
- [ ] Vision paints a clear picture of the user experience
## Target Users
- [ ] Primary user segment has specific demographic/firmographic profile
- [ ] User behaviors and current workflows are documented
- [ ] Specific pain points are tied to user segments
- [ ] User goals are clearly articulated
- [ ] Secondary segment (if applicable) is equally detailed
- [ ] Avoids generic personas like "busy professionals"
## Goals and Metrics
- [ ] Business objectives include measurable outcomes with targets
- [ ] User success metrics focus on behaviors, not features
- [ ] 3-5 KPIs are defined with clear definitions
- [ ] All goals follow SMART criteria (Specific, Measurable, Achievable, Relevant, Time-bound)
- [ ] Success metrics align with problem statement
## MVP Scope
- [ ] Core features list contains only true must-haves
- [ ] Each core feature includes rationale for why it's essential
- [ ] Out of scope section explicitly lists deferred features
- [ ] MVP success criteria are specific and measurable
- [ ] Scope is genuinely minimal and viable
- [ ] No feature creep evident in "must-have" list
## Technical Considerations
- [ ] Target platforms are specified (web/mobile/desktop)
- [ ] Browser/OS support requirements are documented
- [ ] Performance requirements are defined if applicable
- [ ] Accessibility requirements are noted
- [ ] Technology preferences are marked as preferences, not decisions
- [ ] Integration requirements with existing systems are identified
## Constraints and Assumptions
- [ ] Budget constraints are documented if known
- [ ] Timeline or deadline pressures are specified
- [ ] Team/resource limitations are acknowledged
- [ ] Technical constraints are clearly stated
- [ ] Key assumptions are listed and testable
- [ ] Assumptions will be validated during development
## Risk Assessment (if included)
- [ ] Key risks include potential impact descriptions
- [ ] Open questions are specific and answerable
- [ ] Research areas are identified with clear objectives
- [ ] Risk mitigation strategies are suggested where applicable
## Overall Quality
- [ ] Language is clear and free of jargon
- [ ] Terminology is used consistently throughout
- [ ] Document is ready for handoff to Product Manager
- [ ] All [PM-TODO] items are clearly marked if present
- [ ] References and source documents are properly cited
## Completeness Check
- [ ] Document provides sufficient detail for PRD creation
- [ ] All user inputs have been incorporated
- [ ] Market research findings are reflected if provided
- [ ] Competitive analysis insights are included if available
- [ ] Brief aligns with overall product strategy
## Final Validation
### Critical Issues Found:
- [ ] None identified
### Minor Issues to Address:
- [ ] List any minor issues here
### Ready for PM Handoff:
- [ ] Yes, brief is complete and validated
- [ ] No, requires additional work (specify above)

View File

@@ -0,0 +1,524 @@
# Product Brief - Context-Adaptive Discovery Instructions
<critical>The workflow execution engine is governed by: {project-root}/bmad/core/tasks/workflow.xml</critical>
<critical>You MUST have already loaded and processed: {installed_path}/workflow.yaml</critical>
<critical>This workflow uses INTENT-DRIVEN FACILITATION - adapt organically to what emerges</critical>
<critical>The goal is DISCOVERING WHAT MATTERS through natural conversation, not filling a template</critical>
<critical>Communicate all responses in {communication_language} and adapt deeply to {user_skill_level}</critical>
<critical>Generate all documents in {document_output_language}</critical>
<critical>LIVING DOCUMENT: Write to the document continuously as you discover - never wait until the end</critical>
## Input Document Discovery
This workflow may reference: market research, brainstorming documents, user specified other inputs, or brownfield project documentation.
**Discovery Process** (execute for each referenced document):
1. **Search for whole document first** - Use fuzzy file matching to find the complete document
2. **Check for sharded version** - If whole document not found, look for `{doc-name}/index.md`
3. **If sharded version found**:
- Read `index.md` to understand the document structure
- Read ALL section files listed in the index
- Treat the combined content as if it were a single document
4. **Brownfield projects**: The `document-project` workflow always creates `{output_folder}/docs/index.md`
**Priority**: If both whole and sharded versions exist, use the whole document.
**Fuzzy matching**: Be flexible with document names - users may use variations in naming conventions.
<workflow>
<step n="0" goal="Validate workflow readiness" tag="workflow-status">
<action>Check if {output_folder}/bmm-workflow-status.yaml exists</action>
<action if="status file not found">Set standalone_mode = true</action>
<check if="status file found">
<action>Load the FULL file: {output_folder}/bmm-workflow-status.yaml</action>
<action>Parse workflow_status section</action>
<action>Check status of "product-brief" workflow</action>
<action>Get project_level from YAML metadata</action>
<action>Find first non-completed workflow (next expected workflow)</action>
<check if="project_level < 2">
<output>**Note: Level {{project_level}} Project**
Product Brief is most valuable for Level 2+ projects, but can help clarify vision for any project.</output>
</check>
<check if="product-brief status is file path (already completed)">
<output>⚠️ Product Brief already completed: {{product-brief status}}</output>
<ask>Re-running will overwrite the existing brief. Continue? (y/n)</ask>
<check if="n">
<output>Exiting. Use workflow-status to see your next step.</output>
<action>Exit workflow</action>
</check>
</check>
<check if="product-brief is not the next expected workflow">
<output>⚠️ Next expected workflow: {{next_workflow}}. Product Brief is out of sequence.</output>
<ask>Continue with Product Brief anyway? (y/n)</ask>
<check if="n">
<output>Exiting. Run {{next_workflow}} instead.</output>
<action>Exit workflow</action>
</check>
</check>
<action>Set standalone_mode = false</action>
</check>
</step>
<step n="1" goal="Begin the journey and understand context">
<action>Welcome {user_name} warmly in {communication_language}
Adapt your tone to {user_skill_level}:
- Expert: "Let's define your product vision. What are you building?"
- Intermediate: "I'm here to help shape your product vision. Tell me about your idea."
- Beginner: "Hi! I'm going to help you figure out exactly what you want to build. Let's start with your idea - what got you excited about this?"
Start with open exploration:
- What sparked this idea?
- What are you hoping to build?
- Who is this for - yourself, a business, users you know?
CRITICAL: Listen for context clues that reveal their situation:
- Personal/hobby project (fun, learning, small audience)
- Startup/solopreneur (market opportunity, competition matters)
- Enterprise/corporate (stakeholders, compliance, strategic alignment)
- Technical enthusiasm (implementation focused)
- Business opportunity (market/revenue focused)
- Problem frustration (solution focused)
Based on their initial response, sense:
- How formal/casual they want to be
- Whether they think in business or technical terms
- If they have existing materials to share
- Their confidence level with the domain</action>
<ask>What's the project name, and what got you excited about building this?</ask>
<action>From even this first exchange, create initial document sections</action>
<template-output>project_name</template-output>
<template-output>executive_summary</template-output>
<action>If they mentioned existing documents (research, brainstorming, etc.):
- Load and analyze these materials
- Extract key themes and insights
- Reference these naturally in conversation: "I see from your research that..."
- Use these to accelerate discovery, not repeat questions</action>
<template-output>initial_vision</template-output>
</step>
<step n="2" goal="Discover the problem worth solving">
<action>Guide problem discovery through natural conversation
DON'T ask: "What problem does this solve?"
DO explore conversationally based on their context:
For hobby projects:
- "What's annoying you that this would fix?"
- "What would this make easier or more fun?"
- "Show me what the experience is like today without this"
For business ventures:
- "Walk me through the frustration your users face today"
- "What's the cost of this problem - time, money, opportunities?"
- "Who's suffering most from this? Tell me about them"
- "What solutions have people tried? Why aren't they working?"
For enterprise:
- "What's driving the need for this internally?"
- "Which teams/processes are most affected?"
- "What's the business impact of not solving this?"
- "Are there compliance or strategic drivers?"
Listen for depth cues:
- Brief answers → dig deeper with follow-ups
- Detailed passion → let them flow, capture everything
- Uncertainty → help them explore with examples
- Multiple problems → help prioritize the core issue
Adapt your response:
- If they struggle: offer analogies, examples, frameworks
- If they're clear: validate and push for specifics
- If they're technical: explore implementation challenges
- If they're business-focused: quantify impact</action>
<action>Immediately capture what emerges - even if preliminary</action>
<template-output>problem_statement</template-output>
<check if="user mentioned metrics, costs, or business impact">
<action>Explore the measurable impact of the problem</action>
<template-output>problem_impact</template-output>
</check>
<check if="user mentioned current solutions or competitors">
<action>Understand why existing solutions fall short</action>
<template-output>existing_solutions_gaps</template-output>
</check>
<action>Reflect understanding: "So the core issue is {{problem_summary}}, and {{impact_if_mentioned}}. Let me capture that..."</action>
</step>
<step n="3" goal="Shape the solution vision">
<action>Transition naturally from problem to solution
Based on their energy and context, explore:
For builders/makers:
- "How do you envision this working?"
- "Walk me through the experience you want to create"
- "What's the 'magic moment' when someone uses this?"
For business minds:
- "What's your unique approach to solving this?"
- "How is this different from what exists today?"
- "What makes this the RIGHT solution now?"
For enterprise:
- "What would success look like for the organization?"
- "How does this fit with existing systems/processes?"
- "What's the transformation you're enabling?"
Go deeper based on responses:
- If innovative → explore the unique angle
- If standard → focus on execution excellence
- If technical → discuss key capabilities
- If user-focused → paint the journey
Web research when relevant:
- If they mention competitors → research current solutions
- If they claim innovation → verify uniqueness
- If they reference trends → get current data</action>
<action if="competitor or market mentioned">
<WebSearch>{{competitor/market}} latest features 2024</WebSearch>
<action>Use findings to sharpen differentiation discussion</action>
</action>
<template-output>proposed_solution</template-output>
<check if="unique differentiation discussed">
<template-output>key_differentiators</template-output>
</check>
<action>Continue building the living document</action>
</step>
<step n="4" goal="Understand the people who need this">
<action>Discover target users through storytelling, not demographics
Facilitate based on project type:
Personal/hobby:
- "Who else would love this besides you?"
- "Tell me about someone who would use this"
- Keep it light and informal
Startup/business:
- "Describe your ideal first customer - not demographics, but their situation"
- "What are they doing today without your solution?"
- "What would make them say 'finally, someone gets it!'?"
- "Are there different types of users with different needs?"
Enterprise:
- "Which roles/departments will use this?"
- "Walk me through their current workflow"
- "Who are the champions vs skeptics?"
- "What about indirect stakeholders?"
Push beyond generic personas:
- Not: "busy professionals" → "Sales reps who waste 2 hours/day on data entry"
- Not: "tech-savvy users" → "Developers who know Docker but hate configuring it"
- Not: "small businesses" → "Shopify stores doing $10-50k/month wanting to scale"
For each user type that emerges:
- Current behavior/workflow
- Specific frustrations
- What they'd value most
- Their technical comfort level</action>
<template-output>primary_user_segment</template-output>
<check if="multiple user types mentioned">
<action>Explore secondary users only if truly different needs</action>
<template-output>secondary_user_segment</template-output>
</check>
<check if="user journey or workflow discussed">
<template-output>user_journey</template-output>
</check>
</step>
<step n="5" goal="Define what success looks like" repeat="adapt-to-context">
<action>Explore success measures that match their context
For personal projects:
- "How will you know this is working well?"
- "What would make you proud of this?"
- Keep metrics simple and meaningful
For startups:
- "What metrics would convince you this is taking off?"
- "What user behaviors show they love it?"
- "What business metrics matter most - users, revenue, retention?"
- Push for specific targets: "100 users" not "lots of users"
For enterprise:
- "How will the organization measure success?"
- "What KPIs will stakeholders care about?"
- "What are the must-hit metrics vs nice-to-haves?"
Only dive deep into metrics if they show interest
Skip entirely for pure hobby projects
Focus on what THEY care about measuring</action>
<check if="metrics or goals discussed">
<template-output>success_metrics</template-output>
<check if="business objectives mentioned">
<template-output>business_objectives</template-output>
</check>
<check if="KPIs matter to them">
<template-output>key_performance_indicators</template-output>
</check>
</check>
<action>Keep the document growing with each discovery</action>
</step>
<step n="6" goal="Discover the MVP scope">
<critical>Focus on FEATURES not epics - that comes in Phase 2</critical>
<action>Guide MVP scoping based on their maturity
For experimental/hobby:
- "What's the ONE thing this must do to be useful?"
- "What would make a fun first version?"
- Embrace simplicity
For business ventures:
- "What's the smallest version that proves your hypothesis?"
- "What features would make early adopters say 'good enough'?"
- "What's tempting to add but would slow you down?"
- Be ruthless about scope creep
For enterprise:
- "What's the pilot scope that demonstrates value?"
- "Which capabilities are must-have for initial rollout?"
- "What can we defer to Phase 2?"
Use this framing:
- Core features: "Without this, the product doesn't work"
- Nice-to-have: "This would be great, but we can launch without it"
- Future vision: "This is where we're headed eventually"
Challenge feature creep:
- "Do we need that for launch, or could it come later?"
- "What if we started without that - what breaks?"
- "Is this core to proving the concept?"</action>
<template-output>core_features</template-output>
<check if="scope creep discussed">
<template-output>out_of_scope</template-output>
</check>
<check if="future features mentioned">
<template-output>future_vision_features</template-output>
</check>
<check if="success criteria for MVP mentioned">
<template-output>mvp_success_criteria</template-output>
</check>
</step>
<step n="7" goal="Explore relevant context dimensions" repeat="until-natural-end">
<critical>Only explore what emerges naturally - skip what doesn't matter</critical>
<action>Based on the conversation so far, selectively explore:
IF financial aspects emerged:
- Development investment needed
- Revenue potential or cost savings
- ROI timeline
- Budget constraints
<check if="discussed">
<template-output>financial_considerations</template-output>
</check>
IF market competition mentioned:
- Competitive landscape
- Market opportunity size
- Differentiation strategy
- Market timing
<check if="discussed">
<WebSearch>{{market}} size trends 2024</WebSearch>
<template-output>market_analysis</template-output>
</check>
IF technical preferences surfaced:
- Platform choices (web/mobile/desktop)
- Technology stack preferences
- Integration needs
- Performance requirements
<check if="discussed">
<template-output>technical_preferences</template-output>
</check>
IF organizational context emerged:
- Strategic alignment
- Stakeholder buy-in needs
- Change management considerations
- Compliance requirements
<check if="discussed">
<template-output>organizational_context</template-output>
</check>
IF risks or concerns raised:
- Key risks and mitigation
- Critical assumptions
- Open questions needing research
<check if="discussed">
<template-output>risks_and_assumptions</template-output>
</check>
IF timeline pressures mentioned:
- Launch timeline
- Critical milestones
- Dependencies
<check if="discussed">
<template-output>timeline_constraints</template-output>
</check>
Skip anything that hasn't naturally emerged
Don't force sections that don't fit their context</action>
</step>
<step n="8" goal="Refine and complete the living document">
<action>Review what's been captured with the user
"Let me show you what we've built together..."
Present the actual document sections created so far
- Not a summary, but the real content
- Shows the document has been growing throughout
Ask:
"Looking at this, what stands out as most important to you?"
"Is there anything critical we haven't explored?"
"Does this capture your vision?"
Based on their response:
- Refine sections that need more depth
- Add any missing critical elements
- Remove or simplify sections that don't matter
- Ensure the document fits THEIR needs, not a template</action>
<action>Make final refinements based on feedback</action>
<template-output>final_refinements</template-output>
<action>Create executive summary that captures the essence</action>
<template-output>executive_summary</template-output>
</step>
<step n="9" goal="Complete and save the product brief">
<action>The document has been building throughout our conversation
Now ensure it's complete and well-organized</action>
<check if="research documents were provided">
<action>Append summary of incorporated research</action>
<template-output>supporting_materials</template-output>
</check>
<action>Ensure the document structure makes sense for what was discovered:
- Hobbyist projects might be 2-3 pages focused on problem/solution/features
- Startup ventures might be 5-7 pages with market analysis and metrics
- Enterprise briefs might be 10+ pages with full strategic context
The document should reflect their world, not force their world into a template</action>
<ask>Your product brief is ready! Would you like to:
1. Review specific sections together
2. Make any final adjustments
3. Save and move forward
What feels right?</ask>
<action>Make any requested refinements</action>
<template-output>final_document</template-output>
</step>
<check if="standalone_mode != true">
<action>Load the FULL file: {output_folder}/bmm-workflow-status.yaml</action>
<action>Find workflow_status key "product-brief"</action>
<critical>ONLY write the file path as the status value - no other text, notes, or metadata</critical>
<action>Update workflow_status["product-brief"] = "{output_folder}/bmm-product-brief-{{project_name}}-{{date}}.md"</action>
<action>Save file, preserving ALL comments and structure including STATUS DEFINITIONS</action>
<action>Find first non-completed workflow in workflow_status (next workflow to do)</action>
<action>Determine next agent from path file based on next workflow</action>
</check>
<output>**✅ Product Brief Complete, {user_name}!**
Your product vision has been captured in a document that reflects what matters most for your {{context_type}} project.
**Document saved:** {output_folder}/bmm-product-brief-{{project_name}}-{{date}}.md
{{#if standalone_mode != true}}
**What's next:** {{next_workflow}} ({{next_agent}} agent)
The next phase will take your brief and create the detailed planning artifacts needed for implementation.
{{else}}
**Next steps:**
- Run `workflow-init` to set up guided workflow tracking
- Or proceed directly to the PRD workflow if you know your path
{{/if}}
Remember: This brief captures YOUR vision. It grew from our conversation, not from a rigid template. It's ready to guide the next phase of bringing your idea to life.
</output>
</step>
</workflow>

View File

@@ -0,0 +1,181 @@
# Product Brief: {{project_name}}
**Date:** {{date}}
**Author:** {{user_name}}
**Context:** {{context_type}}
---
## Executive Summary
{{executive_summary}}
---
## Core Vision
### Problem Statement
{{problem_statement}}
{{#if problem_impact}}
### Problem Impact
{{problem_impact}}
{{/if}}
{{#if existing_solutions_gaps}}
### Why Existing Solutions Fall Short
{{existing_solutions_gaps}}
{{/if}}
### Proposed Solution
{{proposed_solution}}
{{#if key_differentiators}}
### Key Differentiators
{{key_differentiators}}
{{/if}}
---
## Target Users
### Primary Users
{{primary_user_segment}}
{{#if secondary_user_segment}}
### Secondary Users
{{secondary_user_segment}}
{{/if}}
{{#if user_journey}}
### User Journey
{{user_journey}}
{{/if}}
---
{{#if success_metrics}}
## Success Metrics
{{success_metrics}}
{{#if business_objectives}}
### Business Objectives
{{business_objectives}}
{{/if}}
{{#if key_performance_indicators}}
### Key Performance Indicators
{{key_performance_indicators}}
{{/if}}
{{/if}}
---
## MVP Scope
### Core Features
{{core_features}}
{{#if out_of_scope}}
### Out of Scope for MVP
{{out_of_scope}}
{{/if}}
{{#if mvp_success_criteria}}
### MVP Success Criteria
{{mvp_success_criteria}}
{{/if}}
{{#if future_vision_features}}
### Future Vision
{{future_vision_features}}
{{/if}}
---
{{#if market_analysis}}
## Market Context
{{market_analysis}}
{{/if}}
{{#if financial_considerations}}
## Financial Considerations
{{financial_considerations}}
{{/if}}
{{#if technical_preferences}}
## Technical Preferences
{{technical_preferences}}
{{/if}}
{{#if organizational_context}}
## Organizational Context
{{organizational_context}}
{{/if}}
{{#if risks_and_assumptions}}
## Risks and Assumptions
{{risks_and_assumptions}}
{{/if}}
{{#if timeline_constraints}}
## Timeline
{{timeline_constraints}}
{{/if}}
{{#if supporting_materials}}
## Supporting Materials
{{supporting_materials}}
{{/if}}
---
_This Product Brief captures the vision and requirements for {{project_name}}._
_It was created through collaborative discovery and reflects the unique needs of this {{context_type}} project._
{{#if next_workflow}}
_Next: {{next_workflow}} will transform this brief into detailed planning artifacts._
{{else}}
_Next: Use the PRD workflow to create detailed product requirements from this brief._
{{/if}}

View File

@@ -0,0 +1,45 @@
# Product Brief - Interactive Workflow Configuration
name: product-brief
description: "Interactive product brief creation workflow that guides users through defining their product vision with multiple input sources and conversational collaboration"
author: "BMad"
# Critical variables from config
config_source: "{project-root}/bmad/bmm/config.yaml"
output_folder: "{config_source}:output_folder"
user_name: "{config_source}:user_name"
communication_language: "{config_source}:communication_language"
document_output_language: "{config_source}:document_output_language"
user_skill_level: "{config_source}:user_skill_level"
date: system-generated
# Optional input documents
recommended_inputs:
- market_research: "Market research document (optional)"
- brainstorming_results: "Brainstorming session outputs (optional)"
- competitive_analysis: "Competitive analysis (optional)"
- initial_ideas: "Initial product ideas or notes (optional)"
# Smart input file references - handles both whole docs and sharded docs
# Priority: Whole document first, then sharded version
input_file_patterns:
research:
whole: "{output_folder}/*research*.md"
sharded: "{output_folder}/*research*/index.md"
brainstorming:
whole: "{output_folder}/*brainstorm*.md"
sharded: "{output_folder}/*brainstorm*/index.md"
document_project:
sharded: "{output_folder}/docs/index.md"
# Module path and component files
installed_path: "{project-root}/bmad/bmm/workflows/1-analysis/product-brief"
template: "{installed_path}/template.md"
instructions: "{installed_path}/instructions.md"
validation: "{installed_path}/checklist.md"
# Output configuration
default_output_file: "{output_folder}/product-brief-{{project_name}}-{{date}}.md"
standalone: true