npm - @pennyfarthing/core - Versions diffs - 7.4.1 → 7.5.0 - Mend

@pennyfarthing/core 7.4.1 → 7.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (890) hide show

package/pennyfarthing-dist/workflows/prd/steps-c/step-12-complete.md DELETED Viewed

@@ -1,180 +0,0 @@
----
-name: 'step-12-complete'
-description: 'Complete the PRD workflow, update status files, and suggest next steps including validation'
-# File References
-outputFile: '{planning_artifacts}/prd.md'
-validationFlow: '../steps-v/step-v-01-discovery.md'
----
-# Step 12: Workflow Completion
-**Final Step - Complete the PRD**
-## MANDATORY EXECUTION RULES (READ FIRST):
-- ✅ THIS IS A FINAL STEP - Workflow completion required
-- 📖 CRITICAL: ALWAYS read the complete step file before taking any action
-- 🛑 NO content generation - this is a wrap-up step
-- 📋 FINALIZE document and update workflow status
-- 💬 FOCUS on completion, validation options, and next steps
-- 🎯 UPDATE workflow status files with completion information
-- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
-## EXECUTION PROTOCOLS:
-- 🎯 Show your analysis before taking any action
-- 💾 Update the main workflow status file with completion information (if exists)
-- 📖 Offer validation workflow options to user
-- 🚫 DO NOT load additional steps after this one
-## TERMINATION STEP PROTOCOLS:
-- This is a FINAL step - workflow completion required
-- Update workflow status file with finalized document
-- Suggest validation and next workflow steps
-- Mark workflow as complete in status tracking
-## CONTEXT BOUNDARIES:
-- Complete and polished PRD document is available from all previous steps
-- Workflow frontmatter shows all completed steps including polish
-- All collaborative content has been generated, saved, and optimized
-- Focus on completion, validation options, and next steps
-## YOUR TASK:
-Complete the PRD workflow, update status files, offer validation options, and suggest next steps for the project.
-## WORKFLOW COMPLETION SEQUENCE:
-### 1. Announce Workflow Completion
-Inform user that the PRD is complete and polished:
-- Celebrate successful completion of comprehensive PRD
-- Summarize all sections that were created
-- Highlight that document has been polished for flow and coherence
-- Emphasize document is ready for downstream work
-### 2. Workflow Status Update
-Update the main workflow status file if there is one:
-- Load `{status_file}` from workflow configuration (if exists)
-- Update workflow_status["prd"] = "{default_output_file}"
-- Save file, preserving all comments and structure
-- Mark current timestamp as completion time
-### 3. Validation Workflow Options
-Offer validation workflows to ensure PRD is ready for implementation:
-**Available Validation Workflows:**
-**Option 1: Check Implementation Readiness** (`{checkImplementationReadinessWorkflow}`)
-- Validates PRD has all information needed for development
-- Checks epic coverage completeness
-- Reviews UX alignment with requirements
-- Assesses epic quality and readiness
-- Identifies gaps before architecture/design work begins
-**When to use:** Before starting technical architecture or epic breakdown
-**Option 2: Skip for Now**
-- Proceed directly to next workflows (architecture, UX, epics)
-- Validation can be done later if needed
-- Some teams prefer to validate during architecture reviews
-### 4. Suggest Next Workflows
-Provide guidance on logical next workflows - strongly suggesting any of these chosen are started in a fresh context with the appropriate agent:
-**Typical Next Workflows:**
-**Immediate Next Steps:**
-1. **PRD Quality Validation First (Recommended):**
-   - execute the `{validationFlow}` workflow if selected or start a new chat with me and select the validate PRD menu item
-   - Ensures PRD is complete and ready
-   - Identifies any gaps or issues
-   - Validates before committing to architecture/design
-2. **UX Design:** `workflow create-ux-design` with the UX-Designer Agent (if UI exists)
-   - User journey insights from step-04 inform interaction design
-   - Functional requirements from step-09 define design scope
-   - Polish-optimized document provides clear design requirements
-3. **Technical Architecture:** `workflow create-architecture` with the Architect Agent
-   - Project-type requirements from step-07 guide technical decisions
-   - Non-functional requirements from step-10 inform architecture choices
-   - Functional requirements define system capabilities
-4. **Epic Breakdown:** `workflow create-epics-and-stories` with me again - but really recommend first doing a UX if needed and an architecture!
-   - Functional requirements from step-09 become epics and stories
-   - Scope definition from step-03 guides sprint planning
-   - Richer when created after UX/architecture
-**Strategic Considerations:**
-- Validation adds confidence before architecture/design investment
-- UX design and architecture can happen in parallel after validation
-- Epics/stories are richer when created after UX/architecture
-- Order depends on team preferences and project needs
-### 5. Final Completion Confirmation
-- Confirm completion with user and summarize what has been accomplished
-- Document now contains: Executive Summary, Success Criteria, User Journeys, Domain Requirements (if applicable), Innovation Analysis (if applicable), Project-Type Requirements, Functional Requirements (capability contract), Non-Functional Requirements, and has been polished for flow and coherence
-- Ask if they'd like to run validation workflow or proceed to next workflows
-## SUCCESS METRICS:
-✅ PRD document contains all required sections and has been polished
-✅ All collaborative content properly saved and optimized
-✅ Workflow status file updated with completion information (if exists)
-✅ Validation workflow options clearly presented
-✅ Clear next step guidance provided to user
-✅ Document quality validation completed
-✅ User acknowledges completion and understands next options
-## FAILURE MODES:
-❌ Not updating workflow status file with completion information (if exists)
-❌ Not offering validation workflow options
-❌ Missing clear next step guidance for user
-❌ Not confirming document completeness with user
-❌ Workflow not properly marked as complete in status tracking (if applicable)
-❌ User unclear about what happens next or what validation options exist
-❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
-❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
-## WORKFLOW COMPLETION CHECKLIST:
-### Document Structure Complete:
-- [ ] Executive Summary with vision and differentiator
-- [ ] Success Criteria with measurable outcomes
-- [ ] Product Scope (MVP, Growth, Vision)
-- [ ] User Journeys (comprehensive coverage)
-- [ ] Domain Requirements (if applicable)
-- [ ] Innovation Analysis (if applicable)
-- [ ] Project-Type Requirements
-- [ ] Functional Requirements (capability contract)
-- [ ] Non-Functional Requirements
-- [ ] Document polished for flow and coherence
-### Process Complete:
-- [ ] All steps (including polish) completed with user confirmation
-- [ ] All content saved and optimized
-- [ ] Frontmatter properly updated
-- [ ] Workflow status file updated (if exists)
-- [ ] Validation options presented
-- [ ] Next steps clearly communicated
-## FINAL REMINDER to give the user:
-The polished PRD serves as the foundation for all subsequent product development activities. All design, architecture, and development work should trace back to the requirements and vision documented in this PRD - update it also as needed as you continue planning.
-**Congratulations on completing the Product Requirements Document for {{project_name}}!** 🎉

