ldy26098
/
BMAD-METHOD
mirror of https://github.com/bmad-code-org/BMAD-METHOD.git
1
0
Fork 0
Code Packages Projects Releases Wiki Activity

feat: add hierarchical section indices to all template files 

- Added numbered indices to section headings across all template files for better document structure and navigation
- Main sections use single numbers (1., 2., 3.)
- Subsections use decimal notation (1.1., 1.2., 2.1.)
- Sub-subsections use triple decimal notation (1.1.1., 1.1.2.)
- Updated templates: architecture, fullstack-architecture, prd, front-end-architecture, brownfield-architecture, brownfield-prd

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
minhtrungcc 2025-09-07 13:25:16 +07:00
parent de6c14df07
commit 62cee232c4
6 changed files with 281 additions and 281 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
bmad-core/templates/architecture-tmpl.yaml
View File

@ -14,7 +14,7 @@ workflow:
sections: sections:
- id: introduction - id: introduction
title: Introduction title: 1. Introduction
instruction: | instruction: |
If available, review any provided relevant documents to gather all relevant context before beginning. If at a minimum you cannot locate docs/prd.md ask the user what docs will provide the basis for the architecture. If available, review any provided relevant documents to gather all relevant context before beginning. If at a minimum you cannot locate docs/prd.md ask the user what docs will provide the basis for the architecture.
sections: sections:
@ -25,7 +25,7 @@ sections:
**Relationship to Frontend Architecture:** **Relationship to Frontend Architecture:**
If the project includes a significant user interface, a separate Frontend Architecture Document will detail the frontend-specific design and MUST be used in conjunction with this document. Core technology stack choices documented herein (see "Tech Stack") are definitive for the entire project, including any frontend components. If the project includes a significant user interface, a separate Frontend Architecture Document will detail the frontend-specific design and MUST be used in conjunction with this document. Core technology stack choices documented herein (see "Tech Stack") are definitive for the entire project, including any frontend components.
- id: starter-template - id: starter-template
title: Starter Template or Existing Project title: 1.1. Starter Template or Existing Project
instruction: | instruction: |
Before proceeding further with architecture design, check if the project is based on a starter template or existing codebase: Before proceeding further with architecture design, check if the project is based on a starter template or existing codebase:
@ -60,19 +60,19 @@ sections:
Document the decision here before proceeding with the architecture design. If none, just say N/A Document the decision here before proceeding with the architecture design. If none, just say N/A
elicit: true elicit: true
- id: changelog - id: changelog
title: Change Log title: 1.2. Change Log
type: table type: table
columns: [Date, Version, Description, Author] columns: [Date, Version, Description, Author]
instruction: Track document versions and changes instruction: Track document versions and changes
- id: high-level-architecture - id: high-level-architecture
title: High Level Architecture title: 2. High Level Architecture
instruction: | instruction: |
This section contains multiple subsections that establish the foundation of the architecture. Present all subsections together at once. This section contains multiple subsections that establish the foundation of the architecture. Present all subsections together at once.
elicit: true elicit: true
sections: sections:
- id: technical-summary - id: technical-summary
title: Technical Summary title: 2.1. Technical Summary
instruction: | instruction: |
Provide a brief paragraph (3-5 sentences) overview of: Provide a brief paragraph (3-5 sentences) overview of:
- The system's overall architecture style - The system's overall architecture style
@ -81,7 +81,7 @@ sections:
- Core architectural patterns being used - Core architectural patterns being used
- Reference back to the PRD goals and how this architecture supports them - Reference back to the PRD goals and how this architecture supports them
- id: high-level-overview - id: high-level-overview
title: High Level Overview title: 2.2. High Level Overview
instruction: | instruction: |
Based on the PRD's Technical Assumptions section, describe: Based on the PRD's Technical Assumptions section, describe:
@ -91,7 +91,7 @@ sections:
4. Primary user interaction flow or data flow at a conceptual level 4. Primary user interaction flow or data flow at a conceptual level
5. Key architectural decisions and their rationale 5. Key architectural decisions and their rationale
- id: project-diagram - id: project-diagram
title: High Level Project Diagram title: 2.3. High Level Project Diagram
type: mermaid type: mermaid
mermaid_type: graph mermaid_type: graph
instruction: | instruction: |
@ -103,7 +103,7 @@ sections:
- User entry points - User entry points
- id: architectural-patterns - id: architectural-patterns
title: Architectural and Design Patterns title: 2.4. Architectural and Design Patterns
instruction: | instruction: |
List the key high-level patterns that will guide the architecture. For each pattern: List the key high-level patterns that will guide the architecture. For each pattern:
@ -124,7 +124,7 @@ sections:
- "**Event-Driven Communication:** Using SNS/SQS for service decoupling - _Rationale:_ Supports async processing and system resilience" - "**Event-Driven Communication:** Using SNS/SQS for service decoupling - _Rationale:_ Supports async processing and system resilience"
- id: tech-stack - id: tech-stack
title: Tech Stack title: 3. Tech Stack
instruction: | instruction: |
This is the DEFINITIVE technology selection section. Work with the user to make specific choices: This is the DEFINITIVE technology selection section. Work with the user to make specific choices:
@ -148,13 +148,13 @@ sections:
elicit: true elicit: true
sections: sections:
- id: cloud-infrastructure - id: cloud-infrastructure
title: Cloud Infrastructure title: 3.1. Cloud Infrastructure
template: | template: |
- **Provider:** {{cloud_provider}} - **Provider:** {{cloud_provider}}
- **Key Services:** {{core_services_list}} - **Key Services:** {{core_services_list}}
- **Deployment Regions:** {{regions}} - **Deployment Regions:** {{regions}}
- id: technology-stack-table - id: technology-stack-table
title: Technology Stack Table title: 3.2. Technology Stack Table
type: table type: table
columns: [Category, Technology, Version, Purpose, Rationale] columns: [Category, Technology, Version, Purpose, Rationale]
instruction: Populate the technology stack table with all relevant technologies instruction: Populate the technology stack table with all relevant technologies
@ -164,7 +164,7 @@ sections:
- "| **Framework** | NestJS | 10.3.2 | Backend framework | Enterprise-ready, good DI, matches team patterns |" - "| **Framework** | NestJS | 10.3.2 | Backend framework | Enterprise-ready, good DI, matches team patterns |"
- id: data-models - id: data-models
title: Data Models title: 4. Data Models
instruction: | instruction: |
Define the core data models/entities: Define the core data models/entities:
@ -192,7 +192,7 @@ sections:
- {{relationship_2}} - {{relationship_2}}
- id: components - id: components
title: Components title: 5. Components
instruction: | instruction: |
Based on the architectural patterns, tech stack, and data models from above: Based on the architectural patterns, tech stack, and data models from above:
@ -222,7 +222,7 @@ sections:
**Technology Stack:** {{component_tech_details}} **Technology Stack:** {{component_tech_details}}
- id: component-diagrams - id: component-diagrams
title: Component Diagrams title: 5.1. Component Diagrams
type: mermaid type: mermaid
instruction: | instruction: |
Create Mermaid diagrams to visualize component relationships. Options: Create Mermaid diagrams to visualize component relationships. Options:
@ -232,7 +232,7 @@ sections:
Choose the most appropriate for clarity Choose the most appropriate for clarity
- id: external-apis - id: external-apis
title: External APIs title: 6. External APIs
condition: Project requires external API integrations condition: Project requires external API integrations
instruction: | instruction: |
For each external service integration: For each external service integration:
@ -262,7 +262,7 @@ sections:
**Integration Notes:** {{integration_considerations}} **Integration Notes:** {{integration_considerations}}
- id: core-workflows - id: core-workflows
title: Core Workflows title: 7. Core Workflows
type: mermaid type: mermaid
mermaid_type: sequence mermaid_type: sequence
instruction: | instruction: |
@ -278,7 +278,7 @@ sections:
elicit: true elicit: true
- id: rest-api-spec - id: rest-api-spec
title: REST API Spec title: 8. REST API Spec
condition: Project includes REST API condition: Project includes REST API
type: code type: code
language: yaml language: yaml
@ -304,7 +304,7 @@ sections:
description: {{server_description}} description: {{server_description}}
- id: database-schema - id: database-schema
title: Database Schema title: 9. Database Schema
instruction: | instruction: |
Transform the conceptual data models into concrete database schemas: Transform the conceptual data models into concrete database schemas:
@ -318,7 +318,7 @@ sections:
elicit: true elicit: true
- id: source-tree - id: source-tree
title: Source Tree title: 10. Source Tree
type: code type: code
language: plaintext language: plaintext
instruction: | instruction: |
@ -345,7 +345,7 @@ sections:
└── package.json # Root package.json with workspaces └── package.json # Root package.json with workspaces
- id: infrastructure-deployment - id: infrastructure-deployment
title: Infrastructure and Deployment title: 11. Infrastructure and Deployment
instruction: | instruction: |
Define the deployment architecture and practices: Define the deployment architecture and practices:
@ -359,35 +359,35 @@ sections:
elicit: true elicit: true
sections: sections:
- id: infrastructure-as-code - id: infrastructure-as-code
title: Infrastructure as Code title: 11.1. Infrastructure as Code
template: | template: |
- **Tool:** {{iac_tool}} {{version}} - **Tool:** {{iac_tool}} {{version}}
- **Location:** `{{iac_directory}}` - **Location:** `{{iac_directory}}`
- **Approach:** {{iac_approach}} - **Approach:** {{iac_approach}}
- id: deployment-strategy - id: deployment-strategy
title: Deployment Strategy title: 11.2. Deployment Strategy
template: | template: |
- **Strategy:** {{deployment_strategy}} - **Strategy:** {{deployment_strategy}}
- **CI/CD Platform:** {{cicd_platform}} - **CI/CD Platform:** {{cicd_platform}}
- **Pipeline Configuration:** `{{pipeline_config_location}}` - **Pipeline Configuration:** `{{pipeline_config_location}}`
- id: environments - id: environments
title: Environments title: 11.3. Environments
repeatable: true repeatable: true
template: "- **{{env_name}}:** {{env_purpose}} - {{env_details}}" template: "- **{{env_name}}:** {{env_purpose}} - {{env_details}}"
- id: promotion-flow - id: promotion-flow
title: Environment Promotion Flow title: 11.4. Environment Promotion Flow
type: code type: code
language: text language: text
template: "{{promotion_flow_diagram}}" template: "{{promotion_flow_diagram}}"
- id: rollback-strategy - id: rollback-strategy
title: Rollback Strategy title: 11.5. Rollback Strategy
template: | template: |
- **Primary Method:** {{rollback_method}} - **Primary Method:** {{rollback_method}}
- **Trigger Conditions:** {{rollback_triggers}} - **Trigger Conditions:** {{rollback_triggers}}
- **Recovery Time Objective:** {{rto}} - **Recovery Time Objective:** {{rto}}
- id: error-handling-strategy - id: error-handling-strategy
title: Error Handling Strategy title: 12. Error Handling Strategy
instruction: | instruction: |
Define comprehensive error handling approach: Define comprehensive error handling approach:
@ -401,13 +401,13 @@ sections:
elicit: true elicit: true
sections: sections:
- id: general-approach - id: general-approach
title: General Approach title: 12.1. General Approach
template: | template: |
- **Error Model:** {{error_model}} - **Error Model:** {{error_model}}
- **Exception Hierarchy:** {{exception_structure}} - **Exception Hierarchy:** {{exception_structure}}
- **Error Propagation:** {{propagation_rules}} - **Error Propagation:** {{propagation_rules}}
- id: logging-standards - id: logging-standards
title: Logging Standards title: 12.2. Logging Standards
template: | template: |
- **Library:** {{logging_library}} {{version}} - **Library:** {{logging_library}} {{version}}
- **Format:** {{log_format}} - **Format:** {{log_format}}
@ -417,30 +417,30 @@ sections:
- Service Context: {{service_context}} - Service Context: {{service_context}}
- User Context: {{user_context_rules}} - User Context: {{user_context_rules}}
- id: error-patterns - id: error-patterns
title: Error Handling Patterns title: 12.3. Error Handling Patterns
sections: sections:
- id: external-api-errors - id: external-api-errors
title: External API Errors title: 12.3.1. External API Errors
template: | template: |
- **Retry Policy:** {{retry_strategy}} - **Retry Policy:** {{retry_strategy}}
- **Circuit Breaker:** {{circuit_breaker_config}} - **Circuit Breaker:** {{circuit_breaker_config}}
- **Timeout Configuration:** {{timeout_settings}} - **Timeout Configuration:** {{timeout_settings}}
- **Error Translation:** {{error_mapping_rules}} - **Error Translation:** {{error_mapping_rules}}
- id: business-logic-errors - id: business-logic-errors
title: Business Logic Errors title: 12.3.2. Business Logic Errors
template: | template: |
- **Custom Exceptions:** {{business_exception_types}} - **Custom Exceptions:** {{business_exception_types}}
- **User-Facing Errors:** {{user_error_format}} - **User-Facing Errors:** {{user_error_format}}
- **Error Codes:** {{error_code_system}} - **Error Codes:** {{error_code_system}}
- id: data-consistency - id: data-consistency
title: Data Consistency title: 12.3.3. Data Consistency
template: | template: |
- **Transaction Strategy:** {{transaction_approach}} - **Transaction Strategy:** {{transaction_approach}}
- **Compensation Logic:** {{compensation_patterns}} - **Compensation Logic:** {{compensation_patterns}}
- **Idempotency:** {{idempotency_approach}} - **Idempotency:** {{idempotency_approach}}
- id: coding-standards - id: coding-standards
title: Coding Standards title: 13. Coding Standards
instruction: | instruction: |
These standards are MANDATORY for AI agents. Work with user to define ONLY the critical rules needed to prevent bad code. Explain that: These standards are MANDATORY for AI agents. Work with user to define ONLY the critical rules needed to prevent bad code. Explain that:
@ -454,18 +454,18 @@ sections:
elicit: true elicit: true
sections: sections:
- id: core-standards - id: core-standards
title: Core Standards title: 13.1. Core Standards
template: | template: |
- **Languages & Runtimes:** {{languages_and_versions}} - **Languages & Runtimes:** {{languages_and_versions}}
- **Style & Linting:** {{linter_config}} - **Style & Linting:** {{linter_config}}
- **Test Organization:** {{test_file_convention}} - **Test Organization:** {{test_file_convention}}
- id: naming-conventions - id: naming-conventions
title: Naming Conventions title: 13.2. Naming Conventions
type: table type: table
columns: [Element, Convention, Example] columns: [Element, Convention, Example]
instruction: Only include if deviating from language defaults instruction: Only include if deviating from language defaults
- id: critical-rules - id: critical-rules
title: Critical Rules title: 13.3. Critical Rules
instruction: | instruction: |
List ONLY rules that AI might violate or project-specific requirements. Examples: List ONLY rules that AI might violate or project-specific requirements. Examples:
- "Never use console.log in production code - use logger" - "Never use console.log in production code - use logger"
@ -476,7 +476,7 @@ sections:
repeatable: true repeatable: true
template: "- **{{rule_name}}:** {{rule_description}}" template: "- **{{rule_name}}:** {{rule_description}}"
- id: language-specifics - id: language-specifics
title: Language-Specific Guidelines title: 13.4. Language-Specific Guidelines
condition: Critical language-specific rules needed condition: Critical language-specific rules needed
instruction: Add ONLY if critical for preventing AI mistakes. Most teams don't need this section. instruction: Add ONLY if critical for preventing AI mistakes. Most teams don't need this section.
sections: sections:
@ -486,7 +486,7 @@ sections:
template: "- **{{rule_topic}}:** {{rule_detail}}" template: "- **{{rule_topic}}:** {{rule_detail}}"
- id: test-strategy - id: test-strategy
title: Test Strategy and Standards title: 14. Test Strategy and Standards
instruction: | instruction: |
Work with user to define comprehensive test strategy: Work with user to define comprehensive test strategy:
@ -501,16 +501,16 @@ sections:
elicit: true elicit: true
sections: sections:
- id: testing-philosophy - id: testing-philosophy
title: Testing Philosophy title: 14.1. Testing Philosophy
template: | template: |
- **Approach:** {{test_approach}} - **Approach:** {{test_approach}}
- **Coverage Goals:** {{coverage_targets}} - **Coverage Goals:** {{coverage_targets}}
- **Test Pyramid:** {{test_distribution}} - **Test Pyramid:** {{test_distribution}}
- id: test-types - id: test-types
title: Test Types and Organization title: 14.2. Test Types and Organization
sections: sections:
- id: unit-tests - id: unit-tests
title: Unit Tests title: 14.2.1. Unit Tests
template: | template: |
- **Framework:** {{unit_test_framework}} {{version}} - **Framework:** {{unit_test_framework}} {{version}}
- **File Convention:** {{unit_test_naming}} - **File Convention:** {{unit_test_naming}}
@ -524,7 +524,7 @@ sections:
- Follow AAA pattern (Arrange, Act, Assert) - Follow AAA pattern (Arrange, Act, Assert)
- Mock all external dependencies - Mock all external dependencies
- id: integration-tests - id: integration-tests
title: Integration Tests title: 14.2.2. Integration Tests
template: | template: |
- **Scope:** {{integration_scope}} - **Scope:** {{integration_scope}}
- **Location:** {{integration_test_location}} - **Location:** {{integration_test_location}}
@ -535,28 +535,28 @@ sections:
- "**Message Queue:** Embedded Kafka for tests" - "**Message Queue:** Embedded Kafka for tests"
- "**External APIs:** WireMock for stubbing" - "**External APIs:** WireMock for stubbing"
- id: e2e-tests - id: e2e-tests
title: End-to-End Tests title: 14.2.3. End-to-End Tests
template: | template: |
- **Framework:** {{e2e_framework}} {{version}} - **Framework:** {{e2e_framework}} {{version}}
- **Scope:** {{e2e_scope}} - **Scope:** {{e2e_scope}}
- **Environment:** {{e2e_environment}} - **Environment:** {{e2e_environment}}
- **Test Data:** {{e2e_data_strategy}} - **Test Data:** {{e2e_data_strategy}}
- id: test-data-management - id: test-data-management
title: Test Data Management title: 14.3. Test Data Management
template: | template: |
- **Strategy:** {{test_data_approach}} - **Strategy:** {{test_data_approach}}
- **Fixtures:** {{fixture_location}} - **Fixtures:** {{fixture_location}}
- **Factories:** {{factory_pattern}} - **Factories:** {{factory_pattern}}
- **Cleanup:** {{cleanup_strategy}} - **Cleanup:** {{cleanup_strategy}}
- id: continuous-testing - id: continuous-testing
title: Continuous Testing title: 14.4. Continuous Testing
template: | template: |
- **CI Integration:** {{ci_test_stages}} - **CI Integration:** {{ci_test_stages}}
- **Performance Tests:** {{perf_test_approach}} - **Performance Tests:** {{perf_test_approach}}
- **Security Tests:** {{security_test_approach}} - **Security Tests:** {{security_test_approach}}
- id: security - id: security
title: Security title: 15. Security
instruction: | instruction: |
Define MANDATORY security requirements for AI and human developers: Define MANDATORY security requirements for AI and human developers:
@ -568,7 +568,7 @@ sections:
elicit: true elicit: true
sections: sections:
- id: input-validation - id: input-validation
title: Input Validation title: 15.1. Input Validation
template: | template: |
- **Validation Library:** {{validation_library}} - **Validation Library:** {{validation_library}}
- **Validation Location:** {{where_to_validate}} - **Validation Location:** {{where_to_validate}}
@ -577,7 +577,7 @@ sections:
- Validation at API boundary before processing - Validation at API boundary before processing
- Whitelist approach preferred over blacklist - Whitelist approach preferred over blacklist
- id: auth-authorization - id: auth-authorization
title: Authentication & Authorization title: 15.2. Authentication & Authorization
template: | template: |
- **Auth Method:** {{auth_implementation}} - **Auth Method:** {{auth_implementation}}
- **Session Management:** {{session_approach}} - **Session Management:** {{session_approach}}
@ -585,7 +585,7 @@ sections:
- {{auth_pattern_1}} - {{auth_pattern_1}}
- {{auth_pattern_2}} - {{auth_pattern_2}}
- id: secrets-management - id: secrets-management
title: Secrets Management title: 15.3. Secrets Management
template: | template: |
- **Development:** {{dev_secrets_approach}} - **Development:** {{dev_secrets_approach}}
- **Production:** {{prod_secrets_service}} - **Production:** {{prod_secrets_service}}
@ -594,38 +594,38 @@ sections:
- Access via configuration service only - Access via configuration service only
- No secrets in logs or error messages - No secrets in logs or error messages
- id: api-security - id: api-security
title: API Security title: 15.4. API Security
template: | template: |
- **Rate Limiting:** {{rate_limit_implementation}} - **Rate Limiting:** {{rate_limit_implementation}}
- **CORS Policy:** {{cors_configuration}} - **CORS Policy:** {{cors_configuration}}
- **Security Headers:** {{required_headers}} - **Security Headers:** {{required_headers}}
- **HTTPS Enforcement:** {{https_approach}} - **HTTPS Enforcement:** {{https_approach}}
- id: data-protection - id: data-protection
title: Data Protection title: 15.5. Data Protection
template: | template: |
- **Encryption at Rest:** {{encryption_at_rest}} - **Encryption at Rest:** {{encryption_at_rest}}
- **Encryption in Transit:** {{encryption_in_transit}} - **Encryption in Transit:** {{encryption_in_transit}}
- **PII Handling:** {{pii_rules}} - **PII Handling:** {{pii_rules}}
- **Logging Restrictions:** {{what_not_to_log}} - **Logging Restrictions:** {{what_not_to_log}}
- id: dependency-security - id: dependency-security
title: Dependency Security title: 15.6. Dependency Security
template: | template: |
- **Scanning Tool:** {{dependency_scanner}} - **Scanning Tool:** {{dependency_scanner}}
- **Update Policy:** {{update_frequency}} - **Update Policy:** {{update_frequency}}
- **Approval Process:** {{new_dep_process}} - **Approval Process:** {{new_dep_process}}
- id: security-testing - id: security-testing
title: Security Testing title: 15.7. Security Testing
template: | template: |
- **SAST Tool:** {{static_analysis}} - **SAST Tool:** {{static_analysis}}
- **DAST Tool:** {{dynamic_analysis}} - **DAST Tool:** {{dynamic_analysis}}
- **Penetration Testing:** {{pentest_schedule}} - **Penetration Testing:** {{pentest_schedule}}
- id: checklist-results - id: checklist-results
title: Checklist Results Report title: 16. Checklist Results Report
instruction: Before running the checklist, offer to output the full architecture document. Once user confirms, execute the architect-checklist and populate results here. instruction: Before running the checklist, offer to output the full architecture document. Once user confirms, execute the architect-checklist and populate results here.
- id: next-steps - id: next-steps
title: Next Steps title: 17. Next Steps
instruction: | instruction: |
After completing the architecture: After completing the architecture:
@ -641,7 +641,7 @@ sections:
3. Include specific prompts for next agents if needed 3. Include specific prompts for next agents if needed
sections: sections:
- id: architect-prompt - id: architect-prompt
title: Architect Prompt title: 17.1. Architect Prompt
condition: Project has UI components condition: Project has UI components
instruction: | instruction: |
Create a brief prompt to hand off to Architect for Frontend Architecture creation. Include: Create a brief prompt to hand off to Architect for Frontend Architecture creation. Include:

