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