bmad-method 6.0.0-alpha.2 → 6.0.0-alpha.4

package/bmad/bmm/workflows/2-plan-workflows/tech-spec/tech-spec-template.md

@@ -0,0 +1,181 @@
+# {{project_name}} - Technical Specification
+
+**Author:** {{user_name}}
+**Date:** {{date}}
+**Project Level:** {{project_level}}
+**Change Type:** {{change_type}}
+**Development Context:** {{development_context}}
+
+---
+
+## Context
+
+### Available Documents
+
+{{loaded_documents_summary}}
+
+### Project Stack
+
+{{project_stack_summary}}
+
+### Existing Codebase Structure
+
+{{existing_structure_summary}}
+
+---
+
+## The Change
+
+### Problem Statement
+
+{{problem_statement}}
+
+### Proposed Solution
+
+{{solution_overview}}
+
+### Scope
+
+**In Scope:**
+
+{{scope_in}}
+
+**Out of Scope:**
+
+{{scope_out}}
+
+---
+
+## Implementation Details
+
+### Source Tree Changes
+
+{{source_tree_changes}}
+
+### Technical Approach
+
+{{technical_approach}}
+
+### Existing Patterns to Follow
+
+{{existing_patterns}}
+
+### Integration Points
+
+{{integration_points}}
+
+---
+
+## Development Context
+
+### Relevant Existing Code
+
+{{existing_code_references}}
+
+### Dependencies
+
+**Framework/Libraries:**
+
+{{framework_dependencies}}
+
+**Internal Modules:**
+
+{{internal_dependencies}}
+
+### Configuration Changes
+
+{{configuration_changes}}
+
+### Existing Conventions (Brownfield)
+
+{{existing_conventions}}
+
+### Test Framework & Standards
+
+{{test_framework_info}}
+
+---
+
+## Implementation Stack
+
+{{implementation_stack}}
+
+---
+
+## Technical Details
+
+{{technical_details}}
+
+---
+
+## Development Setup
+
+{{development_setup}}
+
+---
+
+## Implementation Guide
+
+### Setup Steps
+
+{{setup_steps}}
+
+### Implementation Steps
+
+{{implementation_steps}}
+
+### Testing Strategy
+
+{{testing_strategy}}
+
+### Acceptance Criteria
+
+{{acceptance_criteria}}
+
+---
+
+## Developer Resources
+
+### File Paths Reference
+
+{{file_paths_complete}}
+
+### Key Code Locations
+
+{{key_code_locations}}
+
+### Testing Locations
+
+{{testing_locations}}
+
+### Documentation to Update
+
+{{documentation_updates}}
+
+---
+
+## UX/UI Considerations
+
+{{ux_ui_considerations}}
+
+---
+
+## Testing Approach
+
+{{testing_approach}}
+
+---
+
+## Deployment Strategy
+
+### Deployment Steps
+
+{{deployment_steps}}
+
+### Rollback Plan
+
+{{rollback_plan}}
+
+### Monitoring
+
+{{monitoring_approach}}

package/bmad/bmm/workflows/2-plan-workflows/tech-spec/user-story-template.md

@@ -0,0 +1,87 @@
+# Story: {{story_title}}
+
+Status: Draft
+
+## Story
+
+As a {{role}},
+I want {{capability}},
+so that {{benefit}}.
+
+## Acceptance Criteria
+
+{{acceptance_criteria}}
+
+## Tasks / Subtasks
+
+{{tasks_subtasks}}
+
+## Dev Notes
+
+### Technical Summary
+
+{{technical_summary}}
+
+### Tech-Spec Reference
+
+**Full details:** See [tech-spec.md](../tech-spec.md)
+
+The tech-spec contains comprehensive context including:
+
+- Brownfield codebase analysis (if applicable)
+- Framework and library details with versions
+- Existing patterns to follow
+- Integration points and dependencies
+- Complete implementation guidance
+
+### Project Structure Notes
+
+- **Files to modify:** {{files_to_modify}}
+- **Expected test locations:** {{test_locations}}
+- **Estimated effort:** {{story_points}} story points ({{time_estimate}})
+- **Dependencies:** {{dependencies}}
+
+### Key Code References
+
+{{existing_code_references}}
+
+### References
+
+- **Tech Spec:** [tech-spec.md](../tech-spec.md) - Primary context document
+- **Architecture:** {{architecture_references}}
+
+---
+
+## Dev Agent Record
+
+### Context Reference
+
+**Primary Context:** [tech-spec.md](../tech-spec.md) - Contains all brownfield analysis, framework details, and implementation guidance
+
+<!-- Additional context XML paths will be added here if story-context workflow is run -->
+
+### Agent Model Used
+
+<!-- Will be populated during dev-story execution -->
+
+### Debug Log References
+
+<!-- Will be populated during dev-story execution -->
+
+### Completion Notes List
+
+<!-- Will be populated during dev-story execution -->
+
+### File List
+
+<!-- Will be populated during dev-story execution -->
+
+### Test Results
+
+<!-- Will be populated during dev-story execution -->
+
+---
+
+## Review Notes
+
+<!-- Will be populated during code review -->

package/bmad/bmm/workflows/2-plan-workflows/tech-spec/workflow.yaml

@@ -0,0 +1,60 @@
+# Technical Specification Workflow (Level 0)
+name: tech-spec-sm
+description: "Technical specification workflow for Level 0 projects (single atomic changes). Creates focused tech spec for bug fixes, single endpoint additions, or small isolated changes. Tech-spec only - no PRD needed."
+author: "BMad"
+
+# Critical variables from config
+config_source: "{project-root}/bmad/bmm/config.yaml"
+project_name: "{config_source}:project_name"
+output_folder: "{config_source}:output_folder"
+user_name: "{config_source}:user_name"
+communication_language: "{config_source}:communication_language"
+document_output_language: "{config_source}:document_output_language"
+user_skill_level: "{config_source}:user_skill_level"
+date: system-generated
+
+# Runtime variables (captured during workflow execution)
+project_level: runtime-captured
+project_type: runtime-captured
+development_context: runtime-captured
+change_type: runtime-captured
+field_type: runtime-captured
+
+# Workflow components
+installed_path: "{project-root}/bmad/bmm/workflows/2-plan-workflows/tech-spec"
+instructions: "{installed_path}/instructions.md"
+template: "{installed_path}/tech-spec-template.md"
+
+# Story generation instructions (invoked based on level)
+instructions_level0_story: "{installed_path}/instructions-level0-story.md"
+instructions_level1_stories: "{installed_path}/instructions-level1-stories.md"
+
+# Templates
+user_story_template: "{installed_path}/user-story-template.md"
+epics_template: "{installed_path}/epics-template.md"
+
+# Output configuration
+default_output_file: "{output_folder}/tech-spec.md"
+user_story_file: "{output_folder}/user-story.md"
+epics_file: "{output_folder}/epics.md"
+
+# Recommended input documents (optional for Level 0)
+recommended_inputs:
+  - bug_report: "Bug description or issue ticket"
+  - feature_request: "Brief feature description"
+
+# Smart input file references - handles both whole docs and sharded docs
+# Priority: Whole document first, then sharded version
+input_file_patterns:
+  product_brief:
+    whole: "{output_folder}/*brief*.md"
+    sharded: "{output_folder}/*brief*/index.md"
+
+  research:
+    whole: "{output_folder}/*research*.md"
+    sharded: "{output_folder}/*research*/index.md"
+
+  document_project:
+    sharded: "{output_folder}/docs/index.md"
+
+standalone: true

package/bmad/bmm/workflows/3-solutioning/architecture/architecture-patterns.yaml

@@ -0,0 +1,347 @@
+# Architecture Patterns - Common patterns identified from requirements
+
+requirement_patterns:
+  realtime_collaboration:
+    triggers:
+      - "real-time"
+      - "collaborative"
+      - "live updates"
+      - "multi-user"
+      - "simultaneous editing"
+    decisions_needed:
+      - websocket_solution
+      - conflict_resolution
+      - state_synchronization
+      - presence_tracking
+      - optimistic_updates
+    suggested_stack:
+      - "Socket.io or WebSocket native"
+      - "Redis for pub/sub"
+      - "Operational Transforms or CRDTs for conflict resolution"
+      - "PostgreSQL for persistence"
+
+  ecommerce:
+    triggers:
+      - "shopping cart"
+      - "checkout"
+      - "payments"
+      - "inventory"
+      - "product catalog"
+    decisions_needed:
+      - payment_processor
+      - cart_persistence
+      - inventory_management
+      - order_workflow
+      - tax_calculation
+    suggested_stack:
+      - "Stripe or PayPal for payments"
+      - "PostgreSQL for products and orders"
+      - "Redis for cart sessions"
+      - "BullMQ for order processing"
+
+  saas_platform:
+    triggers:
+      - "multi-tenant"
+      - "subscription"
+      - "billing"
+      - "team management"
+      - "roles and permissions"
+    decisions_needed:
+      - tenancy_model
+      - subscription_billing
+      - permission_system
+      - team_collaboration
+      - usage_tracking
+    suggested_stack:
+      - "PostgreSQL with Row Level Security"
+      - "Stripe Billing for subscriptions"
+      - "RBAC or ABAC for permissions"
+      - "NextAuth or Clerk for auth"
+
+  content_platform:
+    triggers:
+      - "CMS"
+      - "blog"
+      - "publishing"
+      - "content management"
+      - "editorial workflow"
+    decisions_needed:
+      - content_storage
+      - rich_text_editor
+      - media_handling
+      - version_control
+      - publishing_workflow
+    suggested_stack:
+      - "PostgreSQL for structured content"
+      - "S3 or Cloudinary for media"
+      - "Tiptap or Slate for rich text"
+      - "Algolia for search"
+
+  data_analytics:
+    triggers:
+      - "dashboards"
+      - "reporting"
+      - "metrics"
+      - "analytics"
+      - "data visualization"
+    decisions_needed:
+      - data_warehouse
+      - etl_pipeline
+      - visualization_library
+      - query_optimization
+      - caching_strategy
+    suggested_stack:
+      - "PostgreSQL or ClickHouse"
+      - "Apache Airflow or Temporal for ETL"
+      - "Chart.js or D3 for visualization"
+      - "Redis for query caching"
+
+  social_platform:
+    triggers:
+      - "social network"
+      - "feed"
+      - "following"
+      - "likes"
+      - "comments"
+    decisions_needed:
+      - graph_relationships
+      - feed_algorithm
+      - notification_system
+      - content_moderation
+      - privacy_controls
+    suggested_stack:
+      - "PostgreSQL with graph extensions or Neo4j"
+      - "Redis for feed caching"
+      - "Elasticsearch for user search"
+      - "WebSockets for notifications"
+
+  marketplace:
+    triggers:
+      - "marketplace"
+      - "vendors"
+      - "buyers and sellers"
+      - "transactions"
+      - "escrow"
+    decisions_needed:
+      - payment_splitting
+      - escrow_handling
+      - vendor_management
+      - dispute_resolution
+      - commission_model
+    suggested_stack:
+      - "Stripe Connect for payments"
+      - "PostgreSQL for transactions"
+      - "BullMQ for async processing"
+      - "S3 for vendor assets"
+
+  streaming_platform:
+    triggers:
+      - "video streaming"
+      - "live streaming"
+      - "media delivery"
+      - "broadcast"
+    decisions_needed:
+      - video_encoding
+      - cdn_strategy
+      - streaming_protocol
+      - bandwidth_optimization
+      - drm_protection
+    suggested_stack:
+      - "AWS MediaConvert or Mux"
+      - "CloudFront or Fastly CDN"
+      - "HLS or DASH protocol"
+      - "S3 for video storage"
+
+  iot_platform:
+    triggers:
+      - "IoT"
+      - "sensors"
+      - "device management"
+      - "telemetry"
+      - "edge computing"
+    decisions_needed:
+      - message_protocol
+      - time_series_database
+      - device_authentication
+      - data_ingestion
+      - edge_processing
+    suggested_stack:
+      - "MQTT or CoAP protocol"
+      - "TimescaleDB or InfluxDB"
+      - "Apache Kafka for ingestion"
+      - "Grafana for monitoring"
+
+  ai_application:
+    triggers:
+      - "machine learning"
+      - "AI features"
+      - "LLM integration"
+      - "computer vision"
+      - "NLP"
+    decisions_needed:
+      - model_serving
+      - vector_database
+      - prompt_management
+      - token_optimization
+      - fallback_strategy
+    suggested_stack:
+      - "OpenAI or Anthropic API"
+      - "Pinecone or pgvector for embeddings"
+      - "Redis for prompt caching"
+      - "Langchain or LlamaIndex"
+
+# Quality attribute patterns
+quality_attributes:
+  high_availability:
+    triggers:
+      - "99.9% uptime"
+      - "high availability"
+      - "fault tolerance"
+      - "disaster recovery"
+    architectural_needs:
+      - load_balancing
+      - database_replication
+      - health_checks
+      - circuit_breakers
+      - graceful_degradation
+
+  high_performance:
+    triggers:
+      - "millisecond response"
+      - "high throughput"
+      - "low latency"
+      - "performance critical"
+    architectural_needs:
+      - caching_layers
+      - database_optimization
+      - cdn_strategy
+      - code_splitting
+      - lazy_loading
+
+  high_security:
+    triggers:
+      - "compliance"
+      - "HIPAA"
+      - "GDPR"
+      - "financial data"
+      - "PCI DSS"
+    architectural_needs:
+      - encryption_at_rest
+      - encryption_in_transit
+      - audit_logging
+      - access_controls
+      - data_isolation
+
+  scalability:
+    triggers:
+      - "millions of users"
+      - "elastic scale"
+      - "global reach"
+      - "viral growth"
+    architectural_needs:
+      - horizontal_scaling
+      - database_sharding
+      - microservices
+      - queue_systems
+      - auto_scaling
+
+# Integration patterns
+integration_requirements:
+  payment_processing:
+    common_choices:
+      - "Stripe - most developer friendly"
+      - "PayPal - widest consumer adoption"
+      - "Square - best for in-person + online"
+    considerations:
+      - transaction_fees
+      - international_support
+      - subscription_handling
+      - marketplace_capabilities
+
+  email_service:
+    common_choices:
+      - "Resend - modern, developer friendly"
+      - "SendGrid - mature, scalable"
+      - "Amazon SES - cost effective at scale"
+      - "Postmark - transactional focus"
+    considerations:
+      - deliverability
+      - template_management
+      - analytics_needs
+      - cost_per_email
+
+  sms_notifications:
+    common_choices:
+      - "Twilio - most comprehensive"
+      - "Amazon SNS - AWS integrated"
+      - "Vonage - competitive pricing"
+    considerations:
+      - international_coverage
+      - delivery_rates
+      - two_way_messaging
+      - cost_per_message
+
+  authentication_providers:
+    social_providers:
+      - "Google - highest adoption"
+      - "GitHub - developer focused"
+      - "Microsoft - enterprise"
+      - "Apple - iOS users"
+    enterprise_providers:
+      - "SAML 2.0"
+      - "OAuth 2.0"
+      - "OpenID Connect"
+      - "Active Directory"
+
+# Decision heuristics
+decision_rules:
+  database_selection:
+    if_requirements_include:
+      - complex_relationships: "PostgreSQL"
+      - flexible_schema: "MongoDB"
+      - time_series: "TimescaleDB"
+      - graph_data: "Neo4j or PostgreSQL with extensions"
+      - key_value: "Redis"
+      - wide_column: "Cassandra"
+
+  api_pattern_selection:
+    if_requirements_include:
+      - simple_crud: "REST"
+      - complex_queries: "GraphQL"
+      - type_safety_critical: "tRPC"
+      - microservices: "gRPC"
+      - public_api: "REST with OpenAPI"
+
+  deployment_selection:
+    if_requirements_include:
+      - nextjs_only: "Vercel"
+      - complex_infrastructure: "AWS"
+      - quick_prototype: "Railway"
+      - global_edge: "Fly.io"
+      - kubernetes_needed: "GCP or AWS EKS"
+
+# Anti-patterns to avoid
+anti_patterns:
+  overengineering:
+    signs:
+      - "Microservices for < 10k users"
+      - "Kubernetes for single app"
+      - "GraphQL for 5 endpoints"
+      - "Event sourcing for CRUD app"
+    recommendation: "Start simple, evolve as needed"
+
+  underengineering:
+    signs:
+      - "No authentication strategy"
+      - "No error handling plan"
+      - "No monitoring approach"
+      - "No backup strategy"
+    recommendation: "Cover the fundamentals"
+
+  technology_soup:
+    signs:
+      - "5+ different databases"
+      - "Multiple frontend frameworks"
+      - "Inconsistent patterns"
+      - "Too many languages"
+    recommendation: "Maintain consistency"