package/pennyfarthing-dist/workflows/prd/steps-e/step-e-01-discovery.md DELETED Viewed

@@ -1,247 +0,0 @@
----
-name: 'step-e-01-discovery'
-description: 'Discovery & Understanding - Understand what user wants to edit and detect PRD format'
-# File references (ONLY variables used in this step)
-altStepFile: './step-e-01b-legacy-conversion.md'
-prdPurpose: '{project_root}/src/modules/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md'
-advancedElicitationTask: '{project_root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
-partyModeWorkflow: '{project_root}/_bmad/core/workflows/party-mode/workflow.md'
----
-# Step E-1: Discovery & Understanding
-## STEP GOAL:
-Understand what the user wants to edit in the PRD, detect PRD format/type, check for validation report guidance, and route appropriately.
-## 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 Validation Architect and PRD Improvement Specialist
-- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role
-- ✅ We engage in collaborative dialogue, not command-response
-- ✅ You bring analytical expertise and improvement guidance
-- ✅ User brings domain knowledge and edit requirements
-### Step-Specific Rules:
-- 🎯 Focus ONLY on discovering user intent and PRD format
-- 🚫 FORBIDDEN to make any edits yet
-- 💬 Approach: Inquisitive and analytical, understanding before acting
-- 🚪 This is a branch step - may route to legacy conversion
-## EXECUTION PROTOCOLS:
-- 🎯 Discover user's edit requirements
-- 🎯 Auto-detect validation reports in PRD folder (use as guide)
-- 🎯 Load validation report if provided (use as guide)
-- 🎯 Detect PRD format (BMAD/legacy)
-- 🎯 Route appropriately based on format
-- 💾 Document discoveries for next step
-- 🚫 FORBIDDEN to proceed without understanding requirements
-## CONTEXT BOUNDARIES:
-- Available context: PRD file to edit, optional validation report, auto-detected validation reports
-- Focus: User intent discovery and format detection only
-- Limits: Don't edit yet, don't validate yet
-- Dependencies: None - this is first edit step
-## MANDATORY SEQUENCE
-**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.
-### 1. Load PRD Purpose Standards
-Load and read the complete file at:
-`{prdPurpose}` (data/prd-purpose.md)
-This file defines what makes a great BMAD PRD. Internalize this understanding - it will guide improvement recommendations.
-### 2. Discover PRD to Edit
-"**PRD Edit Workflow**
-Which PRD would you like to edit?
-Please provide the path to the PRD file you want to edit."
-**Wait for user to provide PRD path.**
-### 3. Validate PRD Exists and Load
-Once PRD path is provided:
-- Check if PRD file exists at specified path
-- If not found: "I cannot find a PRD at that path. Please check the path and try again."
-- If found: Load the complete PRD file including frontmatter
-### 4. Check for Existing Validation Report
-**Check if validation report exists in the PRD folder:**
-```bash
-# Look for most recent validation report in the PRD folder
-ls -t {prd_folder_path}/validation-report-*.md 2>/dev/null | head -1
-```
-**If validation report found:**
-Display:
-"**📋 Found Validation Report**
-I found a validation report from {validation_date} in the PRD folder.
-This report contains findings from previous validation checks and can help guide our edits to fix known issues.
-**Would you like to:**
-- **[U] Use validation report** - Load it to guide and prioritize edits
-- **[S] Skip** - Proceed with manual edit discovery"
-**Wait for user input.**
-**IF U (Use validation report):**
-- Load the validation report file
-- Extract findings, issues, and improvement suggestions
-- Note: "Validation report loaded - will use it to guide prioritized improvements"
-- Continue to step 5
-**IF S (Skip) or no validation report found:**
-- Note: "Proceeding with manual edit discovery"
-- Continue to step 5
-**If no validation report found:**
-- Note: "No validation report found in PRD folder"
-- Continue to step 5 without asking user
-### 5. Ask About Validation Report
-"**Do you have a validation report to guide edits?**
-If you've run the validation workflow on this PRD, I can use that report to guide improvements and prioritize changes.
-Validation report path (or type 'none'):"
-**Wait for user input.**
-**If validation report path provided:**
-- Load the validation report
-- Extract findings, severity, improvement suggestions
-- Note: "Validation report loaded - will use it to guide prioritized improvements"
-**If no validation report:**
-- Note: "Proceeding with manual edit discovery"
-- Continue to step 6
-### 6. Discover Edit Requirements
-"**What would you like to edit in this PRD?**
-Please describe the changes you want to make. For example:
-- Fix specific issues (information density, implementation leakage, etc.)
-- Add missing sections or content
-- Improve structure and flow
-- Convert to BMAD format (if legacy PRD)
-- General improvements
-- Other changes
-**Describe your edit goals:**"
-**Wait for user to describe their requirements.**
-### 7. Detect PRD Format
-Analyze the loaded PRD:
-**Extract all ## Level 2 headers** from PRD
-**Check for BMAD PRD core sections:**
-1. Executive Summary
-2. Success Criteria
-3. Product Scope
-4. User Journeys
-5. Functional Requirements
-6. Non-Functional Requirements
-**Classify format:**
-- **BMAD Standard:** 5-6 core sections present
-- **BMAD Variant:** 3-4 core sections present, generally follows BMAD patterns
-- **Legacy (Non-Standard):** Fewer than 3 core sections, does not follow BMAD structure
-### 8. Route Based on Format and Context
-**IF validation report provided OR PRD is BMAD Standard/Variant:**
-Display: "**Edit Requirements Understood**
-**PRD Format:** {classification}
-{If validation report: "**Validation Guide:** Yes - will use validation report findings"}
-**Edit Goals:** {summary of user's requirements}
-**Proceeding to deep review and analysis...**"
-Load and execute next step (step-e-02-review.md)
-**IF PRD is Legacy (Non-Standard) AND no validation report:**
-Display: "**Format Detected:** Legacy PRD
-This PRD does not follow BMAD standard structure (only {count}/6 core sections present).
-**Your edit goals:** {user's requirements}
-**How would you like to proceed?**"
-Present MENU OPTIONS below for user selection
-### 9. Present MENU OPTIONS (Legacy PRDs Only)
-**[C] Convert to BMAD Format** - Convert PRD to BMAD standard structure, then apply your edits
-**[E] Edit As-Is** - Apply your edits without converting the format
-**[X] Exit** - Exit and review conversion options
-#### EXECUTION RULES:
-- ALWAYS halt and wait for user input
-- Only proceed based on user selection
-#### Menu Handling Logic:
-- IF C (Convert): Load, read entire file, then execute {altStepFile} (step-e-01b-legacy-conversion.md)
-- IF E (Edit As-Is): Display "Proceeding with edits..." then load next step
-- IF X (Exit): Display summary and exit
-- IF Any other: help user, then redisplay menu
----
-## 🚨 SYSTEM SUCCESS/FAILURE METRICS
-### ✅ SUCCESS:
-- User's edit requirements clearly understood
-- Auto-detected validation reports loaded and analyzed (when found)
-- Manual validation report loaded and analyzed (if provided)
-- PRD format detected correctly
-- BMAD PRDs proceed directly to review step
-- Legacy PRDs pause and present conversion options
-- User can choose conversion path or edit as-is
-### ❌ SYSTEM FAILURE:
-- Not discovering user's edit requirements
-- Not auto-detecting validation reports in PRD folder
-- Not loading validation report when provided (auto or manual)
-- Missing format detection
-- Not pausing for legacy PRDs without guidance
-- Auto-proceeding without understanding intent
-**Master Rule:** Understand before editing. Detect format early so we can guide users appropriately. Auto-detect and use validation reports for prioritized improvements.

package/pennyfarthing-dist/workflows/prd/steps-e/step-e-01b-legacy-conversion.md DELETED Viewed

@@ -1,208 +0,0 @@
----
-name: 'step-e-01b-legacy-conversion'
-description: 'Legacy PRD Conversion Assessment - Analyze legacy PRD and propose conversion strategy'
-# File references (ONLY variables used in this step)
-nextStepFile: './step-e-02-review.md'
-prdFile: '{prd_file_path}'
-prdPurpose: '{project_root}/src/modules/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md'
----
-# Step E-1B: Legacy PRD Conversion Assessment
-## STEP GOAL:
-Analyze legacy PRD against BMAD standards, identify gaps, propose conversion strategy, and let user choose how to proceed.
-## 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 Validation Architect and PRD Improvement Specialist
-- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role
-- ✅ We engage in collaborative dialogue, not command-response
-- ✅ You bring BMAD standards expertise and conversion guidance
-- ✅ User brings domain knowledge and edit requirements
-### Step-Specific Rules:
-- 🎯 Focus ONLY on conversion assessment and proposal
-- 🚫 FORBIDDEN to perform conversion yet (that comes in edit step)
-- 💬 Approach: Analytical gap analysis with clear recommendations
-- 🚪 This is a branch step - user chooses conversion path
-## EXECUTION PROTOCOLS:
-- 🎯 Analyze legacy PRD against BMAD standard
-- 💾 Identify gaps and estimate conversion effort
-- 📖 Present conversion options with effort estimates
-- 🚫 FORBIDDEN to proceed without user selection
-## CONTEXT BOUNDARIES:
-- Available context: Legacy PRD, user's edit requirements, prd-purpose standards
-- Focus: Conversion assessment only (not actual conversion)
-- Limits: Don't convert yet, don't validate yet
-- Dependencies: Step e-01 detected legacy format and routed here
-## MANDATORY SEQUENCE
-**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.
-### 1. Attempt Sub-Process Assessment
-**Try to use Task tool with sub-agent:**
-"Perform legacy PRD conversion assessment:
-**Load the PRD and prd-purpose.md**
-**For each BMAD PRD section, analyze:**
-1. Does PRD have this section? (Executive Summary, Success Criteria, Product Scope, User Journeys, Functional Requirements, Non-Functional Requirements)
-2. If present: Is it complete and well-structured?
-3. If missing: What content exists that could migrate to this section?
-4. Effort to create/complete: Minimal / Moderate / Significant
-**Identify:**
-- Core sections present: {count}/6
-- Content gaps in each section
-- Overall conversion effort: Quick / Moderate / Substantial
-- Recommended approach: Full restructuring vs targeted improvements
-Return conversion assessment with gap analysis and effort estimate."
-**Graceful degradation (if no Task tool):**
-- Manually check PRD for each BMAD section
-- Note what's present and what's missing
-- Estimate conversion effort
-- Identify best conversion approach
-### 2. Build Gap Analysis
-**For each BMAD core section:**
-**Executive Summary:**
-- Present: [Yes/No/Partial]
-- Gap: [what's missing or incomplete]
-- Effort to Complete: [Minimal/Moderate/Significant]
-**Success Criteria:**
-- Present: [Yes/No/Partial]
-- Gap: [what's missing or incomplete]
-- Effort to Complete: [Minimal/Moderate/Significant]
-**Product Scope:**
-- Present: [Yes/No/Partial]
-- Gap: [what's missing or incomplete]
-- Effort to Complete: [Minimal/Moderate/Significant]
-**User Journeys:**
-- Present: [Yes/No/Partial]
-- Gap: [what's missing or incomplete]
-- Effort to Complete: [Minimal/Moderate/Significant]
-**Functional Requirements:**
-- Present: [Yes/No/Partial]
-- Gap: [what's missing or incomplete]
-- Effort to Complete: [Minimal/Moderate/Significant]
-**Non-Functional Requirements:**
-- Present: [Yes/No/Partial]
-- Gap: [what's missing or incomplete]
-- Effort to Complete: [Minimal/Moderate/Significant]
-**Overall Assessment:**
-- Sections Present: {count}/6
-- Total Conversion Effort: [Quick/Moderate/Substantial]
-- Recommended: [Full restructuring / Targeted improvements]
-### 3. Present Conversion Assessment
-Display:
-"**Legacy PRD Conversion Assessment**
-**Current PRD Structure:**
-- Core sections present: {count}/6
-{List which sections are present/missing}
-**Gap Analysis:**
-{Present gap analysis table showing each section's status and effort}
-**Overall Conversion Effort:** {effort level}
-**Your Edit Goals:**
-{Reiterate user's stated edit requirements}
-**Recommendation:**
-{Based on effort and user goals, recommend best approach}
-**How would you like to proceed?**"
-### 4. Present MENU OPTIONS
-**[R] Restructure to BMAD** - Full conversion to BMAD format, then apply your edits
-**[I] Targeted Improvements** - Apply your edits to existing structure without restructuring
-**[E] Edit & Restructure** - Do both: convert format AND apply your edits
-**[X] Exit** - Review assessment and decide
-#### EXECUTION RULES:
-- ALWAYS halt and wait for user input
-- Only proceed based on user selection
-#### Menu Handling Logic:
-- IF R (Restructure): Note conversion mode, then load next step
-- IF I (Targeted): Note targeted mode, then load next step
-- IF E (Edit & Restructure): Note both mode, then load next step
-- IF X (Exit): Display summary, exit
-### 5. Document Conversion Strategy
-Store conversion decision for next step:
-- **Conversion mode:** [Full restructuring / Targeted improvements / Both]
-- **Edit requirements:** [user's requirements from step e-01]
-- **Gap analysis:** [summary of gaps identified]
-Display: "**Conversion Strategy Documented**
-Mode: {conversion mode}
-Edit goals: {summary}
-**Proceeding to deep review...**"
-Load and execute {nextStepFile} (step-e-02-review.md)
----
-## 🚨 SYSTEM SUCCESS/FAILURE METRICS
-### ✅ SUCCESS:
-- All 6 BMAD core sections analyzed for gaps
-- Effort estimates provided for each section
-- Overall conversion effort assessed correctly
-- Clear recommendation provided based on effort and user goals
-- User chooses conversion strategy (restructure/targeted/both)
-- Conversion strategy documented for next step
-### ❌ SYSTEM FAILURE:
-- Not analyzing all 6 core sections
-- Missing effort estimates
-- Not providing clear recommendation
-- Auto-proceeding without user selection
-- Not documenting conversion strategy
-**Master Rule:** Legacy PRDs need conversion assessment so users understand the work involved and can choose the best approach.