@pennyfarthing/core 7.0.2 → 7.4.1

package/pennyfarthing-dist/workflows/research/steps-technical/step-06-research-synthesis.md

@@ -0,0 +1,486 @@
+# Technical Research Step 5: Technical Synthesis and Completion
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+- 🛑 NEVER generate content without web search verification
+
+- 📖 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
+- ✅ Search the web to verify and supplement your knowledge with current facts
+- 📋 YOU ARE A TECHNICAL RESEARCH STRATEGIST, not content generator
+- 💬 FOCUS on comprehensive technical synthesis and authoritative conclusions
+- 🔍 WEB SEARCH REQUIRED - verify current facts against live sources
+- 📄 PRODUCE COMPREHENSIVE DOCUMENT with narrative intro, TOC, and summary
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Show web search analysis before presenting findings
+- ⚠️ Present [C] complete option after synthesis content generation
+- 💾 ONLY save when user chooses C (Complete)
+- 📖 Update frontmatter `stepsCompleted: [1, 2, 3, 4, 5]` before completing workflow
+- 🚫 FORBIDDEN to complete workflow until C is selected
+- 📚 GENERATE COMPLETE DOCUMENT STRUCTURE with intro, TOC, and summary
+
+## CONTEXT BOUNDARIES:
+
+- Current document and frontmatter from previous steps are available
+- **Research topic = "{{research_topic}}"** - comprehensive technical analysis
+- **Research goals = "{{research_goals}}"** - achieved through exhaustive technical research
+- All technical research sections have been completed (overview, architecture, implementation)
+- Web search capabilities with source verification are enabled
+- This is the final synthesis step producing the complete technical research document
+
+## YOUR TASK:
+
+Produce a comprehensive, authoritative technical research document on **{{research_topic}}** with compelling narrative introduction, detailed TOC, and executive summary based on exhaustive technical research.
+
+## COMPREHENSIVE TECHNICAL DOCUMENT SYNTHESIS:
+
+### 1. Technical Document Structure Planning
+
+**Complete Technical Research Document Structure:**
+
+```markdown
+# [Compelling Technical Title]: Comprehensive {{research_topic}} Technical Research
+
+## Executive Summary
+
+[Brief compelling overview of key technical findings and strategic implications]
+
+## Table of Contents
+
+- Technical Research Introduction and Methodology
+- Technical Landscape and Architecture Analysis
+- Implementation Approaches and Best Practices
+- Technology Stack Evolution and Trends
+- Integration and Interoperability Patterns
+- Performance and Scalability Analysis
+- Security and Compliance Considerations
+- Strategic Technical Recommendations
+- Implementation Roadmap and Risk Assessment
+- Future Technical Outlook and Innovation Opportunities
+- Technical Research Methodology and Source Documentation
+- Technical Appendices and Reference Materials
+```
+
+### 2. Generate Compelling Technical Introduction
+
+**Technical Introduction Requirements:**
+
+- Hook reader with compelling technical opening about {{research_topic}}
+- Establish technical research significance and current relevance
+- Outline comprehensive technical research methodology
+- Preview key technical findings and strategic implications
+- Set authoritative, technical expert tone
+
+**Web Search for Technical Introduction Context:**
+Search the web: "{{research_topic}} technical significance importance"
+
+### 3. Synthesize All Technical Research Sections
+
+**Technical Section-by-Section Integration:**
+
+- Combine technical overview from step-02
+- Integrate architectural patterns from step-03
+- Incorporate implementation research from step-04
+- Add cross-technical insights and connections
+- Ensure comprehensive technical coverage with no gaps
+
+### 4. Generate Complete Technical Document Content
+
+#### Final Technical Document Structure:
+
+```markdown
+# [Compelling Title]: Comprehensive {{research_topic}} Technical Research
+
+## Executive Summary
+
+[2-3 paragraph compelling summary of the most critical technical findings and strategic implications for {{research_topic}} based on comprehensive current technical research]
+
+**Key Technical Findings:**
+
+- [Most significant architectural insights]
+- [Critical implementation considerations]
+- [Important technology trends]
+- [Strategic technical implications]
+
+**Technical Recommendations:**
+
+- [Top 3-5 actionable technical recommendations based on research]
+
+## Table of Contents
+
+1. Technical Research Introduction and Methodology
+2. {{research_topic}} Technical Landscape and Architecture Analysis
+3. Implementation Approaches and Best Practices
+4. Technology Stack Evolution and Current Trends
+5. Integration and Interoperability Patterns
+6. Performance and Scalability Analysis
+7. Security and Compliance Considerations
+8. Strategic Technical Recommendations
+9. Implementation Roadmap and Risk Assessment
+10. Future Technical Outlook and Innovation Opportunities
+11. Technical Research Methodology and Source Verification
+12. Technical Appendices and Reference Materials
+
+## 1. Technical Research Introduction and Methodology
+
+### Technical Research Significance
+
+[Compelling technical narrative about why {{research_topic}} research is critical right now]
+_Technical Importance: [Strategic technical significance with current context]_
+_Business Impact: [Business implications of technical research]_
+_Source: [URL]_
+
+### Technical Research Methodology
+
+[Comprehensive description of technical research approach including:]
+
+- **Technical Scope**: [Comprehensive technical coverage areas]
+- **Data Sources**: [Authoritative technical sources and verification approach]
+- **Analysis Framework**: [Structured technical analysis methodology]
+- **Time Period**: [current focus and technical evolution context]
+- **Technical Depth**: [Level of technical detail and analysis]
+
+### Technical Research Goals and Objectives
+
+**Original Technical Goals:** {{research_goals}}
+
+**Achieved Technical Objectives:**
+
+- [Technical Goal 1 achievement with supporting evidence]
+- [Technical Goal 2 achievement with supporting evidence]
+- [Additional technical insights discovered during research]
+
+## 2. {{research_topic}} Technical Landscape and Architecture Analysis
+
+### Current Technical Architecture Patterns
+
+[Comprehensive architectural analysis synthesized from step-03 with current context]
+_Dominant Patterns: [Current architectural approaches]_
+_Architectural Evolution: [Historical and current evolution patterns]_
+_Architectural Trade-offs: [Key architectural decisions and implications]_
+_Source: [URL]_
+
+### System Design Principles and Best Practices
+
+[Complete system design analysis]
+_Design Principles: [Core principles guiding {{research_topic}} implementations]_
+_Best Practice Patterns: [Industry-standard approaches and methodologies]_
+_Architectural Quality Attributes: [Performance, scalability, maintainability considerations]_
+_Source: [URL]_
+
+## 3. Implementation Approaches and Best Practices
+
+### Current Implementation Methodologies
+
+[Implementation analysis from step-04 with current context]
+_Development Approaches: [Current development methodologies and approaches]_
+_Code Organization Patterns: [Structural patterns and organization strategies]_
+_Quality Assurance Practices: [Testing, validation, and quality approaches]_
+_Deployment Strategies: [Current deployment and operations practices]_
+_Source: [URL]_
+
+### Implementation Framework and Tooling
+
+[Comprehensive implementation framework analysis]
+_Development Frameworks: [Popular frameworks and their characteristics]_
+_Tool Ecosystem: [Development tools and platform considerations]_
+_Build and Deployment Systems: [CI/CD and automation approaches]_
+_Source: [URL]_
+
+## 4. Technology Stack Evolution and Current Trends
+
+### Current Technology Stack Landscape
+
+[Technology stack analysis from step-02 with current updates]
+_Programming Languages: [Current language trends and adoption patterns]_
+_Frameworks and Libraries: [Popular frameworks and their use cases]_
+_Database and Storage Technologies: [Current data storage and management trends]_
+_API and Communication Technologies: [Integration and communication patterns]_
+_Source: [URL]_
+
+### Technology Adoption Patterns
+
+[Comprehensive technology adoption analysis]
+_Adoption Trends: [Technology adoption rates and patterns]_
+_Migration Patterns: [Technology migration and evolution trends]_
+_Emerging Technologies: [New technologies and their potential impact]_
+_Source: [URL]_
+
+## 5. Integration and Interoperability Patterns
+
+### Current Integration Approaches
+
+[Integration patterns analysis with current context]
+_API Design Patterns: [Current API design and implementation patterns]_
+_Service Integration: [Microservices and service integration approaches]_
+_Data Integration: [Data exchange and integration patterns]_
+_Source: [URL]_
+
+### Interoperability Standards and Protocols
+
+[Comprehensive interoperability analysis]
+_Standards Compliance: [Industry standards and compliance requirements]_
+_Protocol Selection: [Communication protocols and selection criteria]_
+_Integration Challenges: [Common integration challenges and solutions]_
+_Source: [URL]_
+
+## 6. Performance and Scalability Analysis
+
+### Performance Characteristics and Optimization
+
+[Performance analysis based on research findings]
+_Performance Benchmarks: [Current performance characteristics and benchmarks]_
+_Optimization Strategies: [Performance optimization approaches and techniques]_
+_Monitoring and Measurement: [Performance monitoring and measurement practices]_
+_Source: [URL]_
+
+### Scalability Patterns and Approaches
+
+[Comprehensive scalability analysis]
+_Scalability Patterns: [Architectural and design patterns for scalability]_
+_Capacity Planning: [Capacity planning and resource management approaches]_
+_Elasticity and Auto-scaling: [Dynamic scaling approaches and implementations]_
+_Source: [URL]_
+
+## 7. Security and Compliance Considerations
+
+### Security Best Practices and Frameworks
+
+[Security analysis with current context]
+_Security Frameworks: [Current security frameworks and best practices]_
+_Threat Landscape: [Current security threats and mitigation approaches]_
+_Secure Development Practices: [Secure coding and development lifecycle]_
+_Source: [URL]_
+
+### Compliance and Regulatory Considerations
+
+[Comprehensive compliance analysis]
+_Industry Standards: [Relevant industry standards and compliance requirements]_
+_Regulatory Compliance: [Legal and regulatory considerations for {{research_topic}}]_
+_Audit and Governance: [Technical audit and governance practices]_
+_Source: [URL]_
+
+## 8. Strategic Technical Recommendations
+
+### Technical Strategy and Decision Framework
+
+[Strategic technical recommendations based on comprehensive research]
+_Architecture Recommendations: [Recommended architectural approaches and patterns]_
+_Technology Selection: [Recommended technology stack and selection criteria]_
+_Implementation Strategy: [Recommended implementation approaches and methodologies]_
+_Source: [URL]_
+
+### Competitive Technical Advantage
+
+[Analysis of technical competitive positioning]
+_Technology Differentiation: [Technical approaches that provide competitive advantage]_
+_Innovation Opportunities: [Areas for technical innovation and differentiation]_
+_Strategic Technology Investments: [Recommended technology investments and priorities]_
+_Source: [URL]_
+
+## 9. Implementation Roadmap and Risk Assessment
+
+### Technical Implementation Framework
+
+[Comprehensive implementation guidance based on research findings]
+_Implementation Phases: [Recommended phased implementation approach]_
+_Technology Migration Strategy: [Approach for technology adoption and migration]_
+_Resource Planning: [Technical resources and capabilities planning]_
+_Source: [URL]_
+
+### Technical Risk Management
+
+[Comprehensive technical risk assessment]
+_Technical Risks: [Major technical risks and mitigation strategies]_
+_Implementation Risks: [Risks associated with implementation and deployment]_
+_Business Impact Risks: [Technical risks and their business implications]_
+_Source: [URL]_
+
+## 10. Future Technical Outlook and Innovation Opportunities
+
+### Emerging Technology Trends
+
+[Forward-looking technical analysis based on comprehensive research]
+_Near-term Technical Evolution: [1-2 year technical development expectations]_
+_Medium-term Technology Trends: [3-5 year expected technical developments]_
+_Long-term Technical Vision: [5+ year technical outlook for {{research_topic}}]_
+_Source: [URL]_
+
+### Innovation and Research Opportunities
+
+[Technical innovation analysis and recommendations]
+_Research Opportunities: [Areas for technical research and innovation]_
+_Emerging Technology Adoption: [Potential new technologies and adoption timelines]_
+_Innovation Framework: [Approach for fostering technical innovation]_
+_Source: [URL]_
+
+## 11. Technical Research Methodology and Source Verification
+
+### Comprehensive Technical Source Documentation
+
+[Complete documentation of all technical research sources]
+_Primary Technical Sources: [Key authoritative technical sources used]_
+_Secondary Technical Sources: [Supporting technical research and analysis]_
+_Technical Web Search Queries: [Complete list of technical search queries used]_
+
+### Technical Research Quality Assurance
+
+[Technical quality assurance and validation approach]
+_Technical Source Verification: [All technical claims verified with multiple sources]_
+_Technical Confidence Levels: [Confidence assessments for uncertain technical data]_
+_Technical Limitations: [Technical research limitations and areas for further investigation]_
+_Methodology Transparency: [Complete transparency about technical research approach]_
+
+## 12. Technical Appendices and Reference Materials
+
+### Detailed Technical Data Tables
+
+[Comprehensive technical data tables supporting research findings]
+_Architectural Pattern Tables: [Detailed architectural pattern comparisons]_
+_Technology Stack Analysis: [Detailed technology evaluation and comparison data]_
+_Performance Benchmark Data: [Comprehensive performance measurement data]_
+
+### Technical Resources and References
+
+[Valuable technical resources for continued research and implementation]
+_Technical Standards: [Relevant technical standards and specifications]_
+_Open Source Projects: [Key open source projects and communities]_
+_Research Papers and Publications: [Academic and industry research sources]_
+_Technical Communities: [Professional networks and technical communities]_
+
+---
+
+## Technical Research Conclusion
+
+### Summary of Key Technical Findings
+
+[Comprehensive summary of the most important technical research findings]
+
+### Strategic Technical Impact Assessment
+
+[Assessment of technical implications for {{research_topic}}]
+
+### Next Steps Technical Recommendations
+
+[Specific next steps for leveraging this technical research]
+
+---
+
+**Technical Research Completion Date:** {{date}}
+**Research Period:** current comprehensive technical analysis
+**Document Length:** As needed for comprehensive technical coverage
+**Source Verification:** All technical facts cited with current sources
+**Technical Confidence Level:** High - based on multiple authoritative technical sources
+
+_This comprehensive technical research document serves as an authoritative technical reference on {{research_topic}} and provides strategic technical insights for informed decision-making and implementation._
+```
+
+### 5. Present Complete Technical Document and Final Option
+
+**Technical Document Completion Presentation:**
+
+"I've completed the **comprehensive technical research document synthesis** for **{{research_topic}}**, producing an authoritative technical research document with:
+
+**Technical Document Features:**
+
+- **Compelling Technical Introduction**: Engaging technical opening that establishes research significance
+- **Comprehensive Technical TOC**: Complete navigation structure for technical reference
+- **Exhaustive Technical Research Coverage**: All technical aspects of {{research_topic}} thoroughly analyzed
+- **Executive Technical Summary**: Key technical findings and strategic implications highlighted
+- **Strategic Technical Recommendations**: Actionable technical insights based on comprehensive research
+- **Complete Technical Source Citations**: Every technical claim verified with current sources
+
+**Technical Research Completeness:**
+
+- Technical landscape and architecture analysis fully documented
+- Implementation approaches and best practices comprehensively covered
+- Technology stack evolution and trends detailed
+- Integration, performance, and security analysis complete
+- Strategic technical insights and implementation guidance provided
+
+**Technical Document Standards Met:**
+
+- Exhaustive technical research with no critical gaps
+- Professional technical structure and compelling narrative
+- As long as needed for comprehensive technical coverage
+- Multiple independent technical sources for all claims
+- current technical data throughout with proper citations
+
+**Ready to complete this comprehensive technical research document?**
+[C] Complete Research - Save final comprehensive technical document
+
+### 6. Handle Final Technical Completion
+
+#### If 'C' (Complete Research):
+
+- Append the complete technical document to the research file
+- Update frontmatter: `stepsCompleted: [1, 2, 3, 4, 5]`
+- Complete the technical research workflow
+- Provide final technical document delivery confirmation
+
+## APPEND TO DOCUMENT:
+
+When user selects 'C', append the complete comprehensive technical research document using the full structure above.
+
+## SUCCESS METRICS:
+
+✅ Compelling technical introduction with research significance
+✅ Comprehensive technical table of contents with complete document structure
+✅ Exhaustive technical research coverage across all technical aspects
+✅ Executive technical summary with key findings and strategic implications
+✅ Strategic technical recommendations grounded in comprehensive research
+✅ Complete technical source verification with current citations
+✅ Professional technical document structure and compelling narrative
+✅ [C] complete option presented and handled correctly
+✅ Technical research workflow completed with comprehensive document
+
+## FAILURE MODES:
+
+❌ Not producing compelling technical introduction
+❌ Missing comprehensive technical table of contents
+❌ Incomplete technical research coverage across technical aspects
+❌ Not providing executive technical summary with key findings
+❌ Missing strategic technical recommendations based on research
+❌ Relying solely on training data without web verification for current facts
+❌ Producing technical document without professional structure
+❌ Not presenting completion option for final technical document
+
+❌ **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
+
+## COMPREHENSIVE TECHNICAL DOCUMENT STANDARDS:
+
+This step ensures the final technical research document:
+
+- Serves as an authoritative technical reference on {{research_topic}}
+- Provides strategic technical insights for informed decision-making
+- Includes comprehensive technical coverage with no gaps
+- Maintains rigorous technical source verification standards
+- Delivers strategic technical insights and actionable recommendations
+- Meets professional technical research document quality standards
+
+## TECHNICAL RESEARCH WORKFLOW COMPLETION:
+
+When 'C' is selected:
+
+- All technical research steps completed (1-5)
+- Comprehensive technical research document generated
+- Professional technical document structure with intro, TOC, and summary
+- All technical sections appended with source citations
+- Technical research workflow status updated to complete
+- Final comprehensive technical research document delivered to user
+
+## FINAL TECHNICAL DELIVERABLE:
+
+Complete authoritative technical research document on {{research_topic}} that:
+
+- Establishes technical credibility through comprehensive research
+- Provides strategic technical insights for informed decision-making
+- Serves as technical reference document for continued use
+- Maintains highest technical research quality standards with current verification
+
+Congratulations on completing comprehensive technical research with professional documentation! 🎉

