ewancroft.uk
+78
.github/ISSUE_TEMPLATE/documentation_improvement.md
+78
.github/ISSUE_TEMPLATE/documentation_improvement.md
···
1
+
---
2
+
name: Documentation Improvement
3
+
about: Suggest improvements to documentation, guides, or help text
4
+
title: '[DOCS] '
5
+
labels: 'documentation'
6
+
assignees: ''
7
+
8
+
---
9
+
10
+
## 📖 Documentation Issue
11
+
**What documentation needs improvement?**
12
+
- [ ] README.md
13
+
- [ ] CONTRIBUTING.md
14
+
- [ ] Code comments
15
+
- [ ] UI help text/tooltips
16
+
- [ ] Error messages
17
+
- [ ] API documentation
18
+
- [ ] Usage examples
19
+
- [ ] Other: _______________
20
+
21
+
## 📍 Location
22
+
**Where is the documentation that needs work?**
23
+
- **File/Section:** [e.g. README.md - "How It Works" section]
24
+
- **URL/Link:** [if applicable]
25
+
- **Line numbers:** [if specific]
26
+
27
+
## ❌ Current Problem
28
+
**What's wrong with the current documentation?**
29
+
- [ ] Information is missing
30
+
- [ ] Information is incorrect or outdated
31
+
- [ ] Information is confusing or unclear
32
+
- [ ] Examples don't work
33
+
- [ ] Formatting/presentation issues
34
+
- [ ] Typos or grammar errors
35
+
- [ ] Other: _______________
36
+
37
+
## ✅ Suggested Improvement
38
+
**What would make this better?**
39
+
A clear description of what should be changed, added, or removed.
40
+
41
+
## 📝 Proposed Content
42
+
**If you have specific content suggestions, provide them here:**
43
+
44
+
```markdown
45
+
Suggested documentation content...
46
+
```
47
+
48
+
## 👥 Target Audience
49
+
**Who would benefit from this improvement?**
50
+
- [ ] New users trying the converter for the first time
51
+
- [ ] Developers wanting to contribute to the project
52
+
- [ ] Users troubleshooting conversion issues
53
+
- [ ] People migrating from WhiteWind to Leaflet
54
+
- [ ] AT Protocol developers
55
+
- [ ] Other: _______________
56
+
57
+
## 🎯 User Story
58
+
**Describe the scenario where this documentation would help:**
59
+
"As a [type of user], I want to [accomplish something], but I'm confused by [current documentation issue]."
60
+
61
+
## 🔗 Related Issues
62
+
**Link any related issues:**
63
+
- Related to #
64
+
- Fixes confusion mentioned in #
65
+
66
+
## ✅ Success Criteria
67
+
**How would we know this documentation improvement is successful?**
68
+
- [ ] Users stop asking questions about this topic
69
+
- [ ] The conversion process is clearer
70
+
- [ ] Fewer support issues
71
+
- [ ] Better onboarding experience
72
+
- [ ] Other: _______________
73
+
74
+
## ✔️ Checklist
75
+
- [ ] I have identified the specific documentation that needs work
76
+
- [ ] I have explained what's confusing or missing
77
+
- [ ] I have considered who this would help
78
+
- [ ] I have checked if this is already covered elsewhere