110
bmad-core/templates/brownfield-architecture-tmpl.yaml
View File

@ -14,7 +14,7 @@ workflow:
sections: sections:
- id: introduction - id: introduction
title: Introduction title: 1. Introduction
instruction: | instruction: |
IMPORTANT - SCOPE AND ASSESSMENT REQUIRED: IMPORTANT - SCOPE AND ASSESSMENT REQUIRED:
@ -41,7 +41,7 @@ sections:
**Relationship to Existing Architecture:** **Relationship to Existing Architecture:**
This document supplements existing project architecture by defining how new components will integrate with current systems. Where conflicts arise between new and existing patterns, this document provides guidance on maintaining consistency while implementing enhancements. This document supplements existing project architecture by defining how new components will integrate with current systems. Where conflicts arise between new and existing patterns, this document provides guidance on maintaining consistency while implementing enhancements.
- id: existing-project-analysis - id: existing-project-analysis
title: Existing Project Analysis title: 1.1. Existing Project Analysis
instruction: | instruction: |
Analyze the existing project structure and architecture: Analyze the existing project structure and architecture:
@ -55,28 +55,28 @@ sections:
elicit: true elicit: true
sections: sections:
- id: current-state - id: current-state
title: Current Project State title: 1.1.1. Current Project State
template: | template: |
- **Primary Purpose:** {{existing_project_purpose}} - **Primary Purpose:** {{existing_project_purpose}}
- **Current Tech Stack:** {{existing_tech_summary}} - **Current Tech Stack:** {{existing_tech_summary}}
- **Architecture Style:** {{existing_architecture_style}} - **Architecture Style:** {{existing_architecture_style}}
- **Deployment Method:** {{existing_deployment_approach}} - **Deployment Method:** {{existing_deployment_approach}}
- id: available-docs - id: available-docs
title: Available Documentation title: 1.1.2. Available Documentation
type: bullet-list type: bullet-list
template: "- {{existing_docs_summary}}" template: "- {{existing_docs_summary}}"
- id: constraints - id: constraints
title: Identified Constraints title: 1.1.3. Identified Constraints
type: bullet-list type: bullet-list
template: "- {{constraint}}" template: "- {{constraint}}"
- id: changelog - id: changelog
title: Change Log title: 1.2. Change Log
type: table type: table
columns: [Change, Date, Version, Description, Author] columns: [Change, Date, Version, Description, Author]
instruction: Track document versions and changes instruction: Track document versions and changes
- id: enhancement-scope - id: enhancement-scope
title: Enhancement Scope and Integration Strategy title: 2. Enhancement Scope and Integration Strategy
instruction: | instruction: |
Define how the enhancement will integrate with the existing system: Define how the enhancement will integrate with the existing system:
@ -89,20 +89,20 @@ sections:
elicit: true elicit: true
sections: sections:
- id: enhancement-overview - id: enhancement-overview
title: Enhancement Overview title: 2.1. Enhancement Overview
template: | template: |
**Enhancement Type:** {{enhancement_type}} **Enhancement Type:** {{enhancement_type}}
**Scope:** {{enhancement_scope}} **Scope:** {{enhancement_scope}}
**Integration Impact:** {{integration_impact_level}} **Integration Impact:** {{integration_impact_level}}
- id: integration-approach - id: integration-approach
title: Integration Approach title: 2.2. Integration Approach
template: | template: |
**Code Integration Strategy:** {{code_integration_approach}} **Code Integration Strategy:** {{code_integration_approach}}
**Database Integration:** {{database_integration_approach}} **Database Integration:** {{database_integration_approach}}
**API Integration:** {{api_integration_approach}} **API Integration:** {{api_integration_approach}}
**UI Integration:** {{ui_integration_approach}} **UI Integration:** {{ui_integration_approach}}
- id: compatibility-requirements - id: compatibility-requirements
title: Compatibility Requirements title: 2.3. Compatibility Requirements
template: | template: |
- **Existing API Compatibility:** {{api_compatibility}} - **Existing API Compatibility:** {{api_compatibility}}
- **Database Schema Compatibility:** {{db_compatibility}} - **Database Schema Compatibility:** {{db_compatibility}}
@ -110,7 +110,7 @@ sections:
- **Performance Impact:** {{performance_constraints}} - **Performance Impact:** {{performance_constraints}}
- id: tech-stack-alignment - id: tech-stack-alignment
title: Tech Stack Alignment title: 3. Tech Stack Alignment
instruction: | instruction: |
Ensure new components align with existing technology choices: Ensure new components align with existing technology choices:
@ -121,19 +121,19 @@ sections:
elicit: true elicit: true
sections: sections:
- id: existing-stack - id: existing-stack
title: Existing Technology Stack title: 3.1. Existing Technology Stack
type: table type: table
columns: [Category, Current Technology, Version, Usage in Enhancement, Notes] columns: [Category, Current Technology, Version, Usage in Enhancement, Notes]
instruction: Document the current stack that must be maintained or integrated with instruction: Document the current stack that must be maintained or integrated with
- id: new-tech-additions - id: new-tech-additions
title: New Technology Additions title: 3.2. New Technology Additions
condition: Enhancement requires new technologies condition: Enhancement requires new technologies
type: table type: table
columns: [Technology, Version, Purpose, Rationale, Integration Method] columns: [Technology, Version, Purpose, Rationale, Integration Method]
instruction: Only include if new technologies are required for the enhancement instruction: Only include if new technologies are required for the enhancement
- id: data-models - id: data-models
title: Data Models and Schema Changes title: 4. Data Models and Schema Changes
instruction: | instruction: |
Define new data models and how they integrate with existing schema: Define new data models and how they integrate with existing schema:
@ -144,11 +144,11 @@ sections:
elicit: true elicit: true
sections: sections:
- id: new-models - id: new-models
title: New Data Models title: 4.1. New Data Models
repeatable: true repeatable: true
sections: sections:
- id: model - id: model
title: "{{model_name}}" title: "4.1.1. {{model_name}}"
template: | template: |
**Purpose:** {{model_purpose}} **Purpose:** {{model_purpose}}
**Integration:** {{integration_with_existing}} **Integration:** {{integration_with_existing}}
@ -161,7 +161,7 @@ sections:
- **With Existing:** {{existing_relationships}} - **With Existing:** {{existing_relationships}}
- **With New:** {{new_relationships}} - **With New:** {{new_relationships}}
- id: schema-integration - id: schema-integration
title: Schema Integration Strategy title: 4.2. Schema Integration Strategy
template: | template: |
**Database Changes Required:** **Database Changes Required:**
- **New Tables:** {{new_tables_list}} - **New Tables:** {{new_tables_list}}
@ -174,7 +174,7 @@ sections:
- {{compatibility_measure_2}} - {{compatibility_measure_2}}
- id: component-architecture - id: component-architecture
title: Component Architecture title: 5. Component Architecture
instruction: | instruction: |
Define new components and their integration with existing architecture: Define new components and their integration with existing architecture:
@ -187,11 +187,11 @@ sections:
elicit: true elicit: true
sections: sections:
- id: new-components - id: new-components
title: New Components title: 5.1. New Components
repeatable: true repeatable: true
sections: sections:
- id: component - id: component
title: "{{component_name}}" title: "5.1.1. {{component_name}}"
template: | template: |
**Responsibility:** {{component_description}} **Responsibility:** {{component_description}}
**Integration Points:** {{integration_points}} **Integration Points:** {{integration_points}}
@ -206,13 +206,13 @@ sections:
**Technology Stack:** {{component_tech_details}} **Technology Stack:** {{component_tech_details}}
- id: interaction-diagram - id: interaction-diagram
title: Component Interaction Diagram title: 5.2. Component Interaction Diagram
type: mermaid type: mermaid
mermaid_type: graph mermaid_type: graph
instruction: Create Mermaid diagram showing how new components interact with existing ones instruction: Create Mermaid diagram showing how new components interact with existing ones
- id: api-design - id: api-design
title: API Design and Integration title: 6. API Design and Integration
condition: Enhancement requires API changes condition: Enhancement requires API changes
instruction: | instruction: |
Define new API endpoints and integration with existing APIs: Define new API endpoints and integration with existing APIs:
@ -224,17 +224,17 @@ sections:
elicit: true elicit: true
sections: sections:
- id: api-strategy - id: api-strategy
title: API Integration Strategy title: 6.1. API Integration Strategy
template: | template: |
**API Integration Strategy:** {{api_integration_strategy}} **API Integration Strategy:** {{api_integration_strategy}}
**Authentication:** {{auth_integration}} **Authentication:** {{auth_integration}}
**Versioning:** {{versioning_approach}} **Versioning:** {{versioning_approach}}
- id: new-endpoints - id: new-endpoints
title: New API Endpoints title: 6.2. New API Endpoints
repeatable: true repeatable: true
sections: sections:
- id: endpoint - id: endpoint
title: "{{endpoint_name}}" title: "6.2.1. {{endpoint_name}}"
template: | template: |
- **Method:** {{http_method}} - **Method:** {{http_method}}
- **Endpoint:** {{endpoint_path}} - **Endpoint:** {{endpoint_path}}
@ -242,24 +242,24 @@ sections:
- **Integration:** {{integration_with_existing}} - **Integration:** {{integration_with_existing}}
sections: sections:
- id: request - id: request
title: Request title: 6.2.1.1. Request
type: code type: code
language: json language: json
template: "{{request_schema}}" template: "{{request_schema}}"
- id: response - id: response
title: Response title: 6.2.1.2. Response
type: code type: code
language: json language: json
template: "{{response_schema}}" template: "{{response_schema}}"
- id: external-api-integration - id: external-api-integration
title: External API Integration title: 7. External API Integration
condition: Enhancement requires new external APIs condition: Enhancement requires new external APIs
instruction: Document new external API integrations required for the enhancement instruction: Document new external API integrations required for the enhancement
repeatable: true repeatable: true
sections: sections:
- id: external-api - id: external-api
title: "{{api_name}} API" title: "7.1. {{api_name}} API"
template: | template: |
- **Purpose:** {{api_purpose}} - **Purpose:** {{api_purpose}}
- **Documentation:** {{api_docs_url}} - **Documentation:** {{api_docs_url}}
@ -273,7 +273,7 @@ sections:
**Error Handling:** {{error_handling_strategy}} **Error Handling:** {{error_handling_strategy}}
- id: source-tree-integration - id: source-tree-integration
title: Source Tree Integration title: 8. Source Tree Integration
instruction: | instruction: |
Define how new code will integrate with existing project structure: Define how new code will integrate with existing project structure:
@ -284,13 +284,13 @@ sections:
elicit: true elicit: true
sections: sections:
- id: existing-structure - id: existing-structure
title: Existing Project Structure title: 8.1. Existing Project Structure
type: code type: code
language: plaintext language: plaintext
instruction: Document relevant parts of current structure instruction: Document relevant parts of current structure
template: "{{existing_structure_relevant_parts}}" template: "{{existing_structure_relevant_parts}}"
- id: new-file-organization - id: new-file-organization
title: New File Organization title: 8.2. New File Organization
type: code type: code
language: plaintext language: plaintext
instruction: Show only new additions to existing structure instruction: Show only new additions to existing structure
@ -305,14 +305,14 @@ sections:
│ │ └── {{new_file_3}} # New addition │ │ └── {{new_file_3}} # New addition
│ └── {{new_folder_2}}/ # {{purpose_2}} │ └── {{new_folder_2}}/ # {{purpose_2}}
- id: integration-guidelines - id: integration-guidelines
title: Integration Guidelines title: 8.3. Integration Guidelines
template: | template: |
- **File Naming:** {{file_naming_consistency}} - **File Naming:** {{file_naming_consistency}}
- **Folder Organization:** {{folder_organization_approach}} - **Folder Organization:** {{folder_organization_approach}}
- **Import/Export Patterns:** {{import_export_consistency}} - **Import/Export Patterns:** {{import_export_consistency}}
- id: infrastructure-deployment - id: infrastructure-deployment
title: Infrastructure and Deployment Integration title: 9. Infrastructure and Deployment Integration
instruction: | instruction: |
Define how the enhancement will be deployed alongside existing infrastructure: Define how the enhancement will be deployed alongside existing infrastructure:
@ -323,26 +323,26 @@ sections:
elicit: true elicit: true
sections: sections:
- id: existing-infrastructure - id: existing-infrastructure
title: Existing Infrastructure title: 9.1. Existing Infrastructure
template: | template: |
**Current Deployment:** {{existing_deployment_summary}} **Current Deployment:** {{existing_deployment_summary}}
**Infrastructure Tools:** {{existing_infrastructure_tools}} **Infrastructure Tools:** {{existing_infrastructure_tools}}
**Environments:** {{existing_environments}} **Environments:** {{existing_environments}}
- id: enhancement-deployment - id: enhancement-deployment
title: Enhancement Deployment Strategy title: 9.2. Enhancement Deployment Strategy
template: | template: |
**Deployment Approach:** {{deployment_approach}} **Deployment Approach:** {{deployment_approach}}
**Infrastructure Changes:** {{infrastructure_changes}} **Infrastructure Changes:** {{infrastructure_changes}}
**Pipeline Integration:** {{pipeline_integration}} **Pipeline Integration:** {{pipeline_integration}}
- id: rollback-strategy - id: rollback-strategy
title: Rollback Strategy title: 9.3. Rollback Strategy
template: | template: |
**Rollback Method:** {{rollback_method}} **Rollback Method:** {{rollback_method}}
**Risk Mitigation:** {{risk_mitigation}} **Risk Mitigation:** {{risk_mitigation}}
**Monitoring:** {{monitoring_approach}} **Monitoring:** {{monitoring_approach}}
- id: coding-standards - id: coding-standards
title: Coding Standards and Conventions title: 10. Coding Standards and Conventions
instruction: | instruction: |
Ensure new code follows existing project conventions: Ensure new code follows existing project conventions:
@ -353,19 +353,19 @@ sections:
elicit: true elicit: true
sections: sections:
- id: existing-standards - id: existing-standards
title: Existing Standards Compliance title: 10.1. Existing Standards Compliance
template: | template: |
**Code Style:** {{existing_code_style}} **Code Style:** {{existing_code_style}}
**Linting Rules:** {{existing_linting}} **Linting Rules:** {{existing_linting}}
**Testing Patterns:** {{existing_test_patterns}} **Testing Patterns:** {{existing_test_patterns}}
**Documentation Style:** {{existing_doc_style}} **Documentation Style:** {{existing_doc_style}}
- id: enhancement-standards - id: enhancement-standards
title: Enhancement-Specific Standards title: 10.2. Enhancement-Specific Standards
condition: New patterns needed for enhancement condition: New patterns needed for enhancement
repeatable: true repeatable: true
template: "- **{{standard_name}}:** {{standard_description}}" template: "- **{{standard_name}}:** {{standard_description}}"
- id: integration-rules - id: integration-rules
title: Critical Integration Rules title: 10.3. Critical Integration Rules
template: | template: |
- **Existing API Compatibility:** {{api_compatibility_rule}} - **Existing API Compatibility:** {{api_compatibility_rule}}
- **Database Integration:** {{db_integration_rule}} - **Database Integration:** {{db_integration_rule}}
@ -373,7 +373,7 @@ sections:
- **Logging Consistency:** {{logging_consistency}} - **Logging Consistency:** {{logging_consistency}}
- id: testing-strategy - id: testing-strategy
title: Testing Strategy title: 11. Testing Strategy
instruction: | instruction: |
Define testing approach for the enhancement: Define testing approach for the enhancement:
@ -384,36 +384,36 @@ sections:
elicit: true elicit: true
sections: sections:
- id: existing-test-integration - id: existing-test-integration
title: Integration with Existing Tests title: 11.1. Integration with Existing Tests
template: | template: |
**Existing Test Framework:** {{existing_test_framework}} **Existing Test Framework:** {{existing_test_framework}}
**Test Organization:** {{existing_test_organization}} **Test Organization:** {{existing_test_organization}}
**Coverage Requirements:** {{existing_coverage_requirements}} **Coverage Requirements:** {{existing_coverage_requirements}}
- id: new-testing - id: new-testing
title: New Testing Requirements title: 11.2. New Testing Requirements
sections: sections:
- id: unit-tests - id: unit-tests
title: Unit Tests for New Components title: 11.2.1. Unit Tests for New Components
template: | template: |
- **Framework:** {{test_framework}} - **Framework:** {{test_framework}}
- **Location:** {{test_location}} - **Location:** {{test_location}}
- **Coverage Target:** {{coverage_target}} - **Coverage Target:** {{coverage_target}}
- **Integration with Existing:** {{test_integration}} - **Integration with Existing:** {{test_integration}}
- id: integration-tests - id: integration-tests
title: Integration Tests title: 11.2.2. Integration Tests
template: | template: |
- **Scope:** {{integration_test_scope}} - **Scope:** {{integration_test_scope}}
- **Existing System Verification:** {{existing_system_verification}} - **Existing System Verification:** {{existing_system_verification}}
- **New Feature Testing:** {{new_feature_testing}} - **New Feature Testing:** {{new_feature_testing}}
- id: regression-tests - id: regression-tests
title: Regression Testing title: 11.2.3. Regression Testing
template: | template: |
- **Existing Feature Verification:** {{regression_test_approach}} - **Existing Feature Verification:** {{regression_test_approach}}
- **Automated Regression Suite:** {{automated_regression}} - **Automated Regression Suite:** {{automated_regression}}
- **Manual Testing Requirements:** {{manual_testing_requirements}} - **Manual Testing Requirements:** {{manual_testing_requirements}}
- id: security-integration - id: security-integration
title: Security Integration title: 12. Security Integration
instruction: | instruction: |
Ensure security consistency with existing system: Ensure security consistency with existing system:
@ -424,31 +424,31 @@ sections:
elicit: true elicit: true
sections: sections:
- id: existing-security - id: existing-security
title: Existing Security Measures title: 12.1. Existing Security Measures
template: | template: |
**Authentication:** {{existing_auth}} **Authentication:** {{existing_auth}}
**Authorization:** {{existing_authz}} **Authorization:** {{existing_authz}}
**Data Protection:** {{existing_data_protection}} **Data Protection:** {{existing_data_protection}}
**Security Tools:** {{existing_security_tools}} **Security Tools:** {{existing_security_tools}}
- id: enhancement-security - id: enhancement-security
title: Enhancement Security Requirements title: 12.2. Enhancement Security Requirements
template: | template: |
**New Security Measures:** {{new_security_measures}} **New Security Measures:** {{new_security_measures}}
**Integration Points:** {{security_integration_points}} **Integration Points:** {{security_integration_points}}
**Compliance Requirements:** {{compliance_requirements}} **Compliance Requirements:** {{compliance_requirements}}
- id: security-testing - id: security-testing
title: Security Testing title: 12.3. Security Testing
template: | template: |
**Existing Security Tests:** {{existing_security_tests}} **Existing Security Tests:** {{existing_security_tests}}
**New Security Test Requirements:** {{new_security_tests}} **New Security Test Requirements:** {{new_security_tests}}
**Penetration Testing:** {{pentest_requirements}} **Penetration Testing:** {{pentest_requirements}}
- id: checklist-results - id: checklist-results
title: Checklist Results Report title: 13. Checklist Results Report
instruction: Execute the architect-checklist and populate results here, focusing on brownfield-specific validation instruction: Execute the architect-checklist and populate results here, focusing on brownfield-specific validation
- id: next-steps - id: next-steps
title: Next Steps title: 14. Next Steps
instruction: | instruction: |
After completing the brownfield architecture: After completing the brownfield architecture:
@ -458,7 +458,7 @@ sections:
4. Plan rollback and monitoring procedures 4. Plan rollback and monitoring procedures
sections: sections:
- id: story-manager-handoff - id: story-manager-handoff
title: Story Manager Handoff title: 14.1. Story Manager Handoff
instruction: | instruction: |
Create a brief prompt for Story Manager to work with this brownfield enhancement. Include: Create a brief prompt for Story Manager to work with this brownfield enhancement. Include:
- Reference to this architecture document - Reference to this architecture document
@ -467,7 +467,7 @@ sections:
- First story to implement with clear integration checkpoints - First story to implement with clear integration checkpoints
- Emphasis on maintaining existing system integrity throughout implementation - Emphasis on maintaining existing system integrity throughout implementation
- id: developer-handoff - id: developer-handoff
title: Developer Handoff title: 14.2. Developer Handoff
instruction: | instruction: |
Create a brief prompt for developers starting implementation. Include: Create a brief prompt for developers starting implementation. Include:
- Reference to this architecture and existing coding standards analyzed from actual project - Reference to this architecture and existing coding standards analyzed from actual project

