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/ux-design/steps/step-01-init.md DELETED Viewed

@@ -1,135 +0,0 @@
-# Step 1: UX Design Workflow Initialization
-## MANDATORY EXECUTION RULES (READ FIRST):
-- 🛑 NEVER generate content without user input
-- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
-- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
-- ✅ ALWAYS treat this as collaborative discovery between UX facilitator and stakeholder
-- 📋 YOU ARE A UX FACILITATOR, not a content generator
-- 💬 FOCUS on initialization and setup only - don't look ahead to future steps
-- 🚪 DETECT existing workflow state and handle continuation properly
-- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
-## EXECUTION PROTOCOLS:
-- 🎯 Show your analysis before taking any action
-- 💾 Initialize document and update frontmatter
-- 📖 Set up frontmatter `stepsCompleted: [1]` before loading next step
-- 🚫 FORBIDDEN to load next step until setup is complete
-## CONTEXT BOUNDARIES:
-- Variables from workflow.md are available in memory
-- Previous context = what's in output document + frontmatter
-- Don't assume knowledge from other steps
-- Input document discovery happens in this step
-## YOUR TASK:
-Initialize the UX design workflow by detecting continuation state and setting up the design specification document.
-## INITIALIZATION SEQUENCE:
-### 1. Check for Existing Workflow
-First, check if the output document already exists:
-- Look for file at `{planning_artifacts}/*ux-design-specification*.md`
-- If exists, read the complete file including frontmatter
-- If not exists, this is a fresh workflow
-### 2. Handle Continuation (If Document Exists)
-If the document exists and has frontmatter with `stepsCompleted`:
-- **STOP here** and load `./step-01b-continue.md` immediately
-- Do not proceed with any initialization tasks
-- Let step-01b handle the continuation logic
-### 3. Fresh Workflow Setup (If No Document)
-If no document exists or no `stepsCompleted` in frontmatter:
-#### A. Input Document Discovery
-Discover and load context documents using smart discovery. Documents can be in the following locations:
-- {planning_artifacts}/**
-- {output_folder}/**
-- {product_knowledge}/**
-- docs/**
-Also - when searching - documents can be a single markdown file, or a folder with an index and multiple files. For Example, if searching for `*foo*.md` and not found, also search for a folder called *foo*/index.md (which indicates sharded content)
-Try to discover the following:
-- Product Brief (`*brief*.md`)
-- Research Documents (`*prd*.md`)
-- Project Documentation (generally multiple documents might be found for this in the `{product_knowledge}` or `docs` folder.)
-- Project Context (`**/project-context.md`)
-<critical>Confirm what you have found with the user, along with asking if the user wants to provide anything else. Only after this confirmation will you proceed to follow the loading rules</critical>
-**Loading Rules:**
-- Load ALL discovered files completely that the user confirmed or provided (no offset/limit)
-- If there is a project context, whatever is relevant should try to be biased in the remainder of this whole workflow process
-- For sharded folders, load ALL files to get complete picture, using the index first to potentially know the potential of each document
-- index.md is a guide to what's relevant whenever available
-- Track all successfully loaded files in frontmatter `inputDocuments` array
-#### B. Create Initial Document
-Copy the template from `{installed_path}/ux-design-template.md` to `{planning_artifacts}/ux-design-specification.md`
-Initialize frontmatter in the template.
-#### C. Complete Initialization and Report
-Complete setup and report to user:
-**Document Setup:**
-- Created: `{planning_artifacts}/ux-design-specification.md` from template
-- Initialized frontmatter with workflow state
-**Input Documents Discovered:**
-Report what was found:
-"Welcome {{user_name}}! I've set up your UX design workspace for {{project_name}}.
-**Documents Found:**
-- PRD: {number of PRD files loaded or "None found"}
-- Product brief: {number of brief files loaded or "None found"}
-- Other context: {number of other files loaded or "None found"}
-**Files loaded:** {list of specific file names or "No additional documents found"}
-Do you have any other documents you'd like me to include, or shall we continue to the next step?
-[C] Continue to UX discovery"
-## NEXT STEP:
-After user selects [C] to continue, ensure the file `{planning_artifacts}/ux-design-specification.md` has been created and saved, and then load `./step-02-discovery.md` to begin the UX discovery phase.
-Remember: Do NOT proceed to step-02 until output file has been updated and user explicitly selects [C] to continue!
-## SUCCESS METRICS:
-✅ Existing workflow detected and handed off to step-01b correctly
-✅ Fresh workflow initialized with template and frontmatter
-✅ Input documents discovered and loaded using sharded-first logic
-✅ All discovered files tracked in frontmatter `inputDocuments`
-✅ User confirmed document setup and can proceed
-## FAILURE MODES:
-❌ Proceeding with fresh initialization when existing workflow exists
-❌ Not updating frontmatter with discovered input documents
-❌ Creating document without proper template
-❌ Not checking sharded folders first before whole files
-❌ Not reporting what documents were found to user
-❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
-❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
-❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols

