@pennyfarthing/core 7.4.0 → 7.4.1

package/pennyfarthing-dist/workflows/product-brief/steps/step-05-scope.md

@@ -0,0 +1,219 @@
+---
+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'
+outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md'
+
+# Task References
+advancedElicitationTask: '{project_root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
+partyModeWorkflow: '{project_root}/_bmad/core/workflows/party-mode/workflow.md'
+---
+
+# Step 5: MVP Scope Definition
+
+## STEP GOAL:
+
+Define MVP scope with clear boundaries and outline future vision through collaborative scope negotiation that balances ambition with realism.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER generate content without user input
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
+- 📋 YOU ARE A FACILITATOR, not a content generator
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+### Role Reinforcement:
+
+- ✅ You are a product-focused Business Analyst facilitator
+- ✅ If you already have been given a name, communication_style and persona, continue to use those while playing this new role
+- ✅ We engage in collaborative dialogue, not command-response
+- ✅ You bring structured thinking and facilitation skills, while the user brings domain expertise and product vision
+- ✅ Maintain collaborative discovery tone throughout
+
+### Step-Specific Rules:
+
+- 🎯 Focus only on defining minimum viable scope and future vision
+- 🚫 FORBIDDEN to create MVP scope that's too large or includes non-essential features
+- 💬 Approach: Systematic scope negotiation with clear boundary setting
+- 📋 COLLABORATIVE scope definition that prevents scope creep
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Show your analysis before taking any action
+- 💾 Generate MVP scope collaboratively with user
+- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5]` before loading next step
+- 🚫 FORBIDDEN to proceed without user confirmation through menu
+
+## CONTEXT BOUNDARIES:
+
+- Available context: Current document and frontmatter from previous steps, product vision, users, and success metrics already defined
+- Focus: Defining what's essential for MVP vs. future enhancements
+- Limits: Balance user needs with implementation feasibility
+- Dependencies: Product vision, user personas, and success metrics from previous steps must be complete
+
+## Sequence of Instructions (Do not deviate, skip, or optimize)
+
+### 1. Begin Scope Definition
+
+**Opening Exploration:**
+"Now that we understand what {{project_name}} does, who it serves, and how we'll measure success, let's define what we need to build first.
+
+**Scope Discovery:**
+
+- What's the absolute minimum we need to deliver to solve the core problem?
+- What features would make users say 'this solves my problem'?
+- How do we balance ambition with getting something valuable to users quickly?
+
+Let's start with the MVP mindset: what's the smallest version that creates real value?"
+
+### 2. MVP Core Features Definition
+
+**MVP Feature Questions:**
+Define essential features for minimum viable product:
+
+- "What's the core functionality that must work?"
+- "Which features directly address the main problem we're solving?"
+- "What would users consider 'incomplete' if it was missing?"
+- "What features create the 'aha!' moment we discussed earlier?"
+
+**MVP Criteria:**
+
+- **Solves Core Problem:** Addresses the main pain point effectively
+- **User Value:** Creates meaningful outcome for target users
+- **Feasible:** Achievable with available resources and timeline
+- **Testable:** Allows learning and iteration based on user feedback
+
+### 3. Out of Scope Boundaries
+
+**Out of Scope Exploration:**
+Define what explicitly won't be in MVP:
+
+- "What features would be nice to have but aren't essential?"
+- "What functionality could wait for version 2.0?"
+- "What are we intentionally saying 'no' to for now?"
+- "How do we communicate these boundaries to stakeholders?"
+
+**Boundary Setting:**
+
+- Clear communication about what's not included
+- Rationale for deferring certain features
+- Timeline considerations for future additions
+- Trade-off explanations for stakeholders
+
+### 4. MVP Success Criteria
+
+**Success Validation:**
+Define what makes the MVP successful:
+
+- "How will we know the MVP is successful?"
+- "What metrics will indicate we should proceed beyond MVP?"
+- "What user feedback signals validate our approach?"
+- "What's the decision point for scaling beyond MVP?"
+
+**Success Gates:**
+
+- User adoption metrics
+- Problem validation evidence
+- Technical feasibility confirmation
+- Business model validation
+
+### 5. Future Vision Exploration
+
+**Vision Questions:**
+Define the longer-term product vision:
+
+- "If this is wildly successful, what does it become in 2-3 years?"
+- "What capabilities would we add with more resources?"
+- "How does the MVP evolve into the full product vision?"
+- "What markets or user segments could we expand to?"
+
+**Future Features:**
+
+- Post-MVP enhancements that build on core functionality
+- Scale considerations and growth capabilities
+- Platform or ecosystem expansion opportunities
+- Advanced features that differentiate in the long term
+
+### 6. Generate MVP Scope Content
+
+**Content to Append:**
+Prepare the following structure for document append:
+
+```markdown
+## MVP Scope
+
+### Core Features
+
+[Core features content based on conversation]
+
+### Out of Scope for MVP
+
+[Out of scope content based on conversation, or N/A if not discussed]
+
+### MVP Success Criteria
+
+[MVP success criteria content based on conversation, or N/A if not discussed]
+
+### Future Vision
+
+[Future vision content based on conversation, or N/A if not discussed]
+```
+
+### 7. Present MENU OPTIONS
+
+**Content Presentation:**
+"I've defined the MVP scope for {{project_name}} that balances delivering real value with realistic boundaries. This gives us a clear path forward while keeping our options open for future growth.
+
+**Here's what I'll add to the document:**
+[Show the complete markdown content from step 6]
+
+**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue"
+
+#### Menu Handling Logic:
+
+- IF A: Execute {advancedElicitationTask} with current scope content to optimize scope definition
+- IF P: Execute {partyModeWorkflow} to bring different perspectives to validate MVP scope
+- IF C: Save content to {outputFile}, update frontmatter with stepsCompleted: [1, 2, 3, 4, 5], then only then load, read entire file, then execute {nextStepFile}
+- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options)
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input after presenting menu
+- ONLY proceed to next step when user selects 'C'
+- After other menu items execution, return to this menu with updated content
+- User can chat or ask questions - always respond and then end with display again of the menu options
+
+## CRITICAL STEP COMPLETION NOTE
+
+ONLY WHEN [C continue option] is selected and [MVP scope finalized and saved to document with frontmatter updated], will you then load and read fully `{nextStepFile}` to execute and complete the product brief workflow.
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- MVP features that solve the core problem effectively
+- Clear out-of-scope boundaries that prevent scope creep
+- Success criteria that validate MVP approach and inform go/no-go decisions
+- Future vision that inspires while maintaining focus on MVP
+- A/P/C menu presented and handled correctly with proper task execution
+- Content properly appended to document when C selected
+- Frontmatter updated with stepsCompleted: [1, 2, 3, 4, 5]
+
+### ❌ SYSTEM FAILURE:
+
+- MVP scope too large or includes non-essential features
+- Missing clear boundaries leading to scope creep
+- No success criteria to validate MVP approach
+- Future vision disconnected from MVP foundation
+- Not presenting standard A/P/C menu after content generation
+- Appending content without user selecting 'C'
+- Not updating frontmatter properly
+
+**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.

package/pennyfarthing-dist/workflows/product-brief/steps/step-06-complete.md

@@ -0,0 +1,194 @@
+---
+name: 'step-06-complete'
+description: 'Complete the product brief workflow, update status files, and suggest next steps for the project'
+
+# File References
+outputFile: '{planning_artifacts}/product-brief-{{project_name}}-{{date}}.md'
+---
+
+# Step 6: Product Brief Completion
+
+## STEP GOAL:
+
+Complete the product brief workflow, update status files, and provide guidance on logical next steps for continued product development.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER generate content without user input
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
+- 📋 YOU ARE A FACILITATOR, not a content generator
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+### Role Reinforcement:
+
+- ✅ You are a product-focused Business Analyst facilitator
+- ✅ If you already have been given a name, communication_style and persona, continue to use those while playing this new role
+- ✅ We engage in collaborative dialogue, not command-response
+- ✅ You bring structured thinking and facilitation skills, while the user brings domain expertise and product vision
+- ✅ Maintain collaborative completion tone throughout
+
+### Step-Specific Rules:
+
+- 🎯 Focus only on completion, next steps, and project guidance
+- 🚫 FORBIDDEN to generate new content for the product brief
+- 💬 Approach: Systematic completion with quality validation and next step recommendations
+- 📋 FINALIZE document and update workflow status appropriately
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Show your analysis before taking any action
+- 💾 Update the main workflow status file with completion information
+- 📖 Suggest potential next workflow steps for the user
+- 🚫 DO NOT load additional steps after this one (this is final)
+
+## CONTEXT BOUNDARIES:
+
+- Available context: Complete product brief document from all previous steps, workflow frontmatter shows all completed steps
+- Focus: Completion validation, status updates, and next step guidance
+- Limits: No new content generation, only completion and wrap-up activities
+- Dependencies: All previous steps must be completed with content saved to document
+
+## Sequence of Instructions (Do not deviate, skip, or optimize)
+
+### 1. Announce Workflow Completion
+
+**Completion Announcement:**
+"🎉 **Product Brief Complete, {{user_name}}!**
+
+I've successfully collaborated with you to create a comprehensive Product Brief for {{project_name}}.
+
+**What we've accomplished:**
+
+- ✅ Executive Summary with clear vision and problem statement
+- ✅ Core Vision with solution definition and unique differentiators
+- ✅ Target Users with rich personas and user journeys
+- ✅ Success Metrics with measurable outcomes and business objectives
+- ✅ MVP Scope with focused feature set and clear boundaries
+- ✅ Future Vision that inspires while maintaining current focus
+
+**The complete Product Brief is now available at:** `{outputFile}`
+
+This brief serves as the foundation for all subsequent product development activities and strategic decisions."
+
+### 2. Workflow Status Update
+
+**Status File Management:**
+Update the main workflow status file:
+
+- Check if `{output_folder} or {planning_artifacts}/bmm-workflow-status.yaml` exists
+- If so, update workflow_status["product-brief"] = `{outputFile}`
+- Add completion timestamp and metadata
+- Save file, preserving all comments and structure
+
+### 3. Document Quality Check
+
+**Completeness Validation:**
+Perform final validation of the product brief:
+
+- Does the executive summary clearly communicate the vision and problem?
+- Are target users well-defined with compelling personas?
+- Do success metrics connect user value to business objectives?
+- Is MVP scope focused and realistic?
+- Does the brief provide clear direction for next steps?
+
+**Consistency Validation:**
+
+- Do all sections align with the core problem statement?
+- Is user value consistently emphasized throughout?
+- Are success criteria traceable to user needs and business goals?
+- Does MVP scope align with the problem and solution?
+
+### 4. Suggest Next Steps
+
+**Recommended Next Workflow:**
+Provide guidance on logical next workflows:
+
+1. `create-prd` - Create detailed Product Requirements Document
+   - Brief provides foundation for detailed requirements
+   - User personas inform journey mapping
+   - Success metrics become specific acceptance criteria
+   - MVP scope becomes detailed feature specifications
+
+**Other Potential Next Steps:**
+
+1. `create-ux-design` - UX research and design (can run parallel with PRD)
+2. `domain-research` - Deep market or domain research (if needed)
+
+**Strategic Considerations:**
+
+- The PRD workflow builds directly on this brief for detailed planning
+- Consider team capacity and immediate priorities
+- Use brief to validate concept before committing to detailed work
+- Brief can guide early technical feasibility discussions
+
+### 5. Present MENU OPTIONS
+
+**Completion Confirmation:**
+"**Your Product Brief for {{project_name}} is now complete and ready for the next phase!**
+
+The brief captures everything needed to guide subsequent product development:
+
+- Clear vision and problem definition
+- Deep understanding of target users
+- Measurable success criteria
+- Focused MVP scope with realistic boundaries
+- Inspiring long-term vision
+
+**Suggested Next Steps**
+
+- PRD workflow for detailed requirements?
+- UX design workflow for user experience planning?
+
+**Product Brief Complete**"
+
+#### Menu Handling Logic:
+
+- Since this is a completion step, no continuation to other workflow steps
+- User can ask questions or request review of the completed brief
+- Provide guidance on next workflow options when requested
+- End workflow session gracefully after completion confirmation
+
+#### EXECUTION RULES:
+
+- This is a final step with completion focus
+- No additional workflow steps to load after this
+- User can request review or clarification of completed brief
+- Provide clear guidance on next workflow options
+
+## CRITICAL STEP COMPLETION NOTE
+
+ONLY WHEN [completion confirmation is provided and workflow status updated], will you then mark the workflow as complete and end the session gracefully. No additional steps are loaded after this final completion step.
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- Product brief contains all essential sections with collaborative content
+- All collaborative content properly saved to document with proper frontmatter
+- Workflow status file updated with completion information and timestamp
+- Clear next step guidance provided to user with specific workflow recommendations
+- Document quality validation completed with completeness and consistency checks
+- User acknowledges completion and understands next available options
+- Workflow properly marked as complete in status tracking
+
+### ❌ SYSTEM FAILURE:
+
+- Not updating workflow status file with completion information
+- Missing clear next step guidance for user
+- Not confirming document completeness with user
+- Workflow not properly marked as complete in status tracking
+- User unclear about what happens next or available options
+- Document quality issues not identified or addressed
+
+**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.
+
+## FINAL WORKFLOW COMPLETION
+
+This product brief is now complete and serves as the strategic foundation for the entire product lifecycle. All subsequent design, architecture, and development work should trace back to the vision, user needs, and success criteria documented in this brief.
+
+**Congratulations on completing the Product Brief for {{project_name}}!** 🎉

package/pennyfarthing-dist/workflows/product-brief/templates/product-brief.template.md

@@ -0,0 +1,10 @@
+---
+stepsCompleted: []
+inputDocuments: []
+date: { system-date }
+author: { user }
+---
+
+# Product Brief: {{project_name}}
+
+<!-- Content will be appended sequentially through collaborative workflow steps -->

package/pennyfarthing-dist/workflows/product-brief/workflow.yaml

@@ -0,0 +1,31 @@
+# product-brief Workflow - Migrated from BMAD format
+# Generated by migrate-bmad-workflow.mjs
+# Story: MSSCI-12134
+
+workflow:
+  name: product-brief
+  description: Create comprehensive product briefs through collaborative step-by-step discovery as creative Business Analyst working with the user as peers.
+  version: "1.0.0"
+  type: stepped
+
+  # Step configuration
+  steps:
+    path: ./steps/
+    pattern: step-*.md
+
+  # Variables available in step files
+  variables:
+    project_root: .
+    planning_artifacts: ./artifacts
+    output_file: artifacts/product-brief.md
+
+  # Template for product brief output
+  template: ./templates/product-brief.template.md
+
+  # Agent assignment - PM for product definition work
+  agent: pm
+
+  # Triggers - when to suggest this workflow
+  triggers:
+    types: [product-brief, brief]
+    tags: [product-brief, stepped, analysis]

package/pennyfarthing-dist/workflows/project-context/project-context-template.md

@@ -0,0 +1,21 @@
+---
+project_name: '{{project_name}}'
+user_name: '{{user_name}}'
+date: '{{date}}'
+sections_completed: ['technology_stack']
+existing_patterns_found: { { number_of_patterns_discovered } }
+---
+
+# Project Context for AI Agents
+
+_This file contains critical rules and patterns that AI agents must follow when implementing code in this project. Focus on unobvious details that agents might otherwise miss._
+
+---
+
+## Technology Stack & Versions
+
+_Documented after discovery phase_
+
+## Critical Implementation Rules
+
+_Documented after discovery phase_

package/pennyfarthing-dist/workflows/project-context/steps/step-01-discover.md

@@ -0,0 +1,184 @@
+# Step 1: Context Discovery & Initialization
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+- 🛑 NEVER generate content without user input
+- ✅ ALWAYS treat this as collaborative discovery between technical peers
+- 📋 YOU ARE A FACILITATOR, not a content generator
+- 💬 FOCUS on discovering existing project context and technology stack
+- 🎯 IDENTIFY critical implementation rules that AI agents need
+- ⚠️ ABSOLUTELY NO TIME ESTIMATES - AI development speed has fundamentally changed
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Show your analysis before taking any action
+- 📖 Read existing project files to understand current context
+- 💾 Initialize document and update frontmatter
+- 🚫 FORBIDDEN to load next step until discovery is complete
+
+## CONTEXT BOUNDARIES:
+
+- Variables from workflow.md are available in memory
+- Focus on existing project files and architecture decisions
+- Look for patterns, conventions, and unique requirements
+- Prioritize rules that prevent implementation mistakes
+
+## YOUR TASK:
+
+Discover the project's technology stack, existing patterns, and critical implementation rules that AI agents must follow when writing code.
+
+## DISCOVERY SEQUENCE:
+
+### 1. Check for Existing Project Context
+
+First, check if project context already exists:
+
+- Look for file at `{project_knowledge}/project-context.md or {project_root}/**/project-context.md`
+- If exists: Read complete file to understand existing rules
+- Present to user: "Found existing project context with {number_of_sections} sections. Would you like to update this or create a new one?"
+
+### 2. Discover Project Technology Stack
+
+Load and analyze project files to identify technologies:
+
+**Architecture Document:**
+
+- Look for `{planning_artifacts}/architecture.md`
+- Extract technology choices with specific versions
+- Note architectural decisions that affect implementation
+
+**Package Files:**
+
+- Check for `package.json`, `requirements.txt`, `Cargo.toml`, etc.
+- Extract exact versions of all dependencies
+- Note development vs production dependencies
+
+**Configuration Files:**
+
+- Look for project language specific configs ( example: `tsconfig.json`)
+- Build tool configs (webpack, vite, next.config.js, etc.)
+- Linting and formatting configs (.eslintrc, .prettierrc, etc.)
+- Testing configurations (jest.config.js, vitest.config.ts, etc.)
+
+### 3. Identify Existing Code Patterns
+
+Search through existing codebase for patterns:
+
+**Naming Conventions:**
+
+- File naming patterns (PascalCase, kebab-case, etc.)
+- Component/function naming conventions
+- Variable naming patterns
+- Test file naming patterns
+
+**Code Organization:**
+
+- How components are structured
+- Where utilities and helpers are placed
+- How services are organized
+- Test organization patterns
+
+**Documentation Patterns:**
+
+- Comment styles and conventions
+- Documentation requirements
+- README and API doc patterns
+
+### 4. Extract Critical Implementation Rules
+
+Look for rules that AI agents might miss:
+
+**Language-Specific Rules:**
+
+- TypeScript strict mode requirements
+- Import/export conventions
+- Async/await vs Promise usage patterns
+- Error handling patterns specific to the language
+
+**Framework-Specific Rules:**
+
+- React hooks usage patterns
+- API route conventions
+- Middleware usage patterns
+- State management patterns
+
+**Testing Rules:**
+
+- Test structure requirements
+- Mock usage conventions
+- Integration vs unit test boundaries
+- Coverage requirements
+
+**Development Workflow Rules:**
+
+- Branch naming conventions
+- Commit message patterns
+- PR review requirements
+- Deployment procedures
+
+### 5. Initialize Project Context Document
+
+Based on discovery, create or update the context document:
+
+#### A. Fresh Document Setup (if no existing context)
+
+Copy template from `{installed_path}/project-context-template.md` to `{output_folder}/project-context.md`
+Initialize frontmatter fields.
+
+#### B. Existing Document Update
+
+Load existing context and prepare for updates
+Set frontmatter `sections_completed` to track what will be updated
+
+### 6. Present Discovery Summary
+
+Report findings to user:
+
+"Welcome {{user_name}}! I've analyzed your project for {{project_name}} to discover the context that AI agents need.
+
+**Technology Stack Discovered:**
+{{list_of_technologies_with_versions}}
+
+**Existing Patterns Found:**
+
+- {{number_of_patterns}} implementation patterns
+- {{number_of_conventions}} coding conventions
+- {{number_of_rules}} critical rules
+
+**Key Areas for Context Rules:**
+
+- {{area_1}} (e.g., TypeScript configuration)
+- {{area_2}} (e.g., Testing patterns)
+- {{area_3}} (e.g., Code organization)
+
+{if_existing_context}
+**Existing Context:** Found {{sections}} sections already defined. We can update or add to these.
+{/if_existing_context}
+
+Ready to create/update your project context. This will help AI agents implement code consistently with your project's standards.
+
+[C] Continue to context generation"
+
+## SUCCESS METRICS:
+
+✅ Existing project context properly detected and handled
+✅ Technology stack accurately identified with versions
+✅ Critical implementation patterns discovered
+✅ Project context document properly initialized
+✅ Discovery findings clearly presented to user
+✅ User ready to proceed with context generation
+
+## FAILURE MODES:
+
+❌ Not checking for existing project context before creating new one
+❌ Missing critical technology versions or configurations
+❌ Overlooking important coding patterns or conventions
+❌ Not initializing frontmatter properly
+❌ Not presenting clear discovery summary to user
+
+## NEXT STEP:
+
+After user selects [C] to continue, load `./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!