68
bmad-core/templates/brownfield-prd-tmpl.yaml
View File

@ -14,7 +14,7 @@ workflow:
sections: sections:
- id: intro-analysis - id: intro-analysis
title: Intro Project Analysis and Context title: 1. Intro Project Analysis and Context
instruction: | instruction: |
IMPORTANT - SCOPE ASSESSMENT REQUIRED: IMPORTANT - SCOPE ASSESSMENT REQUIRED:
@ -33,23 +33,23 @@ sections:
Do not proceed with any recommendations until the user has validated your understanding of the existing system. Do not proceed with any recommendations until the user has validated your understanding of the existing system.
sections: sections:
- id: existing-project-overview - id: existing-project-overview
title: Existing Project Overview title: 1.1. Existing Project Overview
instruction: Check if document-project analysis was already performed. If yes, reference that output instead of re-analyzing. instruction: Check if document-project analysis was already performed. If yes, reference that output instead of re-analyzing.
sections: sections:
- id: analysis-source - id: analysis-source
title: Analysis Source title: 1.1.1. Analysis Source
instruction: | instruction: |
Indicate one of the following: Indicate one of the following:
- Document-project output available at: {{path}} - Document-project output available at: {{path}}
- IDE-based fresh analysis - IDE-based fresh analysis
- User-provided information - User-provided information
- id: current-state - id: current-state
title: Current Project State title: 1.1.2. Current Project State
instruction: | instruction: |
- If document-project output exists: Extract summary from "High Level Architecture" and "Technical Summary" sections - 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 - Otherwise: Brief description of what the project currently does and its primary purpose
- id: documentation-analysis - id: documentation-analysis
title: Available Documentation Analysis title: 1.2. Available Documentation Analysis
instruction: | instruction: |
If document-project was run: If document-project was run:
- Note: "Document-project analysis available - using existing technical documentation" - Note: "Document-project analysis available - using existing technical documentation"
@ -59,7 +59,7 @@ sections:
Otherwise, check for existing documentation: Otherwise, check for existing documentation:
sections: sections:
- id: available-docs - id: available-docs
title: Available Documentation title: 1.2.1. Available Documentation
type: checklist type: checklist
items: items:
- Tech Stack Documentation [[LLM: If from document-project, check ✓]] - Tech Stack Documentation [[LLM: If from document-project, check ✓]]
@ -74,11 +74,11 @@ sections:
- If document-project was already run: "Using existing project analysis from document-project output." - 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..." - If critical documentation is missing and no document-project: "I recommend running the document-project task first..."
- id: enhancement-scope - id: enhancement-scope
title: Enhancement Scope Definition title: 1.3. Enhancement Scope Definition
instruction: Work with user to clearly define what type of enhancement this is. This is critical for scoping and approach. instruction: Work with user to clearly define what type of enhancement this is. This is critical for scoping and approach.
sections: sections:
- id: enhancement-type - id: enhancement-type
title: Enhancement Type title: 1.3.1. Enhancement Type
type: checklist type: checklist
instruction: Determine with user which applies instruction: Determine with user which applies
items: items:
@ -91,10 +91,10 @@ sections:
- Bug Fix and Stability Improvements - Bug Fix and Stability Improvements
- "Other: {{other_type}}" - "Other: {{other_type}}"
- id: enhancement-description - id: enhancement-description
title: Enhancement Description title: 1.3.2. Enhancement Description
instruction: 2-3 sentences describing what the user wants to add or change instruction: 2-3 sentences describing what the user wants to add or change
- id: impact-assessment - id: impact-assessment
title: Impact Assessment title: 1.3.3. Impact Assessment
type: checklist type: checklist
instruction: Assess the scope of impact on existing codebase instruction: Assess the scope of impact on existing codebase
items: items:
@ -103,43 +103,43 @@ sections:
- Significant Impact (substantial existing code changes) - Significant Impact (substantial existing code changes)
- Major Impact (architectural changes required) - Major Impact (architectural changes required)
- id: goals-context - id: goals-context
title: Goals and Background Context title: 1.4. Goals and Background Context
sections: sections:
- id: goals - id: goals
title: Goals title: 1.4.1. Goals
type: bullet-list type: bullet-list
instruction: Bullet list of 1-line desired outcomes this enhancement will deliver if successful instruction: Bullet list of 1-line desired outcomes this enhancement will deliver if successful
- id: background - id: background
title: Background Context title: 1.4.2. Background Context
type: paragraphs 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 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 - id: changelog
title: Change Log title: 1.5. Change Log
type: table type: table
columns: [Change, Date, Version, Description, Author] columns: [Change, Date, Version, Description, Author]
- id: requirements - id: requirements
title: Requirements title: 2. Requirements
instruction: | 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." 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 elicit: true
sections: sections:
- id: functional - id: functional
title: Functional title: 2.1. Functional
type: numbered-list type: numbered-list
prefix: FR prefix: FR
instruction: Each Requirement will be a bullet markdown with identifier starting with FR instruction: Each Requirement will be a bullet markdown with identifier starting with FR
examples: examples:
- "FR1: The existing Todo List will integrate with the new AI duplicate detection service without breaking current functionality." - "FR1: The existing Todo List will integrate with the new AI duplicate detection service without breaking current functionality."
- id: non-functional - id: non-functional
title: Non Functional title: 2.2. Non Functional
type: numbered-list type: numbered-list
prefix: NFR prefix: NFR
instruction: Each Requirement will be a bullet markdown with identifier starting with NFR. Include constraints from existing system instruction: Each Requirement will be a bullet markdown with identifier starting with NFR. Include constraints from existing system
examples: examples:
- "NFR1: Enhancement must maintain existing performance characteristics and not exceed current memory usage by more than 20%." - "NFR1: Enhancement must maintain existing performance characteristics and not exceed current memory usage by more than 20%."
- id: compatibility - id: compatibility
title: Compatibility Requirements title: 2.3. Compatibility Requirements
instruction: Critical for brownfield - what must remain compatible instruction: Critical for brownfield - what must remain compatible
type: numbered-list type: numbered-list
prefix: CR prefix: CR
@ -155,26 +155,26 @@ sections:
template: "CR4: {{integration_compatibility}}" template: "CR4: {{integration_compatibility}}"
- id: ui-enhancement-goals - id: ui-enhancement-goals
title: User Interface Enhancement Goals title: 3. User Interface Enhancement Goals
condition: Enhancement includes UI changes condition: Enhancement includes UI changes
instruction: For UI changes, capture how they will integrate with existing UI patterns and design systems instruction: For UI changes, capture how they will integrate with existing UI patterns and design systems
sections: sections:
- id: existing-ui-integration - id: existing-ui-integration
title: Integration with Existing UI title: 3.1. Integration with Existing UI
instruction: Describe how new UI elements will fit with existing design patterns, style guides, and component libraries instruction: Describe how new UI elements will fit with existing design patterns, style guides, and component libraries
- id: modified-screens - id: modified-screens
title: Modified/New Screens and Views title: 3.2. Modified/New Screens and Views
instruction: List only the screens/views that will be modified or added instruction: List only the screens/views that will be modified or added
- id: ui-consistency - id: ui-consistency
title: UI Consistency Requirements title: 3.3. UI Consistency Requirements
instruction: Specific requirements for maintaining visual and interaction consistency with existing application instruction: Specific requirements for maintaining visual and interaction consistency with existing application
- id: technical-constraints - id: technical-constraints
title: Technical Constraints and Integration Requirements title: 4. Technical Constraints and Integration Requirements
instruction: This section replaces separate architecture documentation. Gather detailed technical constraints from existing project analysis. instruction: This section replaces separate architecture documentation. Gather detailed technical constraints from existing project analysis.
sections: sections:
- id: existing-tech-stack - id: existing-tech-stack
title: Existing Technology Stack title: 4.1. Existing Technology Stack
instruction: | instruction: |
If document-project output available: If document-project output available:
- Extract from "Actual Tech Stack" table in High Level Architecture section - Extract from "Actual Tech Stack" table in High Level Architecture section
@ -188,7 +188,7 @@ sections:
**Infrastructure**: {{infrastructure}} **Infrastructure**: {{infrastructure}}
**External Dependencies**: {{external_dependencies}} **External Dependencies**: {{external_dependencies}}
- id: integration-approach - id: integration-approach
title: Integration Approach title: 4.2. Integration Approach
instruction: Define how the enhancement will integrate with existing architecture instruction: Define how the enhancement will integrate with existing architecture
template: | template: |
**Database Integration Strategy**: {{database_integration}} **Database Integration Strategy**: {{database_integration}}
@ -196,7 +196,7 @@ sections:
**Frontend Integration Strategy**: {{frontend_integration}} **Frontend Integration Strategy**: {{frontend_integration}}
**Testing Integration Strategy**: {{testing_integration}} **Testing Integration Strategy**: {{testing_integration}}
- id: code-organization - id: code-organization
title: Code Organization and Standards title: 4.3. Code Organization and Standards
instruction: Based on existing project analysis, define how new code will fit existing patterns instruction: Based on existing project analysis, define how new code will fit existing patterns
template: | template: |
**File Structure Approach**: {{file_structure}} **File Structure Approach**: {{file_structure}}
@ -204,7 +204,7 @@ sections:
**Coding Standards**: {{coding_standards}} **Coding Standards**: {{coding_standards}}
**Documentation Standards**: {{documentation_standards}} **Documentation Standards**: {{documentation_standards}}
- id: deployment-operations - id: deployment-operations
title: Deployment and Operations title: 4.4. Deployment and Operations
instruction: How the enhancement fits existing deployment pipeline instruction: How the enhancement fits existing deployment pipeline
template: | template: |
**Build Process Integration**: {{build_integration}} **Build Process Integration**: {{build_integration}}
@ -212,7 +212,7 @@ sections:
**Monitoring and Logging**: {{monitoring_logging}} **Monitoring and Logging**: {{monitoring_logging}}
**Configuration Management**: {{config_management}} **Configuration Management**: {{config_management}}
- id: risk-assessment - id: risk-assessment
title: Risk Assessment and Mitigation title: 4.5. Risk Assessment and Mitigation
instruction: | instruction: |
If document-project output available: If document-project output available:
- Reference "Technical Debt and Known Issues" section - Reference "Technical Debt and Known Issues" section
@ -227,18 +227,18 @@ sections:
**Mitigation Strategies**: {{mitigation_strategies}} **Mitigation Strategies**: {{mitigation_strategies}}
- id: epic-structure - id: epic-structure
title: Epic and Story Structure title: 5. Epic and Story Structure
instruction: | 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?" 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 elicit: true
sections: sections:
- id: epic-approach - id: epic-approach
title: Epic Approach title: 5.1. Epic Approach
instruction: Explain the rationale for epic structure - typically single epic for brownfield unless multiple unrelated features instruction: Explain the rationale for epic structure - typically single epic for brownfield unless multiple unrelated features
template: "**Epic Structure Decision**: {{epic_decision}} with rationale" template: "**Epic Structure Decision**: {{epic_decision}} with rationale"
- id: epic-details - id: epic-details
title: "Epic 1: {{enhancement_title}}" title: "6. Epic 1: {{enhancement_title}}"
instruction: | instruction: |
Comprehensive epic that delivers the brownfield enhancement while maintaining existing functionality Comprehensive epic that delivers the brownfield enhancement while maintaining existing functionality
@ -258,7 +258,7 @@ sections:
**Integration Requirements**: {{integration_requirements}} **Integration Requirements**: {{integration_requirements}}
sections: sections:
- id: story - id: story
title: "Story 1.{{story_number}} {{story_title}}" title: "6.1. Story 1.{{story_number}} {{story_title}}"
repeatable: true repeatable: true
template: | template: |
As a {{user_type}}, As a {{user_type}},
@ -266,12 +266,12 @@ sections:
so that {{benefit}}. so that {{benefit}}.
sections: sections:
- id: acceptance-criteria - id: acceptance-criteria
title: Acceptance Criteria title: 6.1.1. Acceptance Criteria
type: numbered-list type: numbered-list
instruction: Define criteria that include both new functionality and existing system integrity instruction: Define criteria that include both new functionality and existing system integrity
item_template: "{{criterion_number}}: {{criteria}}" item_template: "{{criterion_number}}: {{criteria}}"
- id: integration-verification - id: integration-verification
title: Integration Verification title: 6.1.2. Integration Verification
instruction: Specific verification steps to ensure existing functionality remains intact instruction: Specific verification steps to ensure existing functionality remains intact
type: numbered-list type: numbered-list
prefix: IV prefix: IV

