63 lines
No EOL
1.5 KiB
Markdown
63 lines
No EOL
1.5 KiB
Markdown
---
|
|
name: Documentation
|
|
about: Improve or add documentation
|
|
title: '[DOCS] '
|
|
labels: ['documentation']
|
|
assignees: ''
|
|
---
|
|
|
|
## Documentation Issue
|
|
What documentation is missing, unclear, or needs improvement?
|
|
|
|
## Location
|
|
**File(s)**:
|
|
**Section/Function**:
|
|
**Current Documentation State**: [Missing/Incomplete/Unclear/Outdated]
|
|
|
|
## Problem
|
|
Describe what makes the current documentation insufficient:
|
|
- [ ] Missing entirely
|
|
- [ ] Incomplete information
|
|
- [ ] Unclear explanations
|
|
- [ ] Outdated information
|
|
- [ ] Poor examples
|
|
- [ ] Hard to find
|
|
|
|
## Proposed Improvement
|
|
What should be documented or how should it be improved?
|
|
|
|
## Target Audience
|
|
Who is this documentation for?
|
|
- [ ] New contributors
|
|
- [ ] End users
|
|
- [ ] API developers
|
|
- [ ] System administrators
|
|
- [ ] Advanced users
|
|
|
|
## Content Outline
|
|
Provide a rough outline of what should be documented:
|
|
1.
|
|
2.
|
|
3.
|
|
|
|
## Examples Needed
|
|
What examples would be helpful?
|
|
|
|
## Related Code
|
|
Link to relevant code files or functions that need documentation.
|
|
|
|
## Additional Context
|
|
Add any other context or examples about the documentation improvement.
|
|
|
|
## Priority
|
|
- [ ] High - Blocking contributor onboarding
|
|
- [ ] Medium - Important for user experience
|
|
- [ ] Low - Nice-to-have improvement
|
|
|
|
## Labels to Add
|
|
Select appropriate labels:
|
|
- [ ] `good first issue` - Perfect for newcomers
|
|
- [ ] `api` - API documentation
|
|
- [ ] `testing` - Test documentation
|
|
- [ ] `contributor-experience` - For contributors
|
|
- [ ] `user-guide` - For end users |