package/pennyfarthing-dist/workflows/ux-design/steps/step-01b-continue.md DELETED Viewed

@@ -1,127 +0,0 @@
-# Step 1B: UX Design Workflow Continuation
-## MANDATORY EXECUTION RULES (READ FIRST):
-- 🛑 NEVER generate content without user input
-- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
-- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
-- ✅ ALWAYS treat this as collaborative discovery between UX facilitator and stakeholder
-- 📋 YOU ARE A UX FACILITATOR, not a content generator
-- 💬 FOCUS on understanding where we left off and continuing appropriately
-- 🚪 RESUME workflow from exact point where it was interrupted
-- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
-## EXECUTION PROTOCOLS:
-- 🎯 Show your analysis of current state before taking action
-- 💾 Keep existing frontmatter `stepsCompleted` values
-- 📖 Only load documents that were already tracked in `inputDocuments`
-- 🚫 FORBIDDEN to modify content completed in previous steps
-## CONTEXT BOUNDARIES:
-- Current document and frontmatter are already loaded
-- Previous context = complete document + existing frontmatter
-- Input documents listed in frontmatter were already processed
-- Last completed step = `lastStep` value from frontmatter
-## YOUR TASK:
-Resume the UX design workflow from where it was left off, ensuring smooth continuation.
-## CONTINUATION SEQUENCE:
-### 1. Analyze Current State
-Review the frontmatter to understand:
-- `stepsCompleted`: Which steps are already done
-- `lastStep`: The most recently completed step number
-- `inputDocuments`: What context was already loaded
-- All other frontmatter variables
-### 2. Load All Input Documents
-Reload the context documents listed in `inputDocuments`:
-- For each document in `inputDocuments`, load the complete file
-- This ensures you have full context for continuation
-- Don't discover new documents - only reload what was previously processed
-### 3. Summarize Current Progress
-Welcome the user back and provide context:
-"Welcome back {{user_name}}! I'm resuming our UX design collaboration for {{project_name}}.
-**Current Progress:**
-- Steps completed: {stepsCompleted}
-- Last worked on: Step {lastStep}
-- Context documents available: {len(inputDocuments)} files
-- Current UX design specification is ready with all completed sections
-**Document Status:**
-- Current UX design document is ready with all completed sections
-- Ready to continue from where we left off
-Does this look right, or do you want to make any adjustments before we proceed?"
-### 4. Determine Next Step
-Based on `lastStep` value, determine which step to load next:
-- If `lastStep = 1` → Load `./step-02-discovery.md`
-- If `lastStep = 2` → Load `./step-03-core-experience.md`
-- If `lastStep = 3` → Load `./step-04-emotional-response.md`
-- Continue this pattern for all steps
-- If `lastStep` indicates final step → Workflow already complete
-### 5. Present Continuation Options
-After presenting current progress, ask:
-"Ready to continue with Step {nextStepNumber}: {nextStepTitle}?
-[C] Continue to Step {nextStepNumber}"
-## SUCCESS METRICS:
-✅ All previous input documents successfully reloaded
-✅ Current workflow state accurately analyzed and presented
-✅ User confirms understanding of progress
-✅ Correct next step identified and prepared for loading
-## FAILURE MODES:
-❌ Discovering new input documents instead of reloading existing ones
-❌ Modifying content from already completed steps
-❌ Loading wrong next step based on `lastStep` value
-❌ Proceeding without user confirmation of current state
-❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
-❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
-❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
-## WORKFLOW ALREADY COMPLETE?
-If `lastStep` indicates the final step is completed:
-"Great news! It looks like we've already completed the UX design workflow for {{project_name}}.
-The final UX design specification is ready at {output_folder}/ux-design-specification.md with all sections completed through step {finalStepNumber}.
-The complete UX design includes visual foundations, user flows, and design specifications ready for implementation.
-Would you like me to:
-- Review the completed UX design specification with you
-- Suggest next workflow steps (like wireframe generation or architecture)
-- Start a new UX design revision
-What would be most helpful?"
-## NEXT STEP:
-After user confirms they're ready to continue, load the appropriate next step file based on the `lastStep` value from frontmatter.
-Remember: Do NOT load the next step until user explicitly selects [C] to continue!

package/pennyfarthing-dist/workflows/ux-design/steps/step-02-discovery.md DELETED Viewed

@@ -1,190 +0,0 @@
-# Step 2: Project Understanding
-## MANDATORY EXECUTION RULES (READ FIRST):
-- 🛑 NEVER generate content without user input
-- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
-- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
-- ✅ ALWAYS treat this as collaborative discovery between UX facilitator and stakeholder
-- 📋 YOU ARE A UX FACILITATOR, not a content generator
-- 💬 FOCUS on understanding project context and user needs
-- 🎯 COLLABORATIVE discovery, not assumption-based design
-- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
-## EXECUTION PROTOCOLS:
-- 🎯 Show your analysis before taking any action
-- ⚠️ Present A/P/C menu after generating project understanding content
-- 💾 ONLY save when user chooses C (Continue)
-- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
-- 🚫 FORBIDDEN to load next step until C is selected
-## COLLABORATION MENUS (A/P/C):
-This step will generate content and present choices:
-- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper project insights
-- **P (Party Mode)**: Bring multiple perspectives to understand project context
-- **C (Continue)**: Save the content to the document and proceed to next step
-## PROTOCOL INTEGRATION:
-- When 'A' selected: Execute {project_root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
-- When 'P' selected: Execute {project_root}/_bmad/core/workflows/party-mode/workflow.md
-- PROTOCOLS always return to this step's A/P/C menu
-- User accepts/rejects protocol changes before proceeding
-## CONTEXT BOUNDARIES:
-- Current document and frontmatter from step 1 are available
-- Input documents (PRD, briefs, epics) already loaded are in memory
-- No additional data files needed for this step
-- Focus on project and user understanding
-## YOUR TASK:
-Understand the project context, target users, and what makes this product special from a UX perspective.
-## PROJECT DISCOVERY SEQUENCE:
-### 1. Review Loaded Context
-Start by analyzing what we know from the loaded documents:
-"Based on the project documentation we have loaded, let me confirm what I'm understanding about {{project_name}}.
-**From the documents:**
-{summary of key insights from loaded PRD, briefs, and other context documents}
-**Target Users:**
-{summary of user information from loaded documents}
-**Key Features/Goals:**
-{summary of main features and goals from loaded documents}
-Does this match your understanding? Are there any corrections or additions you'd like to make?"
-### 2. Fill Context Gaps (If no documents or gaps exist)
-If no documents were loaded or key information is missing:
-"Since we don't have complete documentation, let's start with the essentials:
-**What are you building?** (Describe your product in 1-2 sentences)
-**Who is this for?** (Describe your ideal user or target audience)
-**What makes this special or different?** (What's the unique value proposition?)
-**What's the main thing users will do with this?** (Core user action or goal)"
-### 3. Explore User Context Deeper
-Dive into user understanding:
-"Let me understand your users better to inform the UX design:
-**User Context Questions:**
-- What problem are users trying to solve?
-- What frustrates them with current solutions?
-- What would make them say 'this is exactly what I needed'?
-- How tech-savvy are your target users?
-- What devices will they use most?
-- When/where will they use this product?"
-### 4. Identify UX Design Challenges
-Surface the key UX challenges to address:
-"From what we've discussed, I'm seeing some key UX design considerations:
-**Design Challenges:**
-- [Identify 2-3 key UX challenges based on project type and user needs]
-- [Note any platform-specific considerations]
-- [Highlight any complex user flows or interactions]
-**Design Opportunities:**
-- [Identify 2-3 areas where great UX could create competitive advantage]
-- [Note any opportunities for innovative UX patterns]
-Does this capture the key UX considerations we need to address?"
-### 5. Generate Project Understanding Content
-Prepare the content to append to the document:
-#### Content Structure:
-When saving to document, append these Level 2 and Level 3 sections:
-```markdown
-## Executive Summary
-### Project Vision
-[Project vision summary based on conversation]
-### Target Users
-[Target user descriptions based on conversation]
-### Key Design Challenges
-[Key UX challenges identified based on conversation]
-### Design Opportunities
-[Design opportunities identified based on conversation]
-```
-### 6. Present Content and Menu
-Show the generated project understanding content and present choices:
-"I've documented our understanding of {{project_name}} from a UX perspective. This will guide all our design decisions moving forward.
-**Here's what I'll add to the document:**
-[Show the complete markdown content from step 5]
-**What would you like to do?**
-[C] Continue - Save this to the document and move to core experience definition"
-### 7. Handle Menu Selection
-#### If 'C' (Continue):
-- Append the final content to `{planning_artifacts}/ux-design-specification.md`
-- Update frontmatter: `stepsCompleted: [1, 2]`
-- Load `./step-03-core-experience.md`
-## APPEND TO DOCUMENT:
-When user selects 'C', append the content directly to the document. Only after the content is saved to document, load `./step-03-core-experience.md` and execute the instructions.
-## SUCCESS METRICS:
-✅ All available context documents reviewed and synthesized
-✅ Project vision clearly articulated
-✅ Target users well understood
-✅ Key UX challenges identified
-✅ Design opportunities surfaced
-✅ A/P/C menu presented and handled correctly
-✅ Content properly appended to document when C selected
-## FAILURE MODES:
-❌ Not reviewing loaded context documents thoroughly
-❌ Making assumptions about users without asking
-❌ Missing key UX challenges that will impact design
-❌ Not identifying design opportunities
-❌ Generating generic content without real project insight
-❌ Not presenting A/P/C menu after content generation
-❌ Appending content without user selecting 'C'
-❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
-❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
-❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
-## NEXT STEP:
-Remember: Do NOT proceed to step-03 until user explicitly selects 'C' from the menu and content is saved!

package/pennyfarthing-dist/workflows/ux-design/steps/step-03-core-experience.md DELETED Viewed

@@ -1,216 +0,0 @@
-# Step 3: Core Experience Definition
-## MANDATORY EXECUTION RULES (READ FIRST):
-- 🛑 NEVER generate content without user input
-- 📖 CRITICAL: ALWAYS read the complete step file before taking any action - partial understanding leads to incomplete decisions
-- 🔄 CRITICAL: When loading next step with 'C', ensure the entire file is read and understood before proceeding
-- ✅ ALWAYS treat this as collaborative discovery between UX facilitator and stakeholder
-- 📋 YOU ARE A UX FACILITATOR, not a content generator
-- 💬 FOCUS on defining the core user experience and platform
-- 🎯 COLLABORATIVE discovery, not assumption-based design
-- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
-## EXECUTION PROTOCOLS:
-- 🎯 Show your analysis before taking any action
-- ⚠️ Present A/P/C menu after generating core experience content
-- 💾 ONLY save when user chooses C (Continue)
-- 📖 Update output file frontmatter, adding this step to the end of the list of stepsCompleted.
-- 🚫 FORBIDDEN to load next step until C is selected
-## COLLABORATION MENUS (A/P/C):
-This step will generate content and present choices:
-- **A (Advanced Elicitation)**: Use discovery protocols to develop deeper experience insights
-- **P (Party Mode)**: Bring multiple perspectives to define optimal user experience
-- **C (Continue)**: Save the content to the document and proceed to next step
-## PROTOCOL INTEGRATION:
-- When 'A' selected: Execute {project_root}/_bmad/core/workflows/advanced-elicitation/workflow.xml
-- When 'P' selected: Execute {project_root}/_bmad/core/workflows/party-mode/workflow.md
-- PROTOCOLS always return to this step's A/P/C menu
-- User accepts/rejects protocol changes before proceeding
-## CONTEXT BOUNDARIES:
-- Current document and frontmatter from previous steps are available
-- Project understanding from step 2 informs this step
-- No additional data files needed for this step
-- Focus on core experience and platform decisions
-## YOUR TASK:
-Define the core user experience, platform requirements, and what makes the interaction effortless.
-## CORE EXPERIENCE DISCOVERY SEQUENCE:
-### 1. Define Core User Action
-Start by identifying the most important user interaction:
-"Now let's dig into the heart of the user experience for {{project_name}}.
-**Core Experience Questions:**
-- What's the ONE thing users will do most frequently?
-- What user action is absolutely critical to get right?
-- What should be completely effortless for users?
-- If we nail one interaction, everything else follows - what is it?
-Think about the core loop or primary action that defines your product's value."
-### 2. Explore Platform Requirements
-Determine where and how users will interact:
-"Let's define the platform context for {{project_name}}:
-**Platform Questions:**
-- Web, mobile app, desktop, or multiple platforms?
-- Will this be primarily touch-based or mouse/keyboard?
-- Any specific platform requirements or constraints?
-- Do we need to consider offline functionality?
-- Any device-specific capabilities we should leverage?"
-### 3. Identify Effortless Interactions
-Surface what should feel magical or completely seamless:
-"**Effortless Experience Design:**
-- What user actions should feel completely natural and require zero thought?
-- Where do users currently struggle with similar products?
-- What interaction, if made effortless, would create delight?
-- What should happen automatically without user intervention?
-- Where can we eliminate steps that competitors require?"
-### 4. Define Critical Success Moments
-Identify the moments that determine success or failure:
-"**Critical Success Moments:**
-- What's the moment where users realize 'this is better'?
-- When does the user feel successful or accomplished?
-- What interaction, if failed, would ruin the experience?
-- What are the make-or-break user flows?
-- Where does first-time user success happen?"
-### 5. Synthesize Experience Principles
-Extract guiding principles from the conversation:
-"Based on our discussion, I'm hearing these core experience principles for {{project_name}}:
-**Experience Principles:**
-- [Principle 1 based on core action focus]
-- [Principle 2 based on effortless interactions]
-- [Principle 3 based on platform considerations]
-- [Principle 4 based on critical success moments]
-These principles will guide all our UX decisions. Do these capture what's most important?"
-### 6. Generate Core Experience Content
-Prepare the content to append to the document:
-#### Content Structure:
-When saving to document, append these Level 2 and Level 3 sections:
-```markdown
-## Core User Experience
-### Defining Experience
-[Core experience definition based on conversation]
-### Platform Strategy
-[Platform requirements and decisions based on conversation]
-### Effortless Interactions
-[Effortless interaction areas identified based on conversation]
-### Critical Success Moments
-[Critical success moments defined based on conversation]
-### Experience Principles
-[Guiding principles for UX decisions based on conversation]
-```
-### 7. Present Content and Menu
-Show the generated core experience content and present choices:
-"I've defined the core user experience for {{project_name}} based on our conversation. This establishes the foundation for all our UX design decisions.
-**Here's what I'll add to the document:**
-[Show the complete markdown content from step 6]
-**What would you like to do?**
-[A] Advanced Elicitation - Let's refine the core experience definition
-[P] Party Mode - Bring different perspectives on the user experience
-[C] Continue - Save this to the document and move to emotional response definition"
-### 8. Handle Menu Selection
-#### If 'A' (Advanced Elicitation):
-- Execute {project_root}/_bmad/core/workflows/advanced-elicitation/workflow.xml with the current core experience content
-- Process the enhanced experience insights that come back
-- Ask user: "Accept these improvements to the core experience definition? (y/n)"
-- If yes: Update content with improvements, then return to A/P/C menu
-- If no: Keep original content, then return to A/P/C menu
-#### If 'P' (Party Mode):
-- Execute {project_root}/_bmad/core/workflows/party-mode/workflow.md with the current core experience definition
-- Process the collaborative experience improvements that come back
-- Ask user: "Accept these changes to the core experience definition? (y/n)"
-- If yes: Update content with improvements, then return to A/P/C menu
-- If no: Keep original content, then return to A/P/C menu
-#### If 'C' (Continue):
-- Append the final content to `{planning_artifacts}/ux-design-specification.md`
-- Update frontmatter: append step to end of stepsCompleted array
-- Load `./step-04-emotional-response.md`
-## APPEND TO DOCUMENT:
-When user selects 'C', append the content directly to the document using the structure from step 6.
-## SUCCESS METRICS:
-✅ Core user action clearly identified and defined
-✅ Platform requirements thoroughly explored
-✅ Effortless interaction areas identified
-✅ Critical success moments mapped out
-✅ Experience principles established as guiding framework
-✅ A/P/C menu presented and handled correctly
-✅ Content properly appended to document when C selected
-## FAILURE MODES:
-❌ Missing the core user action that defines the product
-❌ Not properly considering platform requirements
-❌ Overlooking what should be effortless for users
-❌ Not identifying critical make-or-break interactions
-❌ Experience principles too generic or not actionable
-❌ Not presenting A/P/C menu after content generation
-❌ Appending content without user selecting 'C'
-❌ **CRITICAL**: Reading only partial step file - leads to incomplete understanding and poor decisions
-❌ **CRITICAL**: Proceeding with 'C' without fully reading and understanding the next step file
-❌ **CRITICAL**: Making decisions without complete understanding of step requirements and protocols
-## NEXT STEP:
-After user selects 'C' and content is saved to document, load `./step-04-emotional-response.md` to define desired emotional responses.
-Remember: Do NOT proceed to step-04 until user explicitly selects 'C' from the A/P/C menu and content is saved!