7.6 KiB
7.6 KiB
Persona Documentation Template
This template provides the standard structure for all BMAD Method persona documentation.
File Structure
Each persona should have the following documentation files:
docs/
├── {persona-name}-comprehensive-guide.md
├── {persona-name}-integration-guide.md
├── {persona-name}-quality-assurance.md
└── {persona-name}-quickstart.md
examples/
├── {persona-name}-example-project.md
└── {persona-name}-example-code.md (if applicable)
bmad-agent/personas/
├── {persona-name}.md (Web version)
└── {persona-name}.ide.md (IDE version)
Template: Comprehensive Guide
# {Persona Name} Comprehensive Guide
## Introduction
Brief introduction to the persona, their role in the BMAD Method, and their core capabilities.
## Table of Contents
1. [Core Capabilities](#core-capabilities)
2. [When to Use](#when-to-use)
3. [Activation Methods](#activation-methods)
4. [Working Process](#working-process)
5. [Input Requirements](#input-requirements)
6. [Output Expectations](#output-expectations)
7. [Integration with Other Personas](#integration-with-other-personas)
8. [Best Practices](#best-practices)
9. [Troubleshooting](#troubleshooting)
10. [Advanced Usage](#advanced-usage)
## Core Capabilities
List the primary capabilities and strengths of this persona:
- **Capability 1**: Description of what the persona excels at
- **Capability 2**: Another key strength
- **Capability 3**: Additional capability
## When to Use
Describe the ideal scenarios for using this persona:
- **Scenario 1**: When you need X
- **Scenario 2**: During Y phase of the project
- **Scenario 3**: For Z type of tasks
## Activation Methods
### Web Environment ({Web Persona Name})
"I need {Web Persona Name} to help with {task type}" "Activate the {persona role} for {specific task}"
### IDE Environment ({IDE Persona Name})
"{IDE Persona Name}, I need you to {action} using {tools/framework}" "Help me {task} that integrates with our existing {system}"
## Working Process
Describe the typical workflow when using this persona:
1. **Step 1**: Initial setup or requirements gathering
2. **Step 2**: Analysis or planning phase
3. **Step 3**: Implementation or execution
4. **Step 4**: Review and refinement
5. **Step 5**: Delivery and documentation
## Input Requirements
For optimal results, provide:
- **Requirement 1**: What information is needed
- **Requirement 2**: Context or constraints
- **Requirement 3**: Technical specifications
- **Requirement 4**: Success criteria
## Output Expectations
The persona produces:
- **Output 1**: Type of deliverable
- **Output 2**: Documentation or artifacts
- **Output 3**: Recommendations or guidance
## Integration with Other Personas
Describe how this persona works with others in the BMAD Method:
- **{Other Persona}**: How they collaborate
- **{Another Persona}**: Handoff procedures
- **{Third Persona}**: Shared responsibilities
## Best Practices
### Effective Usage
1. **Practice 1**: How to get the best results
2. **Practice 2**: Common optimization techniques
3. **Practice 3**: Quality assurance approaches
### Quality Assurance
- Run the {Persona} Quality Checklist after completion
- Validate outputs against requirements
- Ensure integration with existing systems
## Troubleshooting
### Common Issues and Solutions
| Issue | Solution |
|-------|----------|
| Problem 1 | How to resolve it |
| Problem 2 | Step-by-step fix |
| Problem 3 | Alternative approaches |
## Advanced Usage
### Advanced Techniques
Describe sophisticated use cases and techniques for experienced users.
### Integration Patterns
Explain complex integration scenarios and patterns.
---
This comprehensive guide provides everything you need to effectively use the {Persona Name} persona in your development workflow.
## Template: Integration Guide
```markdown
# {Persona Name} Integration Guide
## Overview
This guide explains how to integrate the {Persona Name} persona into your development workflow.
## Table of Contents
1. [Web Environment Integration](#web-environment-integration)
2. [IDE Environment Integration](#ide-environment-integration)
3. [BMAD Method Workflow Integration](#bmad-method-workflow-integration)
4. [Third-Party Tool Integration](#third-party-tool-integration)
5. [Configuration Options](#configuration-options)
## Web Environment Integration
### Setup Instructions
1. **Access the Web Orchestrator**
2. **Load the {Persona Name} Persona**
3. **Activate the Persona**
### Usage Examples
Provide specific examples of how to use the persona in web environments.
## IDE Environment Integration
### Supported IDEs
List supported development environments and setup instructions for each.
### Usage Examples
Show how to use the persona within different IDE environments.
## BMAD Method Workflow Integration
### Integration Points
Describe where this persona fits in the overall BMAD workflow.
### Workflow Diagram
Previous Persona → {Current Persona} → Next Persona
## Third-Party Tool Integration
List and describe integrations with external tools and services.
## Configuration Options
Document available configuration options and their usage.
---
This integration guide provides comprehensive instructions for incorporating the {Persona Name} persona into your development workflow.
## Template: Quality Assurance Guide
```markdown
# {Persona Name} Quality Assurance Guide
This document provides comprehensive quality assurance procedures for evaluating outputs from the {Persona Name} persona.
## Quality Assurance Process
### Overview
Describe the QA process specific to this persona's outputs.
## Quality Checklists
### Primary Quality Checklist
- [ ] **Criterion 1**: Description of what to check
- [ ] **Criterion 2**: Another quality measure
- [ ] **Criterion 3**: Additional validation point
### Secondary Quality Checklist
- [ ] **Integration**: Works with other system components
- [ ] **Documentation**: Properly documented
- [ ] **Standards**: Follows established standards
## Testing Procedures
Describe specific testing procedures for this persona's outputs.
## Success Metrics
Define measurable success criteria for this persona's work.
---
This quality assurance guide ensures high-quality outputs from the {Persona Name} persona.
## Template: Quick Start Guide
```markdown
# {Persona Name} Quick Start Guide
Get up and running with the {Persona Name} persona in just 5 minutes.
## 1. Choose Your Environment
Brief description of environment options.
## 2. Activate the Persona
Simple activation instructions.
## 3. Provide Clear Requirements
What information to provide for best results.
## 4. Review and Iterate
How to refine and improve outputs.
## 5. Implement and Test
Final steps to complete the work.
## Example: {Simple Use Case}
Step-by-step example of a common use case.
## Next Steps
Links to comprehensive documentation and advanced guides.
---
Start using the {Persona Name} persona effectively today!
## Usage Instructions
1. **Copy the appropriate template**
2. **Replace all {placeholder} text** with persona-specific information
3. **Customize sections** based on the persona's unique capabilities
4. **Add persona-specific examples** and use cases
5. **Validate against the quality checklist**
This template ensures consistency across all persona documentation while allowing for persona-specific customization.
Now let's begin standardizing the first persona - Product Manager (John):