mirror of
https://github.com/bmadcode/BMAD-METHOD.git
synced 2025-12-29 16:14:59 +00:00
2d99833b9e
Created two comprehensive guides for v6 features:
**docs/agent-customization-guide.md**
- Complete guide for customizing agent names, personas, memories, and behaviors
- Update-safe customization via bmad/_cfg/agents/ configuration files
- Real-world examples (TDD setup, multilingual agents, custom workflows)
- Troubleshooting and best practices
**docs/web-bundles-gemini-gpt-guide.md**
- Comprehensive guide for using BMad agents in Gemini Gems and Custom GPTs
- Critical setup rules with exact configuration text required
- Cost-saving strategy: web planning → local implementation (60-80% savings)
- Platform comparison (Gemini Gems strongly recommended over Custom GPTs)
- Complete workflow examples showing full planning-to-implementation cycle
- Team bundle guidance (Gemini 2.5 Pro+ only)
**README.md updates**
- Added prominent links in v6 Core Enhancements section
- Created new "Customization & Sharing" documentation category
- Web Bundles feature highlighted with direct guide link
**Unified output folder structure across all modules:**
**Before (confusing):**
- output_folder: Main docs
- game_design_docs: Separate design folder
- tech_docs: Separate technical folder
- dev_ephemeral_location: Separate ephemeral folder outside docs
**After (simplified):**
- output_folder: Single location for ALL AI-generated artifacts (default: "docs")
- Clearer prompt: "Where should AI Generated Artifacts be saved?"
- sprint_artifacts: Phase 4 ephemeral content now WITHIN output_folder
- BMM: {output_folder}/stories (stories, context, reports)
- BMGD: {output_folder}/sprint-artifacts
- No longer in separate {bmad_folder}-ephemeral location
**Benefits:**
- One clear location for all planning artifacts (PRD, Architecture, UX, etc.)
- Phase 4 ephemeral items logically grouped within output folder
- Eliminated confusing separate folder proliferation
- sprint_artifacts now configurable per module
**Files changed:**
- src/core/_module-installer/install-config.yaml
- src/modules/bmm/_module-installer/install-config.yaml
- src/modules/bmgd/_module-installer/install-config.yaml
**Also cleaned up BMGD config:**
- Renamed: specified_framework → primary_platform (clearer naming)
- Removed: unused data_path variable
Replaced old "project_level" (0-4) system with new "selected_track" terminology:
- **quick-flow**: Bug fixes and small features (replaces Level 0-1)
- **bmad-method**: Full planning track (replaces Level 2-3)
- **enterprise-bmad-method**: Extended planning (replaces Level 4)
**Core workflow updates:**
- solutioning-gate-check: Complete rewrite of validation logic for track-based artifacts
- architecture: Updated context detection, error handling, and messaging for tracks
- workflow-init: Updated artifact detection patterns for track-based paths
- All workflow status paths updated (method-greenfield, method-brownfield, enterprise-*)
Unified variable naming conventions across all workflows:
- {output_folder} → {output-folder} (hyphenated format)
- {dev_ephemeral_location} → {sprint_artifacts} (clearer purpose)
- Hardcoded status file paths → {workflow_status_file} variable
Fixed corrupted variable patterns throughout workflow files:
- {output*folder} → {output-folder}
- {ephemeral*location} → {sprint_artifacts}
- \_prd* → *prd* (escaped underscore artifacts)
- **\*\***\_\_\_**\*\*** → proper field placeholders
Affected patterns included malformed glob patterns, template variables, and markdown formatting artifacts from previous edits.
**Architecture workflow (create-architecture):**
- Fixed: "Decision Architecture" → "Create Architecture" (consistent naming)
- Improved PRD not found handling with exit/continue options
- Better user guidance when running standalone vs. within workflow path
- Removed hardcoded Level checks, now track-aware
- Enhanced validation checklist formatting (□ → - [])
- Typo fixes: "mulitple" → "multiple"
**Solutioning gate check:**
- Complete validation logic rewrite for track-based system
- Removed Level-specific artifact expectations
- Simplified document discovery (track determines what exists)
- Better analysis prompts and user feedback
**Workflow-init:**
- Updated artifact detection patterns for new folder structure
- Fixed corrupt glob patterns throughout
- Better sprint_artifacts location detection
- Improved workflow path assignment logic
**Various workflows:**
- Consistent variable naming across 40+ workflow files
- Improved error messages and user guidance
- Better markdown formatting (checkboxes, lists)
- Removed redundant validation criteria files (now inline)
Removed duplicate BMGD 4-production workflows (12 workflows):
- code-review, correct-course, create-story, dev-story
- epic-tech-context, retrospective, sprint-planning
- story-context, story-done, story-ready
**Why:** BMGD now uses shared BMM Phase 4 implementation workflows
**Benefit:** Single source of truth, no duplication to maintain
Also removed:
- validation-criteria.yaml (validation now inline in instructions)
- architecture-patterns.yaml references (patterns now managed differently)
- AUDIT-REPORT.md files (stale audit artifacts)
**BMB workflows:**
- Updated checklists for workflow and module creation
- Improved agent architecture documentation
- Minor instruction clarifications
**Core brainstorming workflow:**
- Updated README with usage examples
- Enhanced instructions and template clarity
- Better integration with other modules
**BMM installer:**
- Updated for track-based system
- sprint_artifacts configuration
**Tech Writer agent:**
- Minor configuration update for documentation workflows
Removed 200+ files that should not be in repository:
- Installed agent markdown files (analyst, architect, dev, pm, sm, tea, etc.)
- Complete workflow instruction copies
- Documentation duplicates (quick-start, agents-guide, workflows-*)
- Test architecture knowledge base (22 files, 14,000+ lines)
- Configuration files (config.yaml, team definitions)
These are generated during installation and should not be version controlled.
Removed 21 pre-generated XML bundles:
- BMM agents (analyst, architect, dev, pm, sm, tea, tech-writer, ux-designer)
- BMGD agents (game-architect, game-designer, game-dev, game-scrum-master)
- CIS agents (brainstorming-coach, creative-problem-solver, etc.)
- Team bundles (team-fullstack, team-gamedev, creative-squad)
**Why:** Users should generate fresh bundles via `npm run bundle` to get latest changes and customizations.
- **2 new documentation files** (comprehensive guides)
- **98 source files modified** (299 insertions, 6,567 deletions)
- **3 installer config files simplified** (major folder structure improvement)
- **200+ .bmad/ artifacts removed** (should not be in repo)
- **21 web-bundle files removed** (users regenerate as needed)
- **12 duplicate workflows removed** (BMGD consolidation)
- **40+ workflows updated** (track system, variable standardization, corruption fixes)
322 lines
7.8 KiB
YAML
322 lines
7.8 KiB
YAML
# 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"
|