52
bmad-core/templates/front-end-architecture-tmpl.yaml
View File

@ -14,7 +14,7 @@ workflow:
sections: sections:
- id: template-framework-selection - id: template-framework-selection
title: Template and Framework Selection title: 1. Template and Framework Selection
instruction: | 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. 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.
@ -58,18 +58,18 @@ sections:
Document the starter template decision and any constraints it imposes before proceeding. Document the starter template decision and any constraints it imposes before proceeding.
sections: sections:
- id: changelog - id: changelog
title: Change Log title: 1.1. Change Log
type: table type: table
columns: [Date, Version, Description, Author] columns: [Date, Version, Description, Author]
instruction: Track document versions and changes instruction: Track document versions and changes
- id: frontend-tech-stack - id: frontend-tech-stack
title: Frontend Tech Stack title: 2. Frontend Tech Stack
instruction: Extract from main architecture's Technology Stack Table. This section MUST remain synchronized with the main architecture document. instruction: Extract from main architecture's Technology Stack Table. This section MUST remain synchronized with the main architecture document.
elicit: true elicit: true
sections: sections:
- id: tech-stack-table - id: tech-stack-table
title: Technology Stack Table title: 2.1. Technology Stack Table
type: table type: table
columns: [Category, Technology, Version, Purpose, Rationale] columns: [Category, Technology, Version, Purpose, Rationale]
instruction: Fill in appropriate technology choices based on the selected framework and project requirements. instruction: Fill in appropriate technology choices based on the selected framework and project requirements.
@ -99,95 +99,95 @@ sections:
- ["Dev Tools", "{{dev_tools}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"] - ["Dev Tools", "{{dev_tools}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
- id: project-structure - id: project-structure
title: Project Structure title: 3. 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. 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 elicit: true
type: code type: code
language: plaintext language: plaintext
- id: component-standards - id: component-standards
title: Component Standards title: 4. Component Standards
instruction: Define exact patterns for component creation based on the chosen framework. instruction: Define exact patterns for component creation based on the chosen framework.
elicit: true elicit: true
sections: sections:
- id: component-template - id: component-template
title: Component Template title: 4.1. Component Template
instruction: Generate a minimal but complete component template following the framework's best practices. Include TypeScript types, proper imports, and basic structure. instruction: Generate a minimal but complete component template following the framework's best practices. Include TypeScript types, proper imports, and basic structure.
type: code type: code
language: typescript language: typescript
- id: naming-conventions - id: naming-conventions
title: Naming Conventions title: 4.2. Naming Conventions
instruction: Provide naming conventions specific to the chosen framework for components, files, services, state management, and other architectural elements. instruction: Provide naming conventions specific to the chosen framework for components, files, services, state management, and other architectural elements.
- id: state-management - id: state-management
title: State Management title: 5. State Management
instruction: Define state management patterns based on the chosen framework. instruction: Define state management patterns based on the chosen framework.
elicit: true elicit: true
sections: sections:
- id: store-structure - id: store-structure
title: Store Structure title: 5.1. Store Structure
instruction: Generate the state management directory structure appropriate for the chosen framework and selected state management solution. instruction: Generate the state management directory structure appropriate for the chosen framework and selected state management solution.
type: code type: code
language: plaintext language: plaintext
- id: state-template - id: state-template
title: State Management Template title: 5.2. 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. 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 type: code
language: typescript language: typescript
- id: api-integration - id: api-integration
title: API Integration title: 6. API Integration
instruction: Define API service patterns based on the chosen framework. instruction: Define API service patterns based on the chosen framework.
elicit: true elicit: true
sections: sections:
- id: service-template - id: service-template
title: Service Template title: 6.1. Service Template
instruction: Provide an API service template that follows the framework's conventions. Include proper TypeScript types, error handling, and async patterns. instruction: Provide an API service template that follows the framework's conventions. Include proper TypeScript types, error handling, and async patterns.
type: code type: code
language: typescript language: typescript
- id: api-client-config - id: api-client-config
title: API Client Configuration title: 6.2. API Client Configuration
instruction: Show how to configure the HTTP client for the chosen framework, including authentication interceptors/middleware and error handling. instruction: Show how to configure the HTTP client for the chosen framework, including authentication interceptors/middleware and error handling.
type: code type: code
language: typescript language: typescript
- id: routing - id: routing
title: Routing title: 7. Routing
instruction: Define routing structure and patterns based on the chosen framework. instruction: Define routing structure and patterns based on the chosen framework.
elicit: true elicit: true
sections: sections:
- id: route-configuration - id: route-configuration
title: Route Configuration title: 7.1. Route Configuration
instruction: Provide routing configuration appropriate for the chosen framework. Include protected route patterns, lazy loading where applicable, and authentication guards/middleware. instruction: Provide routing configuration appropriate for the chosen framework. Include protected route patterns, lazy loading where applicable, and authentication guards/middleware.
type: code type: code
language: typescript language: typescript
- id: styling-guidelines - id: styling-guidelines
title: Styling Guidelines title: 8. Styling Guidelines
instruction: Define styling approach based on the chosen framework. instruction: Define styling approach based on the chosen framework.
elicit: true elicit: true
sections: sections:
- id: styling-approach - id: styling-approach
title: Styling Approach title: 8.1. Styling Approach
instruction: Describe the styling methodology appropriate for the chosen framework (CSS Modules, Styled Components, Tailwind, etc.) and provide basic patterns. instruction: Describe the styling methodology appropriate for the chosen framework (CSS Modules, Styled Components, Tailwind, etc.) and provide basic patterns.
- id: global-theme - id: global-theme
title: Global Theme Variables title: 8.2. 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. 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 type: code
language: css language: css
- id: testing-requirements - id: testing-requirements
title: Testing Requirements title: 9. Testing Requirements
instruction: Define minimal testing requirements based on the chosen framework. instruction: Define minimal testing requirements based on the chosen framework.
elicit: true elicit: true
sections: sections:
- id: component-test-template - id: component-test-template
title: Component Test Template title: 9.1. 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. 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 type: code
language: typescript language: typescript
- id: testing-best-practices - id: testing-best-practices
title: Testing Best Practices title: 9.2. Testing Best Practices
type: numbered-list type: numbered-list
items: items:
- "**Unit Tests**: Test individual components in isolation" - "**Unit Tests**: Test individual components in isolation"
@ -198,19 +198,19 @@ sections:
- "**Mock External Dependencies**: API calls, routing, state management" - "**Mock External Dependencies**: API calls, routing, state management"
- id: environment-configuration - id: environment-configuration
title: Environment Configuration title: 10. Environment Configuration
instruction: List required environment variables based on the chosen framework. Show the appropriate format and naming conventions for the framework. instruction: List required environment variables based on the chosen framework. Show the appropriate format and naming conventions for the framework.
elicit: true elicit: true
- id: frontend-developer-standards - id: frontend-developer-standards
title: Frontend Developer Standards title: 11. Frontend Developer Standards
sections: sections:
- id: critical-coding-rules - id: critical-coding-rules
title: Critical Coding Rules title: 11.1. Critical Coding Rules
instruction: List essential rules that prevent common AI mistakes, including both universal rules and framework-specific ones. instruction: List essential rules that prevent common AI mistakes, including both universal rules and framework-specific ones.
elicit: true elicit: true
- id: quick-reference - id: quick-reference
title: Quick Reference title: 11.2. Quick Reference
instruction: | instruction: |
Create a framework-specific cheat sheet with: Create a framework-specific cheat sheet with:
- Common commands (dev server, build, test) - Common commands (dev server, build, test)

166
bmad-core/templates/fullstack-architecture-tmpl.yaml
View File

@ -14,7 +14,7 @@ workflow:
sections: sections:
- id: introduction - id: introduction
title: Introduction title: 1. Introduction
instruction: | instruction: |
If available, review any provided relevant documents to gather all relevant context before beginning. At minimum, you should have access to docs/prd.md and docs/front-end-spec.md. Ask the user for any documents you need but cannot locate. This template creates a unified architecture that covers both backend and frontend concerns to guide AI-driven fullstack development. If available, review any provided relevant documents to gather all relevant context before beginning. At minimum, you should have access to docs/prd.md and docs/front-end-spec.md. Ask the user for any documents you need but cannot locate. This template creates a unified architecture that covers both backend and frontend concerns to guide AI-driven fullstack development.
elicit: true elicit: true
@ -24,7 +24,7 @@ sections:
This unified approach combines what would traditionally be separate backend and frontend architecture documents, streamlining the development process for modern fullstack applications where these concerns are increasingly intertwined. This unified approach combines what would traditionally be separate backend and frontend architecture documents, streamlining the development process for modern fullstack applications where these concerns are increasingly intertwined.
sections: sections:
- id: starter-template - id: starter-template
title: Starter Template or Existing Project title: 1.1. Starter Template or Existing Project
instruction: | instruction: |
Before proceeding with architecture design, check if the project is based on any starter templates or existing codebases: Before proceeding with architecture design, check if the project is based on any starter templates or existing codebases:
@ -49,18 +49,18 @@ sections:
If none, state "N/A - Greenfield project" If none, state "N/A - Greenfield project"
- id: changelog - id: changelog
title: Change Log title: 1.2. Change Log
type: table type: table
columns: [Date, Version, Description, Author] columns: [Date, Version, Description, Author]
instruction: Track document versions and changes instruction: Track document versions and changes
- id: high-level-architecture - id: high-level-architecture
title: High Level Architecture title: 2. High Level Architecture
instruction: This section contains multiple subsections that establish the foundation. Present all subsections together, then elicit feedback on the complete section. instruction: This section contains multiple subsections that establish the foundation. Present all subsections together, then elicit feedback on the complete section.
elicit: true elicit: true
sections: sections:
- id: technical-summary - id: technical-summary
title: Technical Summary title: 2.1. Technical Summary
instruction: | instruction: |
Provide a comprehensive overview (4-6 sentences) covering: Provide a comprehensive overview (4-6 sentences) covering:
- Overall architectural style and deployment approach - Overall architectural style and deployment approach
@ -69,7 +69,7 @@ sections:
- Infrastructure platform and services - Infrastructure platform and services
- How this architecture achieves PRD goals - How this architecture achieves PRD goals
- id: platform-infrastructure - id: platform-infrastructure
title: Platform and Infrastructure Choice title: 2.2. Platform and Infrastructure Choice
instruction: | instruction: |
Based on PRD requirements and technical assumptions, make a platform recommendation: Based on PRD requirements and technical assumptions, make a platform recommendation:
@ -89,7 +89,7 @@ sections:
**Key Services:** {{core_services_list}} **Key Services:** {{core_services_list}}
**Deployment Host and Regions:** {{regions}} **Deployment Host and Regions:** {{regions}}
- id: repository-structure - id: repository-structure
title: Repository Structure title: 2.3. Repository Structure
instruction: | instruction: |
Define the repository approach based on PRD requirements and platform choice, explain your rationale or ask questions to the user if unsure: Define the repository approach based on PRD requirements and platform choice, explain your rationale or ask questions to the user if unsure:
@ -102,7 +102,7 @@ sections:
**Monorepo Tool:** {{monorepo_tool_if_applicable}} **Monorepo Tool:** {{monorepo_tool_if_applicable}}
**Package Organization:** {{package_strategy}} **Package Organization:** {{package_strategy}}
- id: architecture-diagram - id: architecture-diagram
title: High Level Architecture Diagram title: 2.4. High Level Architecture Diagram
type: mermaid type: mermaid
mermaid_type: graph mermaid_type: graph
instruction: | instruction: |
@ -117,7 +117,7 @@ sections:
Use appropriate diagram type for clarity. Use appropriate diagram type for clarity.
- id: architectural-patterns - id: architectural-patterns
title: Architectural Patterns title: 2.5. Architectural Patterns
instruction: | instruction: |
List patterns that will guide both frontend and backend development. Include patterns for: List patterns that will guide both frontend and backend development. Include patterns for:
- Overall architecture (e.g., Jamstack, Serverless, Microservices) - Overall architecture (e.g., Jamstack, Serverless, Microservices)
@ -135,7 +135,7 @@ sections:
- "**API Gateway Pattern:** Single entry point for all API calls - _Rationale:_ Centralized auth, rate limiting, and monitoring" - "**API Gateway Pattern:** Single entry point for all API calls - _Rationale:_ Centralized auth, rate limiting, and monitoring"
- id: tech-stack - id: tech-stack
title: Tech Stack title: 3. Tech Stack
instruction: | instruction: |
This is the DEFINITIVE technology selection for the entire project. Work with user to finalize all choices. This table is the single source of truth - all development must use these exact versions. This is the DEFINITIVE technology selection for the entire project. Work with user to finalize all choices. This table is the single source of truth - all development must use these exact versions.
@ -152,7 +152,7 @@ sections:
elicit: true elicit: true
sections: sections:
- id: tech-stack-table - id: tech-stack-table
title: Technology Stack Table title: 3.1. Technology Stack Table
type: table type: table
columns: [Category, Technology, Version, Purpose, Rationale] columns: [Category, Technology, Version, Purpose, Rationale]
rows: rows:
@ -197,7 +197,7 @@ sections:
- ["CSS Framework", "{{css_framework}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"] - ["CSS Framework", "{{css_framework}}", "{{version}}", "{{purpose}}", "{{why_chosen}}"]
- id: data-models - id: data-models
title: Data Models title: 4. Data Models
instruction: | instruction: |
Define the core data models/entities that will be shared between frontend and backend: Define the core data models/entities that will be shared between frontend and backend:
@ -232,7 +232,7 @@ sections:
template: "- {{relationship}}" template: "- {{relationship}}"
- id: api-spec - id: api-spec
title: API Specification title: 5. API Specification
instruction: | instruction: |
Based on the chosen API style from Tech Stack: Based on the chosen API style from Tech Stack:
@ -248,7 +248,7 @@ sections:
elicit: true elicit: true
sections: sections:
- id: rest-api - id: rest-api
title: REST API Specification title: 5.1. REST API Specification
condition: API style is REST condition: API style is REST
type: code type: code
language: yaml language: yaml
@ -262,20 +262,20 @@ sections:
- url: {{server_url}} - url: {{server_url}}
description: {{server_description}} description: {{server_description}}
- id: graphql-api - id: graphql-api
title: GraphQL Schema title: 5.2. GraphQL Schema
condition: API style is GraphQL condition: API style is GraphQL
type: code type: code
language: graphql language: graphql
template: "{{graphql_schema}}" template: "{{graphql_schema}}"
- id: trpc-api - id: trpc-api
title: tRPC Router Definitions title: 5.3. tRPC Router Definitions
condition: API style is tRPC condition: API style is tRPC
type: code type: code
language: typescript language: typescript
template: "{{trpc_routers}}" template: "{{trpc_routers}}"
- id: components - id: components
title: Components title: 6. Components
instruction: | instruction: |
Based on the architectural patterns, tech stack, and data models from above: Based on the architectural patterns, tech stack, and data models from above:
@ -305,7 +305,7 @@ sections:
**Technology Stack:** {{component_tech_details}} **Technology Stack:** {{component_tech_details}}
- id: component-diagrams - id: component-diagrams
title: Component Diagrams title: 6.1. Component Diagrams
type: mermaid type: mermaid
instruction: | instruction: |
Create Mermaid diagrams to visualize component relationships. Options: Create Mermaid diagrams to visualize component relationships. Options:
@ -315,7 +315,7 @@ sections:
Choose the most appropriate for clarity Choose the most appropriate for clarity
- id: external-apis - id: external-apis
title: External APIs title: 7. External APIs
condition: Project requires external API integrations condition: Project requires external API integrations
instruction: | instruction: |
For each external service integration: For each external service integration:
@ -345,7 +345,7 @@ sections:
**Integration Notes:** {{integration_considerations}} **Integration Notes:** {{integration_considerations}}
- id: core-workflows - id: core-workflows
title: Core Workflows title: 8. Core Workflows
type: mermaid type: mermaid
mermaid_type: sequence mermaid_type: sequence
instruction: | instruction: |
@ -362,7 +362,7 @@ sections:
elicit: true elicit: true
- id: database-schema - id: database-schema
title: Database Schema title: 9. Database Schema
instruction: | instruction: |
Transform the conceptual data models into concrete database schemas: Transform the conceptual data models into concrete database schemas:
@ -376,85 +376,85 @@ sections:
elicit: true elicit: true
- id: frontend-architecture - id: frontend-architecture
title: Frontend Architecture title: 10. Frontend Architecture
instruction: Define frontend-specific architecture details. After each subsection, note if user wants to refine before continuing. instruction: Define frontend-specific architecture details. After each subsection, note if user wants to refine before continuing.
elicit: true elicit: true
sections: sections:
- id: component-architecture - id: component-architecture
title: Component Architecture title: 10.1. Component Architecture
instruction: Define component organization and patterns based on chosen framework. instruction: Define component organization and patterns based on chosen framework.
sections: sections:
- id: component-organization - id: component-organization
title: Component Organization title: 10.1.1. Component Organization
type: code type: code
language: text language: text
template: "{{component_structure}}" template: "{{component_structure}}"
- id: component-template - id: component-template
title: Component Template title: 10.1.2. Component Template
type: code type: code
language: typescript language: typescript
template: "{{component_template}}" template: "{{component_template}}"
- id: state-management - id: state-management
title: State Management Architecture title: 10.2. State Management Architecture
instruction: Detail state management approach based on chosen solution. instruction: Detail state management approach based on chosen solution.
sections: sections:
- id: state-structure - id: state-structure
title: State Structure title: 10.2.1. State Structure
type: code type: code
language: typescript language: typescript
template: "{{state_structure}}" template: "{{state_structure}}"
- id: state-patterns - id: state-patterns
title: State Management Patterns title: 10.2.2. State Management Patterns
type: bullet-list type: bullet-list
template: "- {{pattern}}" template: "- {{pattern}}"
- id: routing-architecture - id: routing-architecture
title: Routing Architecture title: 10.3. Routing Architecture
instruction: Define routing structure based on framework choice. instruction: Define routing structure based on framework choice.
sections: sections:
- id: route-organization - id: route-organization
title: Route Organization title: 10.3.1. Route Organization
type: code type: code
language: text language: text
template: "{{route_structure}}" template: "{{route_structure}}"
- id: protected-routes - id: protected-routes
title: Protected Route Pattern title: 10.3.2. Protected Route Pattern
type: code type: code
language: typescript language: typescript
template: "{{protected_route_example}}" template: "{{protected_route_example}}"
- id: frontend-services - id: frontend-services
title: Frontend Services Layer title: 10.4. Frontend Services Layer
instruction: Define how frontend communicates with backend. instruction: Define how frontend communicates with backend.
sections: sections:
- id: api-client-setup - id: api-client-setup
title: API Client Setup title: 10.4.1. API Client Setup
type: code type: code
language: typescript language: typescript
template: "{{api_client_setup}}" template: "{{api_client_setup}}"
- id: service-example - id: service-example
title: Service Example title: 10.4.2. Service Example
type: code type: code
language: typescript language: typescript
template: "{{service_example}}" template: "{{service_example}}"
- id: backend-architecture - id: backend-architecture
title: Backend Architecture title: 11. Backend Architecture
instruction: Define backend-specific architecture details. Consider serverless vs traditional server approaches. instruction: Define backend-specific architecture details. Consider serverless vs traditional server approaches.
elicit: true elicit: true
sections: sections:
- id: service-architecture - id: service-architecture
title: Service Architecture title: 11.1. Service Architecture
instruction: Based on platform choice, define service organization. instruction: Based on platform choice, define service organization.
sections: sections:
- id: serverless-architecture - id: serverless-architecture
condition: Serverless architecture chosen condition: Serverless architecture chosen
sections: sections:
- id: function-organization - id: function-organization
title: Function Organization title: 11.1.1. Function Organization
type: code type: code
language: text language: text
template: "{{function_structure}}" template: "{{function_structure}}"
- id: function-template - id: function-template
title: Function Template title: 11.1.2. Function Template
type: code type: code
language: typescript language: typescript
template: "{{function_template}}" template: "{{function_template}}"
@ -462,46 +462,46 @@ sections:
condition: Traditional server architecture chosen condition: Traditional server architecture chosen
sections: sections:
- id: controller-organization - id: controller-organization
title: Controller/Route Organization title: 11.1.3. Controller/Route Organization
type: code type: code
language: text language: text
template: "{{controller_structure}}" template: "{{controller_structure}}"
- id: controller-template - id: controller-template
title: Controller Template title: 11.1.4. Controller Template
type: code type: code
language: typescript language: typescript
template: "{{controller_template}}" template: "{{controller_template}}"
- id: database-architecture - id: database-architecture
title: Database Architecture title: 11.2. Database Architecture
instruction: Define database schema and access patterns. instruction: Define database schema and access patterns.
sections: sections:
- id: schema-design - id: schema-design
title: Schema Design title: 11.2.1. Schema Design
type: code type: code
language: sql language: sql
template: "{{database_schema}}" template: "{{database_schema}}"
- id: data-access-layer - id: data-access-layer
title: Data Access Layer title: 11.2.2. Data Access Layer
type: code type: code
language: typescript language: typescript
template: "{{repository_pattern}}" template: "{{repository_pattern}}"
- id: auth-architecture - id: auth-architecture
title: Authentication and Authorization title: 11.3. Authentication and Authorization
instruction: Define auth implementation details. instruction: Define auth implementation details.
sections: sections:
- id: auth-flow - id: auth-flow
title: Auth Flow title: 11.3.1. Auth Flow
type: mermaid type: mermaid
mermaid_type: sequence mermaid_type: sequence
template: "{{auth_flow_diagram}}" template: "{{auth_flow_diagram}}"
- id: auth-middleware - id: auth-middleware
title: Middleware/Guards title: 11.3.2. Middleware/Guards
type: code type: code
language: typescript language: typescript
template: "{{auth_middleware}}" template: "{{auth_middleware}}"
- id: unified-project-structure - id: unified-project-structure
title: Unified Project Structure title: 12. Unified Project Structure
instruction: Create a monorepo structure that accommodates both frontend and backend. Adapt based on chosen tools and frameworks. instruction: Create a monorepo structure that accommodates both frontend and backend. Adapt based on chosen tools and frameworks.
elicit: true elicit: true
type: code type: code
@ -563,25 +563,25 @@ sections:
└── README.md └── README.md
- id: development-workflow - id: development-workflow
title: Development Workflow title: 13. Development Workflow
instruction: Define the development setup and workflow for the fullstack application. instruction: Define the development setup and workflow for the fullstack application.
elicit: true elicit: true
sections: sections:
- id: local-setup - id: local-setup
title: Local Development Setup title: 13.1. Local Development Setup
sections: sections:
- id: prerequisites - id: prerequisites
title: Prerequisites title: 13.1.1. Prerequisites
type: code type: code
language: bash language: bash
template: "{{prerequisites_commands}}" template: "{{prerequisites_commands}}"
- id: initial-setup - id: initial-setup
title: Initial Setup title: 13.1.2. Initial Setup
type: code type: code
language: bash language: bash
template: "{{setup_commands}}" template: "{{setup_commands}}"
- id: dev-commands - id: dev-commands
title: Development Commands title: 13.1.3. Development Commands
type: code type: code
language: bash language: bash
template: | template: |
@ -597,10 +597,10 @@ sections:
# Run tests # Run tests
{{test_commands}} {{test_commands}}
- id: environment-config - id: environment-config
title: Environment Configuration title: 13.2. Environment Configuration
sections: sections:
- id: env-vars - id: env-vars
title: Required Environment Variables title: 13.2.1. Required Environment Variables
type: code type: code
language: bash language: bash
template: | template: |
@ -614,12 +614,12 @@ sections:
{{shared_env_vars}} {{shared_env_vars}}
- id: deployment-architecture - id: deployment-architecture
title: Deployment Architecture title: 14. Deployment Architecture
instruction: Define deployment strategy based on platform choice. instruction: Define deployment strategy based on platform choice.
elicit: true elicit: true
sections: sections:
- id: deployment-strategy - id: deployment-strategy
title: Deployment Strategy title: 14.1. Deployment Strategy
template: | template: |
**Frontend Deployment:** **Frontend Deployment:**
- **Platform:** {{frontend_deploy_platform}} - **Platform:** {{frontend_deploy_platform}}
@ -632,12 +632,12 @@ sections:
- **Build Command:** {{backend_build_command}} - **Build Command:** {{backend_build_command}}
- **Deployment Method:** {{deployment_method}} - **Deployment Method:** {{deployment_method}}
- id: cicd-pipeline - id: cicd-pipeline
title: CI/CD Pipeline title: 14.2. CI/CD Pipeline
type: code type: code
language: yaml language: yaml
template: "{{cicd_pipeline_config}}" template: "{{cicd_pipeline_config}}"
- id: environments - id: environments
title: Environments title: 14.3. Environments
type: table type: table
columns: [Environment, Frontend URL, Backend URL, Purpose] columns: [Environment, Frontend URL, Backend URL, Purpose]
rows: rows:
@ -646,12 +646,12 @@ sections:
- ["Production", "{{prod_fe_url}}", "{{prod_be_url}}", "Live environment"] - ["Production", "{{prod_fe_url}}", "{{prod_be_url}}", "Live environment"]
- id: security-performance - id: security-performance
title: Security and Performance title: 15. Security and Performance
instruction: Define security and performance considerations for the fullstack application. instruction: Define security and performance considerations for the fullstack application.
elicit: true elicit: true
sections: sections:
- id: security-requirements - id: security-requirements
title: Security Requirements title: 15.1. Security Requirements
template: | template: |
**Frontend Security:** **Frontend Security:**
- CSP Headers: {{csp_policy}} - CSP Headers: {{csp_policy}}
@ -668,7 +668,7 @@ sections:
- Session Management: {{session_approach}} - Session Management: {{session_approach}}
- Password Policy: {{password_requirements}} - Password Policy: {{password_requirements}}
- id: performance-optimization - id: performance-optimization
title: Performance Optimization title: 15.2. Performance Optimization
template: | template: |
**Frontend Performance:** **Frontend Performance:**
- Bundle Size Target: {{bundle_size}} - Bundle Size Target: {{bundle_size}}
@ -681,12 +681,12 @@ sections:
- Caching Strategy: {{be_cache_strategy}} - Caching Strategy: {{be_cache_strategy}}
- id: testing-strategy - id: testing-strategy
title: Testing Strategy title: 16. Testing Strategy
instruction: Define comprehensive testing approach for fullstack application. instruction: Define comprehensive testing approach for fullstack application.
elicit: true elicit: true
sections: sections:
- id: testing-pyramid - id: testing-pyramid
title: Testing Pyramid title: 16.1. Testing Pyramid
type: code type: code
language: text language: text
template: | template: |
@ -696,49 +696,49 @@ sections:
/ \ / \
Frontend Unit Backend Unit Frontend Unit Backend Unit
- id: test-organization - id: test-organization
title: Test Organization title: 16.2. Test Organization
sections: sections:
- id: frontend-tests - id: frontend-tests
title: Frontend Tests title: 16.2.1. Frontend Tests
type: code type: code
language: text language: text
template: "{{frontend_test_structure}}" template: "{{frontend_test_structure}}"
- id: backend-tests - id: backend-tests
title: Backend Tests title: 16.2.2. Backend Tests
type: code type: code
language: text language: text
template: "{{backend_test_structure}}" template: "{{backend_test_structure}}"
- id: e2e-tests - id: e2e-tests
title: E2E Tests title: 16.2.3. E2E Tests
type: code type: code
language: text language: text
template: "{{e2e_test_structure}}" template: "{{e2e_test_structure}}"
- id: test-examples - id: test-examples
title: Test Examples title: 16.3. Test Examples
sections: sections:
- id: frontend-test - id: frontend-test
title: Frontend Component Test title: 16.3.1. Frontend Component Test
type: code type: code
language: typescript language: typescript
template: "{{frontend_test_example}}" template: "{{frontend_test_example}}"
- id: backend-test - id: backend-test
title: Backend API Test title: 16.3.2. Backend API Test
type: code type: code
language: typescript language: typescript
template: "{{backend_test_example}}" template: "{{backend_test_example}}"
- id: e2e-test - id: e2e-test
title: E2E Test title: 16.3.3. E2E Test
type: code type: code
language: typescript language: typescript
template: "{{e2e_test_example}}" template: "{{e2e_test_example}}"
- id: coding-standards - id: coding-standards
title: Coding Standards title: 17. Coding Standards
instruction: Define MINIMAL but CRITICAL standards for AI agents. Focus only on project-specific rules that prevent common mistakes. These will be used by dev agents. instruction: Define MINIMAL but CRITICAL standards for AI agents. Focus only on project-specific rules that prevent common mistakes. These will be used by dev agents.
elicit: true elicit: true
sections: sections:
- id: critical-rules - id: critical-rules
title: Critical Fullstack Rules title: 17.1. Critical Fullstack Rules
repeatable: true repeatable: true
template: "- **{{rule_name}}:** {{rule_description}}" template: "- **{{rule_name}}:** {{rule_description}}"
examples: examples:
@ -748,7 +748,7 @@ sections:
- "**Error Handling:** All API routes must use the standard error handler" - "**Error Handling:** All API routes must use the standard error handler"
- "**State Updates:** Never mutate state directly - use proper state management patterns" - "**State Updates:** Never mutate state directly - use proper state management patterns"
- id: naming-conventions - id: naming-conventions
title: Naming Conventions title: 17.2. Naming Conventions
type: table type: table
columns: [Element, Frontend, Backend, Example] columns: [Element, Frontend, Backend, Example]
rows: rows:
@ -758,17 +758,17 @@ sections:
- ["Database Tables", "-", "snake_case", "`user_profiles`"] - ["Database Tables", "-", "snake_case", "`user_profiles`"]
- id: error-handling - id: error-handling
title: Error Handling Strategy title: 18. Error Handling Strategy
instruction: Define unified error handling across frontend and backend. instruction: Define unified error handling across frontend and backend.
elicit: true elicit: true
sections: sections:
- id: error-flow - id: error-flow
title: Error Flow title: 18.1. Error Flow
type: mermaid type: mermaid
mermaid_type: sequence mermaid_type: sequence
template: "{{error_flow_diagram}}" template: "{{error_flow_diagram}}"
- id: error-format - id: error-format
title: Error Response Format title: 18.2. Error Response Format
type: code type: code
language: typescript language: typescript
template: | template: |
@ -782,30 +782,30 @@ sections:
}; };
} }
- id: frontend-error-handling - id: frontend-error-handling
title: Frontend Error Handling title: 18.3. Frontend Error Handling
type: code type: code
language: typescript language: typescript
template: "{{frontend_error_handler}}" template: "{{frontend_error_handler}}"
- id: backend-error-handling - id: backend-error-handling
title: Backend Error Handling title: 18.4. Backend Error Handling
type: code type: code
language: typescript language: typescript
template: "{{backend_error_handler}}" template: "{{backend_error_handler}}"
- id: monitoring - id: monitoring
title: Monitoring and Observability title: 19. Monitoring and Observability
instruction: Define monitoring strategy for fullstack application. instruction: Define monitoring strategy for fullstack application.
elicit: true elicit: true
sections: sections:
- id: monitoring-stack - id: monitoring-stack
title: Monitoring Stack title: 19.1. Monitoring Stack
template: | template: |
- **Frontend Monitoring:** {{frontend_monitoring}} - **Frontend Monitoring:** {{frontend_monitoring}}
- **Backend Monitoring:** {{backend_monitoring}} - **Backend Monitoring:** {{backend_monitoring}}
- **Error Tracking:** {{error_tracking}} - **Error Tracking:** {{error_tracking}}
- **Performance Monitoring:** {{perf_monitoring}} - **Performance Monitoring:** {{perf_monitoring}}
- id: key-metrics - id: key-metrics
title: Key Metrics title: 19.2. Key Metrics
template: | template: |
**Frontend Metrics:** **Frontend Metrics:**
- Core Web Vitals - Core Web Vitals
@ -820,5 +820,5 @@ sections:
- Database query performance - Database query performance
- id: checklist-results - id: checklist-results
title: Checklist Results Report title: 20. Checklist Results Report
instruction: Before running the checklist, offer to output the full architecture document. Once user confirms, execute the architect-checklist and populate results here. instruction: Before running the checklist, offer to output the full architecture document. Once user confirms, execute the architect-checklist and populate results here.

