@mark-gozner/aigile-method 0.4.5

package/core/templates/brownfield-prd-tmpl.yaml

@@ -0,0 +1,281 @@
+# <!-- Powered by BMAD™ Core -->
+template:
+  id: brownfield-prd-template-v2
+  name: Brownfield Enhancement PRD
+  version: 2.0
+  output:
+    format: markdown
+    filename: docs/prd.md
+    title: "{{project_name}} Brownfield Enhancement PRD"
+
+workflow:
+  mode: interactive
+  elicitation: advanced-elicitation
+
+sections:
+  - id: intro-analysis
+    title: Intro Project Analysis and Context
+    instruction: |
+      IMPORTANT - SCOPE ASSESSMENT REQUIRED:
+
+      This PRD is for SIGNIFICANT enhancements to existing projects that require comprehensive planning and multiple stories. Before proceeding:
+
+      1. **Assess Enhancement Complexity**: If this is a simple feature addition or bug fix that could be completed in 1-2 focused development sessions, STOP and recommend: "For simpler changes, consider using the brownfield-create-epic or brownfield-create-story task with the Product Owner instead. This full PRD process is designed for substantial enhancements that require architectural planning and multiple coordinated stories."
+
+      2. **Project Context**: Determine if we're working in an IDE with the project already loaded or if the user needs to provide project information. If project files are available, analyze existing documentation in the docs folder. If insufficient documentation exists, recommend running the document-project task first.
+
+      3. **Deep Assessment Requirement**: You MUST thoroughly analyze the existing project structure, patterns, and constraints before making ANY suggestions. Every recommendation must be grounded in actual project analysis, not assumptions.
+
+      Gather comprehensive information about the existing project. This section must be completed before proceeding with requirements.
+
+      CRITICAL: Throughout this analysis, explicitly confirm your understanding with the user. For every assumption you make about the existing project, ask: "Based on my analysis, I understand that [assumption]. Is this correct?"
+
+      Do not proceed with any recommendations until the user has validated your understanding of the existing system.
+    sections:
+      - id: existing-project-overview
+        title: Existing Project Overview
+        instruction: Check if document-project analysis was already performed. If yes, reference that output instead of re-analyzing.
+        sections:
+          - id: analysis-source
+            title: Analysis Source
+            instruction: |
+              Indicate one of the following:
+              - Document-project output available at: {{path}}
+              - IDE-based fresh analysis
+              - User-provided information
+          - id: current-state
+            title: Current Project State
+            instruction: |
+              - If document-project output exists: Extract summary from "High Level Architecture" and "Technical Summary" sections
+              - Otherwise: Brief description of what the project currently does and its primary purpose
+      - id: documentation-analysis
+        title: Available Documentation Analysis
+        instruction: |
+          If document-project was run:
+          - Note: "Document-project analysis available - using existing technical documentation"
+          - List key documents created by document-project
+          - Skip the missing documentation check below
+
+          Otherwise, check for existing documentation:
+        sections:
+          - id: available-docs
+            title: Available Documentation
+            type: checklist
+            items:
+              - Tech Stack Documentation [[LLM: If from document-project, check ✓]]
+              - Source Tree/Architecture [[LLM: If from document-project, check ✓]]
+              - Coding Standards [[LLM: If from document-project, may be partial]]
+              - API Documentation [[LLM: If from document-project, check ✓]]
+              - External API Documentation [[LLM: If from document-project, check ✓]]
+              - UX/UI Guidelines [[LLM: May not be in document-project]]
+              - Technical Debt Documentation [[LLM: If from document-project, check ✓]]
+              - "Other: {{other_docs}}"
+            instruction: |
+              - If document-project was already run: "Using existing project analysis from document-project output."
+              - If critical documentation is missing and no document-project: "I recommend running the document-project task first..."
+      - id: enhancement-scope
+        title: Enhancement Scope Definition
+        instruction: Work with user to clearly define what type of enhancement this is. This is critical for scoping and approach.
+        sections:
+          - id: enhancement-type
+            title: Enhancement Type
+            type: checklist
+            instruction: Determine with user which applies
+            items:
+              - New Feature Addition
+              - Major Feature Modification
+              - Integration with New Systems
+              - Performance/Scalability Improvements
+              - UI/UX Overhaul
+              - Technology Stack Upgrade
+              - Bug Fix and Stability Improvements
+              - "Other: {{other_type}}"
+          - id: enhancement-description
+            title: Enhancement Description
+            instruction: 2-3 sentences describing what the user wants to add or change
+          - id: impact-assessment
+            title: Impact Assessment
+            type: checklist
+            instruction: Assess the scope of impact on existing codebase
+            items:
+              - Minimal Impact (isolated additions)
+              - Moderate Impact (some existing code changes)
+              - Significant Impact (substantial existing code changes)
+              - Major Impact (architectural changes required)
+      - id: goals-context
+        title: Goals and Background Context
+        sections:
+          - id: goals
+            title: Goals
+            type: bullet-list
+            instruction: Bullet list of 1-line desired outcomes this enhancement will deliver if successful
+          - id: background
+            title: Background Context
+            type: paragraphs
+            instruction: 1-2 short paragraphs explaining why this enhancement is needed, what problem it solves, and how it fits with the existing project
+      - id: changelog
+        title: Change Log
+        type: table
+        columns: [Change, Date, Version, Description, Author]
+
+  - id: requirements
+    title: Requirements
+    instruction: |
+      Draft functional and non-functional requirements based on your validated understanding of the existing project. Before presenting requirements, confirm: "These requirements are based on my understanding of your existing system. Please review carefully and confirm they align with your project's reality."
+    elicit: true
+    sections:
+      - id: functional
+        title: Functional
+        type: numbered-list
+        prefix: FR
+        instruction: Each Requirement will be a bullet markdown with identifier starting with FR
+        examples:
+          - "FR1: The existing Todo List will integrate with the new AI duplicate detection service without breaking current functionality."
+      - id: non-functional
+        title: Non Functional
+        type: numbered-list
+        prefix: NFR
+        instruction: Each Requirement will be a bullet markdown with identifier starting with NFR. Include constraints from existing system
+        examples:
+          - "NFR1: Enhancement must maintain existing performance characteristics and not exceed current memory usage by more than 20%."
+      - id: compatibility
+        title: Compatibility Requirements
+        instruction: Critical for brownfield - what must remain compatible
+        type: numbered-list
+        prefix: CR
+        template: "{{requirement}}: {{description}}"
+        items:
+          - id: cr1
+            template: "CR1: {{existing_api_compatibility}}"
+          - id: cr2
+            template: "CR2: {{database_schema_compatibility}}"
+          - id: cr3
+            template: "CR3: {{ui_ux_consistency}}"
+          - id: cr4
+            template: "CR4: {{integration_compatibility}}"
+
+  - id: ui-enhancement-goals
+    title: User Interface Enhancement Goals
+    condition: Enhancement includes UI changes
+    instruction: For UI changes, capture how they will integrate with existing UI patterns and design systems
+    sections:
+      - id: existing-ui-integration
+        title: Integration with Existing UI
+        instruction: Describe how new UI elements will fit with existing design patterns, style guides, and component libraries
+      - id: modified-screens
+        title: Modified/New Screens and Views
+        instruction: List only the screens/views that will be modified or added
+      - id: ui-consistency
+        title: UI Consistency Requirements
+        instruction: Specific requirements for maintaining visual and interaction consistency with existing application
+
+  - id: technical-constraints
+    title: Technical Constraints and Integration Requirements
+    instruction: This section replaces separate architecture documentation. Gather detailed technical constraints from existing project analysis.
+    sections:
+      - id: existing-tech-stack
+        title: Existing Technology Stack
+        instruction: |
+          If document-project output available:
+          - Extract from "Actual Tech Stack" table in High Level Architecture section
+          - Include version numbers and any noted constraints
+
+          Otherwise, document the current technology stack:
+        template: |
+          **Languages**: {{languages}}
+          **Frameworks**: {{frameworks}}
+          **Database**: {{database}}
+          **Infrastructure**: {{infrastructure}}
+          **External Dependencies**: {{external_dependencies}}
+      - id: integration-approach
+        title: Integration Approach
+        instruction: Define how the enhancement will integrate with existing architecture
+        template: |
+          **Database Integration Strategy**: {{database_integration}}
+          **API Integration Strategy**: {{api_integration}}
+          **Frontend Integration Strategy**: {{frontend_integration}}
+          **Testing Integration Strategy**: {{testing_integration}}
+      - id: code-organization
+        title: Code Organization and Standards
+        instruction: Based on existing project analysis, define how new code will fit existing patterns
+        template: |
+          **File Structure Approach**: {{file_structure}}
+          **Naming Conventions**: {{naming_conventions}}
+          **Coding Standards**: {{coding_standards}}
+          **Documentation Standards**: {{documentation_standards}}
+      - id: deployment-operations
+        title: Deployment and Operations
+        instruction: How the enhancement fits existing deployment pipeline
+        template: |
+          **Build Process Integration**: {{build_integration}}
+          **Deployment Strategy**: {{deployment_strategy}}
+          **Monitoring and Logging**: {{monitoring_logging}}
+          **Configuration Management**: {{config_management}}
+      - id: risk-assessment
+        title: Risk Assessment and Mitigation
+        instruction: |
+          If document-project output available:
+          - Reference "Technical Debt and Known Issues" section
+          - Include "Workarounds and Gotchas" that might impact enhancement
+          - Note any identified constraints from "Critical Technical Debt"
+
+          Build risk assessment incorporating existing known issues:
+        template: |
+          **Technical Risks**: {{technical_risks}}
+          **Integration Risks**: {{integration_risks}}
+          **Deployment Risks**: {{deployment_risks}}
+          **Mitigation Strategies**: {{mitigation_strategies}}
+
+  - id: epic-structure
+    title: Epic and Story Structure
+    instruction: |
+      For brownfield projects, favor a single comprehensive epic unless the user is clearly requesting multiple unrelated enhancements. Before presenting the epic structure, confirm: "Based on my analysis of your existing project, I believe this enhancement should be structured as [single epic/multiple epics] because [rationale based on actual project analysis]. Does this align with your understanding of the work required?"
+    elicit: true
+    sections:
+      - id: epic-approach
+        title: Epic Approach
+        instruction: Explain the rationale for epic structure - typically single epic for brownfield unless multiple unrelated features
+        template: "**Epic Structure Decision**: {{epic_decision}} with rationale"
+
+  - id: epic-details
+    title: "Epic 1: {{enhancement_title}}"
+    instruction: |
+      Comprehensive epic that delivers the brownfield enhancement while maintaining existing functionality
+
+      CRITICAL STORY SEQUENCING FOR BROWNFIELD:
+      - Stories must ensure existing functionality remains intact
+      - Each story should include verification that existing features still work
+      - Stories should be sequenced to minimize risk to existing system
+      - Include rollback considerations for each story
+      - Focus on incremental integration rather than big-bang changes
+      - Size stories for AI agent execution in existing codebase context
+      - MANDATORY: Present the complete story sequence and ask: "This story sequence is designed to minimize risk to your existing system. Does this order make sense given your project's architecture and constraints?"
+      - Stories must be logically sequential with clear dependencies identified
+      - Each story must deliver value while maintaining system integrity
+    template: |
+      **Epic Goal**: {{epic_goal}}
+
+      **Integration Requirements**: {{integration_requirements}}
+    sections:
+      - id: story
+        title: "Story 1.{{story_number}} {{story_title}}"
+        repeatable: true
+        template: |
+          As a {{user_type}},
+          I want {{action}},
+          so that {{benefit}}.
+        sections:
+          - id: acceptance-criteria
+            title: Acceptance Criteria
+            type: numbered-list
+            instruction: Define criteria that include both new functionality and existing system integrity
+            item_template: "{{criterion_number}}: {{criteria}}"
+          - id: integration-verification
+            title: Integration Verification
+            instruction: Specific verification steps to ensure existing functionality remains intact
+            type: numbered-list
+            prefix: IV
+            items:
+              - template: "IV1: {{existing_functionality_verification}}"
+              - template: "IV2: {{integration_point_verification}}"
+              - template: "IV3: {{performance_impact_verification}}"

