File tree Expand file tree Collapse file tree 1 file changed +4
-5
lines changed Expand file tree Collapse file tree 1 file changed +4
-5
lines changed Original file line number Diff line number Diff line change @@ -67,16 +67,15 @@ This list is non-exhaustive. If there is something you would like to see on the
67
67
## ✅ Do
68
68
69
69
- Cite sources if you reference third-party tools or documentation.
70
- - Avoid assumptions: don’t assume the reader knows your stack.
71
70
- Use inclusive language: prefer "you/the user" over gendered or assumptive terms.
72
71
- Use present tense.
73
72
74
73
## ❌ Don't
75
74
76
- - Overuse of metaphors. Use them sparingly to aid understanding .
77
- - Outdated examples or deprecated syntax .
78
- - Avoid passive voice when possible .
79
- - Avoid future tense.
75
+ - Don’t assume the reader knows your stack .
76
+ - Don't overuse of metaphors. Use them sparingly to aid understanding .
77
+ - Don't overuse passive voice. Active voice often brings more clarity .
78
+ - Don't overuse future tense. The present tense often brings more clarity .
80
79
81
80
---
82
81
You can’t perform that action at this time.
0 commit comments