54
bmad-core/templates/prd-tmpl.yaml
View File

@ -14,38 +14,38 @@ workflow:
sections: sections:
- id: goals-context - id: goals-context
title: Goals and Background Context title: 1. Goals and Background Context
instruction: | instruction: |
Ask if Project Brief document is available. If NO Project Brief exists, STRONGLY recommend creating one first using project-brief-tmpl (it provides essential foundation: problem statement, target users, success metrics, MVP scope, constraints). If user insists on PRD without brief, gather this information during Goals section. If Project Brief exists, review and use it to populate Goals (bullet list of desired outcomes) and Background Context (1-2 paragraphs on what this solves and why) so we can determine what is and is not in scope for PRD mvp. Either way this is critical to determine the requirements. Include Change Log table. Ask if Project Brief document is available. If NO Project Brief exists, STRONGLY recommend creating one first using project-brief-tmpl (it provides essential foundation: problem statement, target users, success metrics, MVP scope, constraints). If user insists on PRD without brief, gather this information during Goals section. If Project Brief exists, review and use it to populate Goals (bullet list of desired outcomes) and Background Context (1-2 paragraphs on what this solves and why) so we can determine what is and is not in scope for PRD mvp. Either way this is critical to determine the requirements. Include Change Log table.
sections: sections:
- id: goals - id: goals
title: Goals title: 1.1. Goals
type: bullet-list type: bullet-list
instruction: Bullet list of 1 line desired outcomes the PRD will deliver if successful - user and project desires instruction: Bullet list of 1 line desired outcomes the PRD will deliver if successful - user and project desires
- id: background - id: background
title: Background Context title: 1.2. Background Context
type: paragraphs type: paragraphs
instruction: 1-2 short paragraphs summarizing the background context, such as what we learned in the brief without being redundant with the goals, what and why this solves a problem, what the current landscape or need is instruction: 1-2 short paragraphs summarizing the background context, such as what we learned in the brief without being redundant with the goals, what and why this solves a problem, what the current landscape or need is
- id: changelog - id: changelog
title: Change Log title: 1.3. Change Log
type: table type: table
columns: [Date, Version, Description, Author] columns: [Date, Version, Description, Author]
instruction: Track document versions and changes instruction: Track document versions and changes
- id: requirements - id: requirements
title: Requirements title: 2. Requirements
instruction: Draft the list of functional and non functional requirements under the two child sections instruction: Draft the list of functional and non functional requirements under the two child sections
elicit: true elicit: true
sections: sections:
- id: functional - id: functional
title: Functional title: 2.1. Functional
type: numbered-list type: numbered-list
prefix: FR prefix: FR
instruction: Each Requirement will be a bullet markdown and an identifier sequence starting with FR instruction: Each Requirement will be a bullet markdown and an identifier sequence starting with FR
examples: examples:
- "FR6: The Todo List uses AI to detect and warn against potentially duplicate todo items that are worded differently." - "FR6: The Todo List uses AI to detect and warn against potentially duplicate todo items that are worded differently."
- id: non-functional - id: non-functional
title: Non Functional title: 2.2. Non Functional
type: numbered-list type: numbered-list
prefix: NFR prefix: NFR
instruction: Each Requirement will be a bullet markdown and an identifier sequence starting with NFR instruction: Each Requirement will be a bullet markdown and an identifier sequence starting with NFR
@ -53,7 +53,7 @@ sections:
- "NFR1: AWS service usage must aim to stay within free-tier limits where feasible." - "NFR1: AWS service usage must aim to stay within free-tier limits where feasible."
- id: ui-goals - id: ui-goals
title: User Interface Design Goals title: 3. User Interface Design Goals
condition: PRD has UX/UI requirements condition: PRD has UX/UI requirements
instruction: | instruction: |
Capture high-level UI/UX vision to guide Design Architect and to inform story creation. Steps: Capture high-level UI/UX vision to guide Design Architect and to inform story creation. Steps:
@ -69,11 +69,11 @@ sections:
platforms: [Web Responsive, Mobile Only, Desktop Only, Cross-Platform] platforms: [Web Responsive, Mobile Only, Desktop Only, Cross-Platform]
sections: sections:
- id: ux-vision - id: ux-vision
title: Overall UX Vision title: 3.1. Overall UX Vision
- id: interaction-paradigms - id: interaction-paradigms
title: Key Interaction Paradigms title: 3.2. Key Interaction Paradigms
- id: core-screens - id: core-screens
title: Core Screens and Views title: 3.3. Core Screens and Views
instruction: From a product perspective, what are the most critical screens or views necessary to deliver the the PRD values and goals? This is meant to be Conceptual High Level to Drive Rough Epic or User Stories instruction: From a product perspective, what are the most critical screens or views necessary to deliver the the PRD values and goals? This is meant to be Conceptual High Level to Drive Rough Epic or User Stories
examples: examples:
- "Login Screen" - "Login Screen"
@ -81,22 +81,22 @@ sections:
- "Item Detail Page" - "Item Detail Page"
- "Settings Page" - "Settings Page"
- id: accessibility - id: accessibility
title: "Accessibility: {None|WCAG AA|WCAG AAA|Custom Requirements}" title: "3.4. Accessibility: {None|WCAG AA|WCAG AAA|Custom Requirements}"
- id: branding - id: branding
title: Branding title: 3.5. Branding
instruction: Any known branding elements or style guides that must be incorporated? instruction: Any known branding elements or style guides that must be incorporated?
examples: examples:
- "Replicate the look and feel of early 1900s black and white cinema, including animated effects replicating film damage or projector glitches during page or state transitions." - "Replicate the look and feel of early 1900s black and white cinema, including animated effects replicating film damage or projector glitches during page or state transitions."
- "Attached is the full color pallet and tokens for our corporate branding." - "Attached is the full color pallet and tokens for our corporate branding."
- id: target-platforms - id: target-platforms
title: "Target Device and Platforms: {Web Responsive|Mobile Only|Desktop Only|Cross-Platform}" title: "3.6. Target Device and Platforms: {Web Responsive|Mobile Only|Desktop Only|Cross-Platform}"
examples: examples:
- "Web Responsive, and all mobile platforms" - "Web Responsive, and all mobile platforms"
- "iPhone Only" - "iPhone Only"
- "ASCII Windows Desktop" - "ASCII Windows Desktop"
- id: technical-assumptions - id: technical-assumptions
title: Technical Assumptions title: 4. Technical Assumptions
instruction: | instruction: |
Gather technical decisions that will guide the Architect. Steps: Gather technical decisions that will guide the Architect. Steps:
@ -112,19 +112,19 @@ sections:
testing: [Unit Only, Unit + Integration, Full Testing Pyramid] testing: [Unit Only, Unit + Integration, Full Testing Pyramid]
sections: sections:
- id: repository-structure - id: repository-structure
title: "Repository Structure: {Monorepo|Polyrepo|Multi-repo}" title: "4.1. Repository Structure: {Monorepo|Polyrepo|Multi-repo}"
- id: service-architecture - id: service-architecture
title: Service Architecture title: 4.2. Service Architecture
instruction: "CRITICAL DECISION - Document the high-level service architecture (e.g., Monolith, Microservices, Serverless functions within a Monorepo)." instruction: "CRITICAL DECISION - Document the high-level service architecture (e.g., Monolith, Microservices, Serverless functions within a Monorepo)."
- id: testing-requirements - id: testing-requirements
title: Testing Requirements title: 4.3. Testing Requirements
instruction: "CRITICAL DECISION - Document the testing requirements, unit only, integration, e2e, manual, need for manual testing convenience methods)." instruction: "CRITICAL DECISION - Document the testing requirements, unit only, integration, e2e, manual, need for manual testing convenience methods)."
- id: additional-assumptions - id: additional-assumptions
title: Additional Technical Assumptions and Requests title: 4.4. Additional Technical Assumptions and Requests
instruction: Throughout the entire process of drafting this document, if any other technical assumptions are raised or discovered appropriate for the architect, add them here as additional bulleted items instruction: Throughout the entire process of drafting this document, if any other technical assumptions are raised or discovered appropriate for the architect, add them here as additional bulleted items
- id: epic-list - id: epic-list
title: Epic List title: 5. Epic List
instruction: | instruction: |
Present a high-level list of all epics for user approval. Each epic should have a title and a short (1 sentence) goal statement. This allows the user to review the overall structure before diving into details. Present a high-level list of all epics for user approval. Each epic should have a title and a short (1 sentence) goal statement. This allows the user to review the overall structure before diving into details.
@ -144,7 +144,7 @@ sections:
- "Epic 4: Reporting & Analytics: Provide insights and data visualization for users" - "Epic 4: Reporting & Analytics: Provide insights and data visualization for users"
- id: epic-details - id: epic-details
title: Epic {{epic_number}} {{epic_title}} title: 6. Epic {{epic_number}} {{epic_title}}
repeatable: true repeatable: true
instruction: | instruction: |
After the epic list is approved, present each epic with all its stories and acceptance criteria as a complete review unit. After the epic list is approved, present each epic with all its stories and acceptance criteria as a complete review unit.
@ -166,7 +166,7 @@ sections:
template: "{{epic_goal}}" template: "{{epic_goal}}"
sections: sections:
- id: story - id: story
title: Story {{epic_number}}.{{story_number}} {{story_title}} title: 6.{{epic_number}}.{{story_number}} Story {{epic_number}}.{{story_number}} {{story_title}}
repeatable: true repeatable: true
template: | template: |
As a {{user_type}}, As a {{user_type}},
@ -174,7 +174,7 @@ sections:
so that {{benefit}}. so that {{benefit}}.
sections: sections:
- id: acceptance-criteria - id: acceptance-criteria
title: Acceptance Criteria title: 6.{{epic_number}}.{{story_number}}.1. Acceptance Criteria
type: numbered-list type: numbered-list
item_template: "{{criterion_number}}: {{criteria}}" item_template: "{{criterion_number}}: {{criteria}}"
repeatable: true repeatable: true
@ -189,15 +189,15 @@ sections:
- Avoid cross-cutting concerns that should be in other stories or PRD sections - Avoid cross-cutting concerns that should be in other stories or PRD sections
- id: checklist-results - id: checklist-results
title: Checklist Results Report title: 7. Checklist Results Report
instruction: Before running the checklist and drafting the prompts, offer to output the full updated PRD. If outputting it, confirm with the user that you will be proceeding to run the checklist and produce the report. Once the user confirms, execute the pm-checklist and populate the results in this section. instruction: Before running the checklist and drafting the prompts, offer to output the full updated PRD. If outputting it, confirm with the user that you will be proceeding to run the checklist and produce the report. Once the user confirms, execute the pm-checklist and populate the results in this section.
- id: next-steps - id: next-steps
title: Next Steps title: 8. Next Steps
sections: sections:
- id: ux-expert-prompt - id: ux-expert-prompt
title: UX Expert Prompt title: 8.1. UX Expert Prompt
instruction: This section will contain the prompt for the UX Expert, keep it short and to the point to initiate create architecture mode using this document as input. instruction: This section will contain the prompt for the UX Expert, keep it short and to the point to initiate create architecture mode using this document as input.
- id: architect-prompt - id: architect-prompt
title: Architect Prompt title: 8.2. Architect Prompt
instruction: This section will contain the prompt for the Architect, keep it short and to the point to initiate create architecture mode using this document as input. instruction: This section will contain the prompt for the Architect, keep it short and to the point to initiate create architecture mode using this document as input.