package/core/templates/front-end-architecture-tmpl.yaml

@@ -0,0 +1,219 @@
+# <!-- Powered by BMAD™ Core -->
+template:
+  id: frontend-architecture-template-v2
+  name: Frontend Architecture Document
+  version: 2.0
+  output:
+    format: markdown
+    filename: docs/ui-architecture.md
+    title: "{{project_name}} Frontend Architecture Document"
+
+workflow:
+  mode: interactive
+  elicitation: advanced-elicitation
+
+sections:
+  - id: template-framework-selection
+    title: Template and Framework Selection
+    instruction: |
+      Review provided documents including PRD, UX-UI Specification, and main Architecture Document. Focus on extracting technical implementation details needed for AI frontend tools and developer agents. Ask the user for any of these documents if you are unable to locate and were not provided.
+
+      Before proceeding with frontend architecture design, check if the project is using a frontend starter template or existing codebase:
+
+      1. Review the PRD, main architecture document, and brainstorming brief for mentions of:
+         - Frontend starter templates (e.g., Create React App, Next.js, Vite, Vue CLI, Angular CLI, etc.)
+         - UI kit or component library starters
+         - Existing frontend projects being used as a foundation
+         - Admin dashboard templates or other specialized starters
+         - Design system implementations
+
+      2. If a frontend starter template or existing project is mentioned:
+         - Ask the user to provide access via one of these methods:
+           - Link to the starter template documentation
+           - Upload/attach the project files (for small projects)
+           - Share a link to the project repository
+         - Analyze the starter/existing project to understand:
+           - Pre-installed dependencies and versions
+           - Folder structure and file organization
+           - Built-in components and utilities
+           - Styling approach (CSS modules, styled-components, Tailwind, etc.)
+           - State management setup (if any)
+           - Routing configuration
+           - Testing setup and patterns
+           - Build and development scripts
+         - Use this analysis to ensure your frontend architecture aligns with the starter's patterns
+
+      3. If no frontend starter is mentioned but this is a new UI, ensure we know what the ui language and framework is:
+         - Based on the framework choice, suggest appropriate starters:
+           - React: Create React App, Next.js, Vite + React
+           - Vue: Vue CLI, Nuxt.js, Vite + Vue
+           - Angular: Angular CLI
+           - Or suggest popular UI templates if applicable
+         - Explain benefits specific to frontend development
+
+      4. If the user confirms no starter template will be used:
+         - Note that all tooling, bundling, and configuration will need manual setup
+         - Proceed with frontend architecture from scratch
+
+      Document the starter template decision and any constraints it imposes before proceeding.
+    sections:
+      - id: changelog
+        title: Change Log
+        type: table
+        columns: [Date, Version, Description, Author]
+        instruction: Track document versions and changes
+
+  - id: frontend-tech-stack
+    title: Frontend Tech Stack
+    instruction: Extract from main architecture's Technology Stack Table. This section MUST remain synchronized with the main architecture document.
+    elicit: true
+    sections:
+      - id: tech-stack-table
+        title: Technology Stack Table
+        type: table
+        columns: [Category, Technology, Version, Purpose, Rationale]
+        instruction: Fill in appropriate technology choices based on the selected framework and project requirements.
+        rows:
+          - ["Framework", "{{framework}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
+          - ["UI Library", "{{ui_library}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
+          - [
+              "State Management",
+              "{{state_management}}",
+              "{{version}}",
+              "{{purpose}}",
+              "{{why_chosen}}",
+            ]
+          - ["Routing", "{{routing_library}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
+          - ["Build Tool", "{{build_tool}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
+          - ["Styling", "{{styling_solution}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
+          - ["Testing", "{{test_framework}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
+          - [
+              "Component Library",
+              "{{component_lib}}",
+              "{{version}}",
+              "{{purpose}}",
+              "{{why_chosen}}",
+            ]
+          - ["Form Handling", "{{form_library}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
+          - ["Animation", "{{animation_lib}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
+          - ["Dev Tools", "{{dev_tools}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
+
+  - id: project-structure
+    title: Project Structure
+    instruction: Define exact directory structure for AI tools based on the chosen framework. Be specific about where each type of file goes. Generate a structure that follows the framework's best practices and conventions.
+    elicit: true
+    type: code
+    language: plaintext
+
+  - id: component-standards
+    title: Component Standards
+    instruction: Define exact patterns for component creation based on the chosen framework.
+    elicit: true
+    sections:
+      - id: component-template
+        title: Component Template
+        instruction: Generate a minimal but complete component template following the framework's best practices. Include TypeScript types, proper imports, and basic structure.
+        type: code
+        language: typescript
+      - id: naming-conventions
+        title: Naming Conventions
+        instruction: Provide naming conventions specific to the chosen framework for components, files, services, state management, and other architectural elements.
+
+  - id: state-management
+    title: State Management
+    instruction: Define state management patterns based on the chosen framework.
+    elicit: true
+    sections:
+      - id: store-structure
+        title: Store Structure
+        instruction: Generate the state management directory structure appropriate for the chosen framework and selected state management solution.
+        type: code
+        language: plaintext
+      - id: state-template
+        title: State Management Template
+        instruction: Provide a basic state management template/example following the framework's recommended patterns. Include TypeScript types and common operations like setting, updating, and clearing state.
+        type: code
+        language: typescript
+
+  - id: api-integration
+    title: API Integration
+    instruction: Define API service patterns based on the chosen framework.
+    elicit: true
+    sections:
+      - id: service-template
+        title: Service Template
+        instruction: Provide an API service template that follows the framework's conventions. Include proper TypeScript types, error handling, and async patterns.
+        type: code
+        language: typescript
+      - id: api-client-config
+        title: API Client Configuration
+        instruction: Show how to configure the HTTP client for the chosen framework, including authentication interceptors/middleware and error handling.
+        type: code
+        language: typescript
+
+  - id: routing
+    title: Routing
+    instruction: Define routing structure and patterns based on the chosen framework.
+    elicit: true
+    sections:
+      - id: route-configuration
+        title: Route Configuration
+        instruction: Provide routing configuration appropriate for the chosen framework. Include protected route patterns, lazy loading where applicable, and authentication guards/middleware.
+        type: code
+        language: typescript
+
+  - id: styling-guidelines
+    title: Styling Guidelines
+    instruction: Define styling approach based on the chosen framework.
+    elicit: true
+    sections:
+      - id: styling-approach
+        title: Styling Approach
+        instruction: Describe the styling methodology appropriate for the chosen framework (CSS Modules, Styled Components, Tailwind, etc.) and provide basic patterns.
+      - id: global-theme
+        title: Global Theme Variables
+        instruction: Provide a CSS custom properties (CSS variables) theme system that works across all frameworks. Include colors, spacing, typography, shadows, and dark mode support.
+        type: code
+        language: css
+
+  - id: testing-requirements
+    title: Testing Requirements
+    instruction: Define minimal testing requirements based on the chosen framework.
+    elicit: true
+    sections:
+      - id: component-test-template
+        title: Component Test Template
+        instruction: Provide a basic component test template using the framework's recommended testing library. Include examples of rendering tests, user interaction tests, and mocking.
+        type: code
+        language: typescript
+      - id: testing-best-practices
+        title: Testing Best Practices
+        type: numbered-list
+        items:
+          - "**Unit Tests**: Test individual components in isolation"
+          - "**Integration Tests**: Test component interactions"
+          - "**E2E Tests**: Test critical user flows (using Cypress/Playwright)"
+          - "**Coverage Goals**: Aim for 80% code coverage"
+          - "**Test Structure**: Arrange-Act-Assert pattern"
+          - "**Mock External Dependencies**: API calls, routing, state management"
+
+  - id: environment-configuration
+    title: Environment Configuration
+    instruction: List required environment variables based on the chosen framework. Show the appropriate format and naming conventions for the framework.
+    elicit: true
+
+  - id: frontend-developer-standards
+    title: Frontend Developer Standards
+    sections:
+      - id: critical-coding-rules
+        title: Critical Coding Rules
+        instruction: List essential rules that prevent common AI mistakes, including both universal rules and framework-specific ones.
+        elicit: true
+      - id: quick-reference
+        title: Quick Reference
+        instruction: |
+          Create a framework-specific cheat sheet with:
+          - Common commands (dev server, build, test)
+          - Key import patterns
+          - File naming conventions
+          - Project-specific patterns and utilities