---
name: 📚 Documentation
about: Report documentation issues or suggest improvements
title: '[Docs] '
labels: ['documentation', 'good first issue']
assignees: ''
---

## 📚 Documentation Issue

### 📋 Type of Documentation Issue
<!-- Select the type of documentation issue -->
- [ ] 📝 Missing Documentation
- [ ] 🔧 Incorrect/Outdated Information
- [ ] 🎯 Unclear/Confusing Content
- [ ] 🌐 Translation Request
- [ ] 🔗 Broken Links
- [ ] 📖 New Tutorial/Guide Request
- [ ] 🎨 Formatting/Style Issues
- [ ] 📊 Missing Examples/Code Samples

### 📍 Location
<!-- Where is the documentation issue? -->

**Documentation Section**:
- [ ] README.md
- [ ] API Documentation
- [ ] SDK Documentation (Python/JavaScript/Go)
- [ ] Architecture Documentation
- [ ] Contributing Guide
- [ ] Installation/Setup Guide
- [ ] Tutorial/Examples
- [ ] Code Comments/Docstrings
- [ ] Website/External Docs
- [ ] Other: ___________

**Specific File/Page**: 
<!-- Provide the exact file path or URL -->

**Section/Heading**: 
<!-- Which section specifically? -->

### 🔍 Current State
<!-- What currently exists (or doesn't exist)? -->

**Current Content** (if applicable):
```markdown
<!-- Paste the current problematic content here -->
```

**What's Wrong**:
<!-- Describe the specific issue -->

### 🎯 Desired Improvement

**Expected Content**:
<!-- What should the documentation say instead? -->

**Suggested Changes**:
<!-- Provide specific suggestions for improvement -->

### 👥 Target Audience
<!-- Who is this documentation for? -->
- [ ] 🆕 New users/beginners
- [ ] 👨‍💻 Developers (general)
- [ ] 🔬 Researchers/Scientists
- [ ] 🏢 Enterprise users
- [ ] 🛠️ Contributors/Maintainers
- [ ] 🎓 Students/Educators

### 📊 Context & Use Case

**User Journey**:
<!-- When/why would someone need this documentation? -->

**Problem Being Solved**:
<!-- What problem does this documentation help solve? -->

**Current Pain Points**:
<!-- What difficulties do users face without this documentation? -->

### 💡 Content Suggestions

**Proposed Structure**:
<!-- How should the content be organized? -->

**Key Topics to Cover**:
- [ ] Topic 1
- [ ] Topic 2
- [ ] Topic 3

**Examples Needed**:
- [ ] Code examples
- [ ] Configuration examples
- [ ] Real-world use cases
- [ ] Screenshots/Diagrams
- [ ] Video tutorials

### 🔗 Related Resources

**Existing Documentation**:
<!-- Link to related documentation that exists -->

**External References**:
<!-- Any external resources that could help -->

**Similar Examples**:
<!-- Examples from other projects that do this well -->

### 🌍 Internationalization
<!-- For translation requests -->

**Target Language**: 
**Native Speaker Available**: Yes/No
**Translation Scope**: 
- [ ] Full documentation
- [ ] Key sections only
- [ ] Getting started guide
- [ ] API reference

### 📊 Priority & Impact

**Priority Level**:
- [ ] 🔴 Critical (blocks user adoption)
- [ ] 🟠 High (significant user impact)
- [ ] 🟡 Medium (improves experience)
- [ ] 🟢 Low (nice to have)

**User Impact**:
<!-- How many users would benefit? What's the impact? -->

**Accessibility Impact**:
- [ ] Improves accessibility
- [ ] No accessibility impact
- [ ] May need accessibility review

### ✅ Acceptance Criteria
<!-- How will we know this issue is resolved? -->

- [ ] Content is accurate and up-to-date
- [ ] Writing is clear and accessible
- [ ] Examples are provided where helpful
- [ ] Links work correctly
- [ ] Content follows style guide
- [ ] Content is properly formatted
- [ ] SEO considerations addressed (if web docs)

### 🤝 Contribution Interest

**Would you like to help fix this?**
- [ ] Yes, I can write the content
- [ ] Yes, I can review/edit content
- [ ] Yes, I can provide examples
- [ ] Yes, I can help with translation
- [ ] I can provide feedback but not write
- [ ] No, but I hope someone else will

**Your Background**:
<!-- What's your experience with this topic? -->

### 📋 Additional Information

**Screenshots** (if applicable):
<!-- Add screenshots to illustrate the issue -->

**Error Messages** (if applicable):
```
<!-- Paste any error messages related to documentation -->
```

**Browser/Platform** (if web documentation):
<!-- Which browser/platform are you using? -->

---

### 🌟 Why Good Documentation Matters
Great documentation is crucial for:
- 🚀 Faster user onboarding
- 💡 Better developer experience  
- 🤝 Stronger community engagement
- 📈 Increased adoption and success

### 👋 New to Contributing?
Documentation is a fantastic way to start contributing to open source! Check out:
- [Contributing Guide](../../CONTRIBUTING.md)
- [Documentation Style Guide](../../docs/STYLE_GUIDE.md)
- [Good First Issues](../../labels/good%20first%20issue)

**Ready to help?** Comment below and we'll help you get started!