5.7 KiB
5.7 KiB
| name | about | title | labels | assignees | ||
|---|---|---|---|---|---|---|
| 📚 Documentation | Request documentation improvements or report documentation issues | [DOCS] |
|
📚 Documentation Issue
📋 Documentation Type
- 📖 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
- ❌ 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
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:
📋 Current State
Current documentation:
What's wrong/missing:
✨ Requested Improvement
Proposed content:
Specific Additions/Changes
Target Audience
- 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
User scenario:
Current pain points:
📝 Content Suggestions
Structure
Examples
Code Samples
# Example commands that should be documented
Screenshots/Diagrams
🔗 Related Documentation
- Similar documentation in: [link]
- Related to issue: #(number)
- Referenced in: [location]
External References
- Claude Code official docs
- BMAD methodology guides
- Similar project documentation
📊 Priority/Impact
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
Relevant agents:
- 📊 Analyst documentation
- 🏗️ Architect documentation
- 👨💻 Dev documentation
- 📋 PM documentation
- 🔍 QA documentation
- 🎯 Scrum Master documentation
- 🔄 Cross-agent workflows
BMAD methodology context:
✅ Acceptance Criteria
- 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
- 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
📋 Additional Context
User Feedback
Common Questions
Success Stories
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