BMAD-METHOD/docs/templates

BMAD Method Template System

Overview

The BMAD Method Template System provides comprehensive, reusable templates for all documentation types across all personas and technology stacks. This system ensures consistency, quality, and efficiency in documentation creation.

Template Categories

1. Core Templates

• Project Brief Template - Initial project documentation
• Requirements Template - Functional and non-functional requirements
• Architecture Template - System and technical architecture
• API Documentation Template - Cross-platform API documentation
• Deployment Template - Infrastructure and deployment guides

2. Persona-Specific Templates

• Technical Documentation Architect Templates
• DevOps Documentation Specialist Templates
• Cross-Platform Integration Specialist Templates
• Polyglot Code Review Specialist Templates

3. Technology-Specific Templates

• React/TypeScript Templates
• Node.js Templates
• ASP.NET Templates
• Python Templates
• Database Templates

4. Process Templates

• Code Review Templates
• Integration Testing Templates
• Security Assessment Templates
• Performance Analysis Templates

5. Validation Templates

• Quality Checklists
• Acceptance Criteria Templates
• Testing Strategy Templates
• Documentation Review Templates

Template Structure

All templates follow a standardized structure:

```yaml

template_id: "unique-identifier" template_name: "Human Readable Name" version: "1.0.0" category: "core|persona|technology|process|validation" personas: ["list", "of", "applicable", "personas"] technologies: ["list", "of", "technologies"] complexity: "basic|intermediate|advanced" estimated_time: "time in minutes" dependencies: ["list", "of", "dependencies"] tags: ["searchable", "tags"]

## Usage Guidelines

### Template Selection
1. Identify your persona and role
2. Determine the documentation type needed
3. Select appropriate technology stack
4. Choose complexity level
5. Review dependencies and prerequisites

### Customization
- All templates support variable substitution
- Sections can be added, removed, or modified
- Technology-specific examples can be swapped
- Quality standards remain consistent

### Quality Validation
- Each template includes built-in quality checks
- Validation rules ensure consistency
- Automated checks for completeness
- Integration with BMAD quality framework

## Template Inheritance

Templates support inheritance and composition:
- **Base Templates** - Core structure and standards
- **Persona Extensions** - Role-specific additions
- **Technology Extensions** - Platform-specific content
- **Custom Extensions** - Project-specific modifications

## Integration Points

### BMAD Orchestrator
- Automatic template selection based on context
- Persona-aware template recommendations
- Technology stack integration
- Quality validation integration

### Documentation Architecture
- Seamless integration with navigation system
- Cross-reference generation
- Metadata consistency
- Search and discovery support

## Maintenance and Updates

### Version Control
- Semantic versioning for all templates
- Change tracking and history
- Backward compatibility maintenance
- Migration guides for updates

### Continuous Improvement
- Usage analytics and feedback
- Template effectiveness metrics
- Regular review and updates
- Community contributions

## Getting Started

1. **Browse Templates** - Use the navigation system to find appropriate templates
2. **Select Template** - Choose based on persona, technology, and complexity
3. **Customize** - Adapt template to specific project needs
4. **Validate** - Use built-in quality checks
5. **Generate** - Create final documentation
6. **Review** - Follow quality assurance process

## Support and Resources

- **Template Library** - Complete collection of all templates
- **Usage Examples** - Real-world template implementations
- **Best Practices** - Guidelines for effective template usage
- **Troubleshooting** - Common issues and solutions
- **Community** - Template sharing and collaboration

---

For specific template documentation, see the individual template files in their respective categories.

Now let me create the core templates: