185 lines
5.7 KiB
Markdown
185 lines
5.7 KiB
Markdown
---
|
|
name: 📚 Documentation
|
|
about: Request documentation improvements or report documentation issues
|
|
title: '[DOCS] '
|
|
labels: ['documentation', 'good first issue']
|
|
assignees: ''
|
|
---
|
|
|
|
# 📚 Documentation Issue
|
|
|
|
## 📋 Documentation Type
|
|
<!-- What kind of documentation needs attention? -->
|
|
- [ ] 📖 **User Guide** - How to use the BMAD Claude integration
|
|
- [ ] 🔧 **Setup/Installation** - Getting started instructions
|
|
- [ ] 🎭 **Agent Usage** - How to use specific agents effectively
|
|
- [ ] 🧪 **Testing Guide** - How to test and validate the integration
|
|
- [ ] 🛠️ **Developer Docs** - Technical implementation details
|
|
- [ ] 📝 **API Reference** - Command and configuration reference
|
|
- [ ] 🔄 **Workflow Examples** - Real-world usage examples
|
|
- [ ] 🐛 **Troubleshooting** - Common issues and solutions
|
|
- [ ] 📋 **Contributing** - How to contribute to the project
|
|
- [ ] 🏗️ **Architecture** - Technical architecture documentation
|
|
|
|
## 🎯 Issue Type
|
|
<!-- What kind of documentation issue is this? -->
|
|
- [ ] ❌ **Missing Documentation** - Something that should be documented isn't
|
|
- [ ] 📝 **Unclear Documentation** - Existing docs are confusing or incomplete
|
|
- [ ] 🔄 **Outdated Documentation** - Docs don't match current functionality
|
|
- [ ] 🐛 **Incorrect Documentation** - Docs contain errors or wrong information
|
|
- [ ] ✨ **Enhancement Request** - Suggestion for better documentation
|
|
- [ ] 🔗 **Broken Links** - Links that don't work or go to wrong places
|
|
- [ ] 📱 **Format/Structure** - Improve organization or presentation
|
|
|
|
## 📍 Location
|
|
<!-- Where is the documentation issue? -->
|
|
**File(s) affected:**
|
|
- [ ] README.md (main)
|
|
- [ ] integration/claude/README.md
|
|
- [ ] integration/claude/TESTING.md
|
|
- [ ] integration/claude/complete-test-framework.md
|
|
- [ ] integration/claude/manual-test-guide.md
|
|
- [ ] docs/claude-integration.md
|
|
- [ ] CONTRIBUTING.md
|
|
- [ ] Other: _______________
|
|
|
|
**Section/area:**
|
|
<!-- Specific section, heading, or line numbers -->
|
|
|
|
## 📋 Current State
|
|
<!-- What exists now (if anything)? -->
|
|
**Current documentation:**
|
|
<!-- Quote or describe the current documentation -->
|
|
|
|
**What's wrong/missing:**
|
|
<!-- Specific description of the issue -->
|
|
|
|
## ✨ Requested Improvement
|
|
<!-- What should the documentation say/include? -->
|
|
**Proposed content:**
|
|
<!-- Describe what the documentation should include -->
|
|
|
|
### Specific Additions/Changes
|
|
<!-- Detailed description of needed changes -->
|
|
|
|
### Target Audience
|
|
<!-- Who is this documentation for? -->
|
|
- [ ] New users trying to get started
|
|
- [ ] Experienced users looking for advanced features
|
|
- [ ] Developers wanting to contribute
|
|
- [ ] Troubleshooting specific issues
|
|
- [ ] Integration with existing BMAD workflows
|
|
|
|
## 🎯 Use Case
|
|
<!-- Why is this documentation needed? -->
|
|
**User scenario:**
|
|
<!-- Describe when someone would need this documentation -->
|
|
|
|
**Current pain points:**
|
|
<!-- What problems does the missing/poor documentation cause? -->
|
|
|
|
## 📝 Content Suggestions
|
|
<!-- Specific content ideas -->
|
|
|
|
### Structure
|
|
<!-- How should this be organized? -->
|
|
|
|
### Examples
|
|
<!-- What examples would be helpful? -->
|
|
|
|
### Code Samples
|
|
```bash
|
|
# Example commands that should be documented
|
|
```
|
|
|
|
### Screenshots/Diagrams
|
|
<!-- Would visual aids help? -->
|
|
|
|
## 🔗 Related Documentation
|
|
<!-- Link to related docs or issues -->
|
|
- Similar documentation in: [link]
|
|
- Related to issue: #(number)
|
|
- Referenced in: [location]
|
|
|
|
### External References
|
|
<!-- Helpful external resources -->
|
|
- Claude Code official docs
|
|
- BMAD methodology guides
|
|
- Similar project documentation
|
|
|
|
## 📊 Priority/Impact
|
|
<!-- Help us understand the importance -->
|
|
|
|
### Impact Level
|
|
- [ ] 🔥 **Critical** - Blocks users from basic functionality
|
|
- [ ] 🟠 **High** - Significantly impacts user experience
|
|
- [ ] 🟡 **Medium** - Moderately helpful improvement
|
|
- [ ] 🟢 **Low** - Nice to have enhancement
|
|
|
|
### User Frequency
|
|
- [ ] Daily use - core functionality
|
|
- [ ] Weekly use - common workflows
|
|
- [ ] Monthly use - occasional needs
|
|
- [ ] Rare use - edge cases
|
|
|
|
### Complexity
|
|
- [ ] Simple addition/fix (minutes)
|
|
- [ ] Medium effort (hours)
|
|
- [ ] Complex documentation (days)
|
|
- [ ] Major restructuring needed
|
|
|
|
## 🎭 Agent-Specific Context
|
|
<!-- If this relates to specific agents -->
|
|
**Relevant agents:**
|
|
- [ ] 📊 Analyst documentation
|
|
- [ ] 🏗️ Architect documentation
|
|
- [ ] 👨💻 Dev documentation
|
|
- [ ] 📋 PM documentation
|
|
- [ ] 🔍 QA documentation
|
|
- [ ] 🎯 Scrum Master documentation
|
|
- [ ] 🔄 Cross-agent workflows
|
|
|
|
**BMAD methodology context:**
|
|
<!-- How does this relate to BMAD workflows? -->
|
|
|
|
## ✅ Acceptance Criteria
|
|
<!-- How would you know this is done well? -->
|
|
- [ ] Information is accurate and up-to-date
|
|
- [ ] Examples work when followed step-by-step
|
|
- [ ] Language is clear and accessible
|
|
- [ ] Structure is logical and easy to navigate
|
|
- [ ] Covers all necessary use cases
|
|
- [ ] Includes troubleshooting for common issues
|
|
|
|
## 🤝 Contribution
|
|
<!-- Can you help with this documentation? -->
|
|
- [ ] I can write the documentation
|
|
- [ ] I can provide content/examples
|
|
- [ ] I can review drafts
|
|
- [ ] I can test the documented procedures
|
|
- [ ] I need help but want to contribute
|
|
|
|
### Draft Content
|
|
<!-- If you have content ideas, include them here -->
|
|
|
|
## 📋 Additional Context
|
|
<!-- Anything else that would be helpful -->
|
|
|
|
### User Feedback
|
|
<!-- Any user feedback about documentation gaps? -->
|
|
|
|
### Common Questions
|
|
<!-- Questions that this documentation should answer -->
|
|
|
|
### Success Stories
|
|
<!-- Examples of when good documentation helped -->
|
|
|
|
---
|
|
|
|
**Please ensure you've:**
|
|
- [ ] Checked existing documentation to avoid duplicates
|
|
- [ ] Provided specific location information
|
|
- [ ] Included concrete suggestions for improvement
|
|
- [ ] Considered the target audience
|
|
- [ ] Specified the impact and priority level
|