npm - create-byan-agent - Versions diffs - 2.1.0 → 2.1.1 - Mend

create-byan-agent 2.1.0 → 2.1.1

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 (751) hide show

package/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-11-polish.md DELETED Viewed

@@ -1,217 +0,0 @@
----
-name: 'step-11-polish'
-description: 'Optimize and polish the complete PRD document for flow, coherence, and readability'
-# File References
-nextStepFile: './step-12-complete.md'
-outputFile: '{planning_artifacts}/prd.md'
-purposeFile: '../data/prd-purpose.md'
-# Task References
-advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
-partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
----
-# Step 11: Document Polish
-**Progress: Step 11 of 12** - Next: Complete PRD
-## MANDATORY EXECUTION RULES (READ FIRST):
-- 🛑 CRITICAL: Load the ENTIRE document before making changes
-- 📖 CRITICAL: Read complete step file before taking action
-- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
-- ✅ This is a POLISH step - optimize existing content
-- 📋 IMPROVE flow, coherence, and readability
-- 💬 PRESERVE user's voice and intent
-- 🎯 MAINTAIN all essential information while improving presentation
-- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
-## EXECUTION PROTOCOLS:
-- 🎯 Load complete document first
-- 📝 Review for flow and coherence issues
-- ✂️ Reduce duplication while preserving essential info
-- 📖 Ensure proper ## Level 2 headers throughout
-- 💾 Save optimized document
-- ⚠️ Present A/P/C menu after polish
-- 🚫 DO NOT skip review steps
-## CONTEXT BOUNDARIES:
-- Complete PRD document exists from all previous steps
-- Document may have duplication from progressive append
-- Sections may not flow smoothly together
-- Level 2 headers ensure document can be split if needed
-- Focus on readability and coherence
-## YOUR TASK:
-Optimize the complete PRD document for flow, coherence, and professional presentation while preserving all essential information.
-## DOCUMENT POLISH SEQUENCE:
-### 1. Load Context and Document
-**CRITICAL:** Load the PRD purpose document first:
-- Read `{purposeFile}` to understand what makes a great BMAD PRD
-- Internalize the philosophy: information density, traceability, measurable requirements
-- Keep the dual-audience nature (humans + LLMs) in mind
-**Then Load the PRD Document:**
-- Read `{outputFile}` completely from start to finish
-- Understand the full document structure and content
-- Identify all sections and their relationships
-- Note areas that need attention
-### 2. Document Quality Review
-Review the entire document with PRD purpose principles in mind:
-**Information Density:**
-- Are there wordy phrases that can be condensed?
-- Is conversational padding present?
-- Can sentences be more direct and concise?
-**Flow and Coherence:**
-- Do sections transition smoothly?
-- Are there jarring topic shifts?
-- Does the document tell a cohesive story?
-- Is the progression logical for readers?
-**Duplication Detection:**
-- Are ideas repeated across sections?
-- Is the same information stated multiple times?
-- Can redundant content be consolidated?
-- Are there contradictory statements?
-**Header Structure:**
-- Are all main sections using ## Level 2 headers?
-- Is the hierarchy consistent (##, ###, ####)?
-- Can sections be easily extracted or referenced?
-- Are headers descriptive and clear?
-**Readability:**
-- Are sentences clear and concise?
-- Is the language consistent throughout?
-- Are technical terms used appropriately?
-- Would stakeholders find this easy to understand?
-### 3. Optimization Actions
-Make targeted improvements:
-**Improve Flow:**
-- Add transition sentences between sections
-- Smooth out jarring topic shifts
-- Ensure logical progression
-- Connect related concepts across sections
-**Reduce Duplication:**
-- Consolidate repeated information
-- Keep content in the most appropriate section
-- Use cross-references instead of repetition
-- Remove redundant explanations
-**Enhance Coherence:**
-- Ensure consistent terminology throughout
-- Align all sections with product differentiator
-- Maintain consistent voice and tone
-- Verify scope consistency across sections
-**Optimize Headers:**
-- Ensure all main sections use ## Level 2
-- Make headers descriptive and action-oriented
-- Check that headers follow consistent patterns
-- Verify headers support document navigation
-### 4. Preserve Critical Information
-**While optimizing, ensure NOTHING essential is lost:**
-**Must Preserve:**
-- All user success criteria
-- All functional requirements (capability contract)
-- All user journey narratives
-- All scope decisions (MVP, Growth, Vision)
-- All non-functional requirements
-- Product differentiator and vision
-- Domain-specific requirements
-- Innovation analysis (if present)
-**Can Consolidate:**
-- Repeated explanations of the same concept
-- Redundant background information
-- Multiple versions of similar content
-- Overlapping examples
-### 5. Generate Optimized Document
-Create the polished version:
-**Polishing Process:**
-1. Start with original document
-2. Apply all optimization actions
-3. Review to ensure nothing essential was lost
-4. Verify improvements enhance readability
-5. Prepare optimized version for review
-### 6. Present MENU OPTIONS
-Present the polished document for review, then display menu:
-- Show what changed in the polish
-- Highlight improvements made (flow, duplication, headers)
-- Ask if they'd like to refine further, get other perspectives, or proceed
-- Present menu options naturally as part of conversation
-Display: "**Select:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Complete PRD (Step 12 of 12)"
-#### Menu Handling Logic:
-- IF A: Read fully and follow: {advancedElicitationTask} with the polished document, process the enhanced refinements that come back, ask user "Accept these polish improvements? (y/n)", if yes update content with improvements then redisplay menu, if no keep original polish then redisplay menu
-- IF P: Read fully and follow: {partyModeWorkflow} with the polished document, process the collaborative refinements to flow and coherence, ask user "Accept these polish changes? (y/n)", if yes update content with improvements then redisplay menu, if no keep original polish then redisplay menu
-- IF C: Save the polished document to {outputFile}, update frontmatter by adding this step name to the end of the stepsCompleted array, then read fully and follow: {nextStepFile}
-- IF Any other: help user respond, then redisplay menu
-#### 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
-## APPEND TO DOCUMENT:
-When user selects 'C', replace the entire document content with the polished version.
-## SUCCESS METRICS:
-✅ Complete document loaded and reviewed
-✅ Flow and coherence improved
-✅ Duplication reduced while preserving essential information
-✅ All main sections use ## Level 2 headers
-✅ Transitions between sections are smooth
-✅ User's voice and intent preserved
-✅ Document is more readable and professional
-✅ A/P/C menu presented and handled correctly
-✅ Polished document saved when C selected
-## FAILURE MODES:
-❌ Loading only partial document (leads to incomplete polish)
-❌ Removing essential information while reducing duplication
-❌ Not preserving user's voice and intent
-❌ Changing content instead of improving presentation
-❌ Not ensuring ## Level 2 headers for main sections
-❌ Making arbitrary style changes instead of coherence improvements
-❌ Not presenting A/P/C menu for user approval
-❌ Saving polished document 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 changes without complete understanding of document requirements
-## NEXT STEP:
-After user selects 'C' and polished document is saved, load `./step-12-complete.md` to complete the workflow.
-Remember: Do NOT proceed to step-12 until user explicitly selects 'C' from the A/P/C menu and polished document is saved!

package/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-12-complete.md DELETED Viewed

@@ -1,124 +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
-PRD complete. Read fully and follow: `_bmad/core/tasks/bmad-help.md` with argument `Create PRD`.
-### 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
-## 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/_bmad/bmm/workflows/2-plan-workflows/create-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}/_bmad/bmm/workflows/2-plan-workflows/create-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...**"
-Read fully and follow: 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): Read fully and follow: {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.