Spaces:
Sleeping
Sleeping
Create KB_Style_Guide.md
Browse files- kb/KB_Style_Guide.md +63 -0
kb/KB_Style_Guide.md
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# 📘 3. Style Guide for Writing Customer-Facing Documentation
|
| 2 |
+
- Empathetic
|
| 3 |
+
- Professional
|
| 4 |
+
|
| 5 |
+
|
| 6 |
+
Tone varies:
|
| 7 |
+
- **Troubleshooting:** calm, reassuring
|
| 8 |
+
- **Quick tasks:** concise
|
| 9 |
+
- **Policies:** neutral
|
| 10 |
+
|
| 11 |
+
|
| 12 |
+
---
|
| 13 |
+
|
| 14 |
+
|
| 15 |
+
## 2. General Writing Rules
|
| 16 |
+
|
| 17 |
+
|
| 18 |
+
- Use active voice
|
| 19 |
+
- Keep sentences under 20 words
|
| 20 |
+
- Avoid filler
|
| 21 |
+
- Prefer verbs
|
| 22 |
+
- Use contractions
|
| 23 |
+
|
| 24 |
+
|
| 25 |
+
---
|
| 26 |
+
|
| 27 |
+
|
| 28 |
+
## 3. Do / Don’t Examples
|
| 29 |
+
|
| 30 |
+
|
| 31 |
+
**Do:**
|
| 32 |
+
✔ “Click **Save** to confirm the update.”
|
| 33 |
+
✔ “If you don’t see the option, try refreshing the page.”
|
| 34 |
+
|
| 35 |
+
|
| 36 |
+
**Don’t:**
|
| 37 |
+
✘ “Users should ensure they save the settings.”
|
| 38 |
+
✘ “This feature may or may not appear.”
|
| 39 |
+
|
| 40 |
+
|
| 41 |
+
---
|
| 42 |
+
|
| 43 |
+
|
| 44 |
+
## 4. Formatting Rules
|
| 45 |
+
|
| 46 |
+
|
| 47 |
+
- Numbered steps for processes
|
| 48 |
+
- Bullets for lists
|
| 49 |
+
- Clean screenshots
|
| 50 |
+
- Use callouts for warnings or tips
|
| 51 |
+
- Code blocks for commands
|
| 52 |
+
|
| 53 |
+
|
| 54 |
+
---
|
| 55 |
+
|
| 56 |
+
|
| 57 |
+
## 5. Accessibility Requirements
|
| 58 |
+
|
| 59 |
+
|
| 60 |
+
- Include alt text
|
| 61 |
+
- Don’t rely only on color
|
| 62 |
+
- Use consistent headings
|
| 63 |
+
- Ensure high contrast
|