package/pennyfarthing-dist/workflows/research/templates/research.template.md

@@ -0,0 +1,29 @@
+---
+stepsCompleted: []
+inputDocuments: []
+workflowType: 'research'
+lastStep: 1
+research_type: '{{research_type}}'
+research_topic: '{{research_topic}}'
+research_goals: '{{research_goals}}'
+user_name: '{{user_name}}'
+date: '{{date}}'
+web_research_enabled: true
+source_verification: true
+---
+
+# Research Report: {{research_type}}
+
+**Date:** {{date}}
+**Author:** {{user_name}}
+**Research Type:** {{research_type}}
+
+---
+
+## Research Overview
+
+[Research overview and methodology will be appended here]
+
+---
+
+<!-- Content will be appended sequentially through research workflow steps -->

package/pennyfarthing-dist/workflows/research/workflow.yaml

@@ -0,0 +1,45 @@
+# research Workflow - Migrated from BMAD format
+# Generated manually (routing-based modes)
+# Story: MSSCI-12135
+
+workflow:
+  name: research
+  description: Conduct comprehensive research across multiple domains using current web data and verified sources - Market, Technical, Domain research types.
+  version: "1.0.0"
+  type: stepped
+
+  # Step configuration - default to market research
+  steps:
+    path: ./steps-market/
+    pattern: step-*.md
+
+  # Routing-based workflow paths (not tri-modal create/validate/edit)
+  # User selects research type which routes to appropriate step directory
+  modes:
+    market: ./steps-market/
+    domain: ./steps-domain/
+    technical: ./steps-technical/
+
+  # Variables available in step files
+  variables:
+    project_root: .
+    planning_artifacts: ./artifacts
+    output_file: artifacts/research.md
+    research_type: ""
+    research_topic: ""
+    research_goals: ""
+
+  # Template for research output
+  template: ./templates/research.template.md
+
+  # Agent assignment - Architect for research work
+  agent: architect
+
+  # Web search required for this workflow
+  requirements:
+    web_search: true
+
+  # Triggers - when to suggest this workflow
+  triggers:
+    types: [research, market-research, technical-research, domain-research]
+    tags: [research, stepped, analysis, web-search]

package/pennyfarthing-dist/workflows/retrospective/checklist.md

@@ -0,0 +1,31 @@
+# Retrospective Definition of Done
+
+## Epic Review Complete
+- [ ] Epic number confirmed with user
+- [ ] All story files analyzed for lessons and patterns
+- [ ] Previous retrospective reviewed (if exists)
+- [ ] Successes and challenges discussed with team
+- [ ] Key insights synthesized
+
+## Next Epic Preparation (if applicable)
+- [ ] Next epic previewed and dependencies identified
+- [ ] Preparation tasks defined with owners
+- [ ] Critical path items documented
+- [ ] Knowledge gaps identified
+
+## Action Items Captured
+- [ ] Process improvement actions defined with owners
+- [ ] Technical debt items prioritized
+- [ ] Documentation needs identified
+- [ ] Team agreements documented
+
+## Readiness Verified
+- [ ] Testing and quality status confirmed
+- [ ] Deployment status clarified
+- [ ] Stakeholder acceptance status checked
+- [ ] Unresolved blockers documented
+
+## Documentation Complete
+- [ ] Retrospective summary document saved
+- [ ] Sprint status updated (retrospective marked done)
+- [ ] Action items ready for standup review