frappe-builder 1.1.0-dev.8

package/_bmad/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-13-report-complete.md

@@ -0,0 +1,232 @@
+---
+name: 'step-v-13-report-complete'
+description: 'Validation Report Complete - Finalize report, summarize findings, present to user, offer next steps'
+
+# File references (ONLY variables used in this step)
+validationReportPath: '{validation_report_path}'
+prdFile: '{prd_file_path}'
+---
+
+# Step 13: Validation Report Complete
+
+## STEP GOAL:
+
+Finalize validation report, summarize all findings from steps 1-12, present summary to user conversationally, and offer actionable next steps.
+
+## 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}`
+- ✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`
+
+### Role Reinforcement:
+
+- ✅ You are a Validation Architect and Quality Assurance 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 synthesis and summary expertise
+- ✅ This is the FINAL step - requires user interaction
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on summarizing findings and presenting options
+- 🚫 FORBIDDEN to perform additional validation
+- 💬 Approach: Conversational summary with clear next steps
+- 🚪 This is the final step - no next step after this
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Load complete validation report
+- 🎯 Summarize all findings from steps 1-12
+- 🎯 Update report frontmatter with final status
+- 💬 Present summary to user conversationally
+- 💬 Offer menu options for next actions
+- 🚫 FORBIDDEN to proceed without user selection
+
+## CONTEXT BOUNDARIES:
+
+- Available context: Complete validation report with findings from all validation steps
+- Focus: Summary and presentation only (no new validation)
+- Limits: Don't add new findings, just synthesize existing
+- Dependencies: Steps 1-12 completed - all validation checks done
+
+## MANDATORY SEQUENCE
+
+**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.
+
+### 1. Load Complete Validation Report
+
+Read the entire validation report from {validationReportPath}
+
+Extract all findings from:
+- Format Detection (Step 2)
+- Parity Analysis (Step 2B, if applicable)
+- Information Density (Step 3)
+- Product Brief Coverage (Step 4)
+- Measurability (Step 5)
+- Traceability (Step 6)
+- Implementation Leakage (Step 7)
+- Domain Compliance (Step 8)
+- Project-Type Compliance (Step 9)
+- SMART Requirements (Step 10)
+- Holistic Quality (Step 11)
+- Completeness (Step 12)
+
+### 2. Update Report Frontmatter with Final Status
+
+Update validation report frontmatter:
+
+```yaml
+---
+validationTarget: '{prd_path}'
+validationDate: '{current_date}'
+inputDocuments: [list of documents]
+validationStepsCompleted: ['step-v-01-discovery', 'step-v-02-format-detection', 'step-v-03-density-validation', 'step-v-04-brief-coverage-validation', 'step-v-05-measurability-validation', 'step-v-06-traceability-validation', 'step-v-07-implementation-leakage-validation', 'step-v-08-domain-compliance-validation', 'step-v-09-project-type-validation', 'step-v-10-smart-validation', 'step-v-11-holistic-quality-validation', 'step-v-12-completeness-validation']
+validationStatus: COMPLETE
+holisticQualityRating: '{rating from step 11}'
+overallStatus: '{Pass/Warning/Critical based on all findings}'
+---
+```
+
+### 3. Create Summary of Findings
+
+**Overall Status:**
+- Determine from all validation findings
+- **Pass:** All critical checks pass, minor warnings acceptable
+- **Warning:** Some issues found but PRD is usable
+- **Critical:** Major issues that prevent PRD from being fit for purpose
+
+**Quick Results Table:**
+- Format: [classification]
+- Information Density: [severity]
+- Measurability: [severity]
+- Traceability: [severity]
+- Implementation Leakage: [severity]
+- Domain Compliance: [status]
+- Project-Type Compliance: [compliance score]
+- SMART Quality: [percentage]
+- Holistic Quality: [rating/5]
+- Completeness: [percentage]
+
+**Critical Issues:** List from all validation steps
+**Warnings:** List from all validation steps
+**Strengths:** List positives from all validation steps
+
+**Holistic Quality Rating:** From step 11
+**Top 3 Improvements:** From step 11
+
+**Recommendation:** Based on overall status
+
+### 4. Present Summary to User Conversationally
+
+Display:
+
+"**✓ PRD Validation Complete**
+
+**Overall Status:** {Pass/Warning/Critical}
+
+**Quick Results:**
+{Present quick results table with key findings}
+
+**Critical Issues:** {count or "None"}
+{If any, list briefly}
+
+**Warnings:** {count or "None"}
+{If any, list briefly}
+
+**Strengths:**
+{List key strengths}
+
+**Holistic Quality:** {rating}/5 - {label}
+
+**Top 3 Improvements:**
+1. {Improvement 1}
+2. {Improvement 2}
+3. {Improvement 3}
+
+**Recommendation:**
+{Based on overall status:
+- Pass: "PRD is in good shape. Address minor improvements to make it great."
+- Warning: "PRD is usable but has issues that should be addressed. Review warnings and improve where needed."
+- Critical: "PRD has significant issues that should be fixed before use. Focus on critical issues above."}
+
+**What would you like to do next?**"
+
+### 5. Present MENU OPTIONS
+
+Display:
+
+**[R] Review Detailed Findings** - Walk through validation report section by section
+**[E] Use Edit Workflow** - Use validation report with Edit workflow for systematic improvements
+**[F] Fix Simpler Items** - Immediate fixes for simple issues (anti-patterns, leakage, missing headers)
+**[X] Exit** - Exit and Suggest Next Steps.
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input after presenting menu
+- Only proceed based on user selection
+
+#### Menu Handling Logic:
+
+- **IF R (Review Detailed Findings):**
+  - Walk through validation report section by section
+  - Present findings from each validation step
+  - Allow user to ask questions
+  - After review, return to menu
+
+- **IF E (Use Edit Workflow):**
+  - Explain: "The Edit workflow (steps-e/) can use this validation report to systematically address issues. Edit mode will guide you through discovering what to edit, reviewing the PRD, and applying targeted improvements."
+  - Offer: "Would you like to launch Edit mode now? It will help you fix validation findings systematically."
+  - If yes: Read fully and follow: `./steps-e/step-e-01-discovery.md`
+  - If no: Return to menu
+
+- **IF F (Fix Simpler Items):**
+  - Offer immediate fixes for:
+    - Template variables (fill in with appropriate content)
+    - Conversational filler (remove wordy phrases)
+    - Implementation leakage (remove technology names from FRs/NFRs)
+    - Missing section headers (add ## headers)
+  - Ask: "Which simple fixes would you like me to make?"
+  - If user specifies fixes, make them and update validation report
+  - Return to menu
+
+- **IF X (Exit):**
+  - Display: "**Validation Report Saved:** {validationReportPath}"
+  - Display: "**Summary:** {overall status} - {recommendation}"
+  - PRD Validation complete. Invoke the `bmad-help` skill.
+
+- **IF Any other:** Help user, then redisplay menu
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- Complete validation report loaded successfully
+- All findings from steps 1-12 summarized
+- Report frontmatter updated with final status
+- Overall status determined correctly (Pass/Warning/Critical)
+- Quick results table presented
+- Critical issues, warnings, and strengths listed
+- Holistic quality rating included
+- Top 3 improvements presented
+- Clear recommendation provided
+- Menu options presented with clear explanations
+- User can review findings, get help, or exit
+
+### ❌ SYSTEM FAILURE:
+
+- Not loading complete validation report
+- Missing summary of findings
+- Not updating report frontmatter
+- Not determining overall status
+- Missing menu options
+- Unclear next steps
+
+**Master Rule:** User needs clear summary and actionable next steps. Edit workflow is best for complex issues; immediate fixes available for simpler ones.

package/_bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-validate-prd.md

@@ -0,0 +1,65 @@
+---
+name: validate-prd
+description: 'Validate a PRD against standards. Use when the user says "validate this PRD" or "run PRD validation"'
+standalone: false
+main_config: '{project-root}/_bmad/bmm/config.yaml'
+validateWorkflow: './steps-v/step-v-01-discovery.md'
+---
+
+# PRD Validate Workflow
+
+**Goal:** Validate existing PRDs against BMAD standards through comprehensive review.
+
+**Your Role:** Validation Architect and Quality Assurance Specialist.
+
+You will continue to operate with your given name, identity, and communication_style, merged with the details of this role description.
+
+## WORKFLOW ARCHITECTURE
+
+This uses **step-file architecture** for disciplined execution:
+
+### Core Principles
+
+- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly
+- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so
+- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
+- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
+- **Append-Only Building**: Build documents by appending content as directed to the output file
+
+### Step Processing Rules
+
+1. **READ COMPLETELY**: Always read the entire step file before taking any action
+2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
+3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
+4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
+5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
+6. **LOAD NEXT**: When directed, read fully and follow the next step file
+
+### Critical Rules (NO EXCEPTIONS)
+
+- 🛑 **NEVER** load multiple step files simultaneously
+- 📖 **ALWAYS** read entire step file before execution
+- 🚫 **NEVER** skip steps or optimize the sequence
+- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
+- 🎯 **ALWAYS** follow the exact instructions in the step file
+- ⏸️ **ALWAYS** halt at menus and wait for user input
+- 📋 **NEVER** create mental todo lists from future steps
+
+## INITIALIZATION SEQUENCE
+
+### 1. Configuration Loading
+
+Load and read full config from {main_config} and resolve:
+
+- `project_name`, `output_folder`, `planning_artifacts`, `user_name`
+- `communication_language`, `document_output_language`, `user_skill_level`
+- `date` as system-generated current datetime
+
+✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the configured `{communication_language}`.
+✅ YOU MUST ALWAYS WRITE all artifact and document content in `{document_output_language}`.
+
+### 2. Route to Validate Workflow
+
+"**Validate Mode: Validating an existing PRD against BMAD standards.**"
+
+Then read fully and follow: `{validateWorkflow}` (steps-v/step-v-01-discovery.md)

package/_bmad/bmm/workflows/3-solutioning/bmad-check-implementation-readiness/SKILL.md

@@ -0,0 +1,6 @@
+---
+name: bmad-check-implementation-readiness
+description: 'Validate PRD, UX, Architecture and Epics specs are complete. Use when the user says "check implementation readiness".'
+---
+
+Follow the instructions in ./workflow.md.

package/_bmad/bmm/workflows/3-solutioning/bmad-check-implementation-readiness/bmad-skill-manifest.yaml

@@ -0,0 +1 @@
+type: skill

package/_bmad/bmm/workflows/3-solutioning/bmad-check-implementation-readiness/steps/step-01-document-discovery.md

@@ -0,0 +1,179 @@
+---
+outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
+---
+
+# Step 1: Document Discovery
+
+## STEP GOAL:
+
+To discover, inventory, and organize all project documents, identifying duplicates and determining which versions to use for the assessment.
+
+## 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 an expert Product Manager and Scrum Master
+- ✅ Your focus is on finding organizing and documenting what exists
+- ✅ You identify ambiguities and ask for clarification
+- ✅ Success is measured in clear file inventory and conflict resolution
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on finding and organizing files
+- 🚫 Don't read or analyze file contents
+- 💬 Identify duplicate documents clearly
+- 🚪 Get user confirmation on file selections
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Search for all document types systematically
+- 💾 Group sharded files together
+- 📖 Flag duplicates for user resolution
+- 🚫 FORBIDDEN to proceed with unresolved duplicates
+
+## DOCUMENT DISCOVERY PROCESS:
+
+### 1. Initialize Document Discovery
+
+"Beginning **Document Discovery** to inventory all project files.
+
+I will:
+
+1. Search for all required documents (PRD, Architecture, Epics, UX)
+2. Group sharded documents together
+3. Identify any duplicates (whole + sharded versions)
+4. Present findings for your confirmation"
+
+### 2. Document Search Patterns
+
+Search for each document type using these patterns:
+
+#### A. PRD Documents
+
+- Whole: `{planning_artifacts}/*prd*.md`
+- Sharded: `{planning_artifacts}/*prd*/index.md` and related files
+
+#### B. Architecture Documents
+
+- Whole: `{planning_artifacts}/*architecture*.md`
+- Sharded: `{planning_artifacts}/*architecture*/index.md` and related files
+
+#### C. Epics & Stories Documents
+
+- Whole: `{planning_artifacts}/*epic*.md`
+- Sharded: `{planning_artifacts}/*epic*/index.md` and related files
+
+#### D. UX Design Documents
+
+- Whole: `{planning_artifacts}/*ux*.md`
+- Sharded: `{planning_artifacts}/*ux*/index.md` and related files
+
+### 3. Organize Findings
+
+For each document type found:
+
+```
+## [Document Type] Files Found
+
+**Whole Documents:**
+- [filename.md] ([size], [modified date])
+
+**Sharded Documents:**
+- Folder: [foldername]/
+  - index.md
+  - [other files in folder]
+```
+
+### 4. Identify Critical Issues
+
+#### Duplicates (CRITICAL)
+
+If both whole and sharded versions exist:
+
+```
+⚠️ CRITICAL ISSUE: Duplicate document formats found
+- PRD exists as both whole.md AND prd/ folder
+- YOU MUST choose which version to use
+- Remove or rename the other version to avoid confusion
+```
+
+#### Missing Documents (WARNING)
+
+If required documents not found:
+
+```
+⚠️ WARNING: Required document not found
+- Architecture document not found
+- Will impact assessment completeness
+```
+
+### 5. Add Initial Report Section
+
+Initialize {outputFile} with ../templates/readiness-report-template.md.
+
+### 6. Present Findings and Get Confirmation
+
+Display findings and ask:
+"**Document Discovery Complete**
+
+[Show organized file list]
+
+**Issues Found:**
+
+- [List any duplicates requiring resolution]
+- [List any missing documents]
+
+**Required Actions:**
+
+- If duplicates exist: Please remove/rename one version
+- Confirm which documents to use for assessment
+
+**Ready to proceed?** [C] Continue after resolving issues"
+
+### 7. Present MENU OPTIONS
+
+Display: **Select an Option:** [C] Continue to File Validation
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input after presenting menu
+- ONLY proceed with 'C' selection
+- If duplicates identified, insist on resolution first
+- User can clarify file locations or request additional searches
+
+#### Menu Handling Logic:
+
+- IF C: Save document inventory to {outputFile}, update frontmatter with completed step and files being included, and then read fully and follow: ./step-02-prd-analysis.md
+- IF Any other comments or queries: help user respond then redisplay menu
+
+## CRITICAL STEP COMPLETION NOTE
+
+ONLY WHEN C is selected and document inventory is saved will you load ./step-02-prd-analysis.md to begin file validation.
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- All document types searched systematically
+- Files organized and inventoried clearly
+- Duplicates identified and flagged for resolution
+- User confirmed file selections
+
+### ❌ SYSTEM FAILURE:
+
+- Not searching all document types
+- Ignoring duplicate document conflicts
+- Proceeding without resolving critical issues
+- Not saving document inventory
+
+**Master Rule:** Clear file identification is essential for accurate assessment.

package/_bmad/bmm/workflows/3-solutioning/bmad-check-implementation-readiness/steps/step-02-prd-analysis.md

@@ -0,0 +1,168 @@
+---
+outputFile: '{planning_artifacts}/implementation-readiness-report-{{date}}.md'
+epicsFile: '{planning_artifacts}/*epic*.md' # Will be resolved to actual file
+---
+
+# Step 2: PRD Analysis
+
+## STEP GOAL:
+
+To fully read and analyze the PRD document (whole or sharded) to extract all Functional Requirements (FRs) and Non-Functional Requirements (NFRs) for validation against epics coverage.
+
+## 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 an expert Product Manager and Scrum Master
+- ✅ Your expertise is in requirements analysis and traceability
+- ✅ You think critically about requirement completeness
+- ✅ Success is measured in thorough requirement extraction
+
+### Step-Specific Rules:
+
+- 🎯 Focus ONLY on reading and extracting from PRD
+- 🚫 Don't validate files (done in step 1)
+- 💬 Read PRD completely - whole or all sharded files
+- 🚪 Extract every FR and NFR with numbering
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Load and completely read the PRD
+- 💾 Extract all requirements systematically
+- 📖 Document findings in the report
+- 🚫 FORBIDDEN to skip or summarize PRD content
+
+## PRD ANALYSIS PROCESS:
+
+### 1. Initialize PRD Analysis
+
+"Beginning **PRD Analysis** to extract all requirements.
+
+I will:
+
+1. Load the PRD document (whole or sharded)
+2. Read it completely and thoroughly
+3. Extract ALL Functional Requirements (FRs)
+4. Extract ALL Non-Functional Requirements (NFRs)
+5. Document findings for coverage validation"
+
+### 2. Load and Read PRD
+
+From the document inventory in step 1:
+
+- If whole PRD file exists: Load and read it completely
+- If sharded PRD exists: Load and read ALL files in the PRD folder
+- Ensure complete coverage - no files skipped
+
+### 3. Extract Functional Requirements (FRs)
+
+Search for and extract:
+
+- Numbered FRs (FR1, FR2, FR3, etc.)
+- Requirements labeled "Functional Requirement"
+- User stories or use cases that represent functional needs
+- Business rules that must be implemented
+
+Format findings as:
+
+```
+## Functional Requirements Extracted
+
+FR1: [Complete requirement text]
+FR2: [Complete requirement text]
+FR3: [Complete requirement text]
+...
+Total FRs: [count]
+```
+
+### 4. Extract Non-Functional Requirements (NFRs)
+
+Search for and extract:
+
+- Performance requirements (response times, throughput)
+- Security requirements (authentication, encryption, etc.)
+- Usability requirements (accessibility, ease of use)
+- Reliability requirements (uptime, error rates)
+- Scalability requirements (concurrent users, data growth)
+- Compliance requirements (standards, regulations)
+
+Format findings as:
+
+```
+## Non-Functional Requirements Extracted
+
+NFR1: [Performance requirement]
+NFR2: [Security requirement]
+NFR3: [Usability requirement]
+...
+Total NFRs: [count]
+```
+
+### 5. Document Additional Requirements
+
+Look for:
+
+- Constraints or assumptions
+- Technical requirements not labeled as FR/NFR
+- Business constraints
+- Integration requirements
+
+### 6. Add to Assessment Report
+
+Append to {outputFile}:
+
+```markdown
+## PRD Analysis
+
+### Functional Requirements
+
+[Complete FR list from section 3]
+
+### Non-Functional Requirements
+
+[Complete NFR list from section 4]
+
+### Additional Requirements
+
+[Any other requirements or constraints found]
+
+### PRD Completeness Assessment
+
+[Initial assessment of PRD completeness and clarity]
+```
+
+### 7. Auto-Proceed to Next Step
+
+After PRD analysis complete, immediately load next step for epic coverage validation.
+
+## PROCEEDING TO EPIC COVERAGE VALIDATION
+
+PRD analysis complete. Read fully and follow: `./step-03-epic-coverage-validation.md`
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- PRD loaded and read completely
+- All FRs extracted with full text
+- All NFRs identified and documented
+- Findings added to assessment report
+
+### ❌ SYSTEM FAILURE:
+
+- Not reading complete PRD (especially sharded versions)
+- Missing requirements in extraction
+- Summarizing instead of extracting full text
+- Not documenting findings in report
+
+**Master Rule:** Complete requirement extraction is essential for traceability validation.