Spaces:
Sleeping
Sleeping
Create internal_kb.md
Browse files- kb/internal_kb.md +57 -0
kb/internal_kb.md
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# 📘 6. Internal Knowledge for Support Teams: Playbooks, SOPs & Decision Trees
|
| 2 |
+
*How to write internal vs external docs*
|
| 3 |
+
|
| 4 |
+
|
| 5 |
+
Internal and external content have different goals.
|
| 6 |
+
|
| 7 |
+
|
| 8 |
+
---
|
| 9 |
+
|
| 10 |
+
|
| 11 |
+
## 1. Internal Docs Prioritize Efficiency
|
| 12 |
+
|
| 13 |
+
|
| 14 |
+
Internal SOPs must:
|
| 15 |
+
- Be explicit
|
| 16 |
+
- Cover exceptions
|
| 17 |
+
- Include conditional logic
|
| 18 |
+
- Contain internal notes
|
| 19 |
+
|
| 20 |
+
|
| 21 |
+
---
|
| 22 |
+
|
| 23 |
+
|
| 24 |
+
## 2. External Docs Prioritize Clarity
|
| 25 |
+
|
| 26 |
+
|
| 27 |
+
External KBs must:
|
| 28 |
+
- Use simple language
|
| 29 |
+
- Avoid jargon
|
| 30 |
+
- Assume zero prior knowledge
|
| 31 |
+
|
| 32 |
+
|
| 33 |
+
---
|
| 34 |
+
|
| 35 |
+
|
| 36 |
+
## 3. Decision Trees
|
| 37 |
+
|
| 38 |
+
|
| 39 |
+
Useful for:
|
| 40 |
+
- Multi-step workflows
|
| 41 |
+
- Troubleshooting
|
| 42 |
+
- High-risk steps
|
| 43 |
+
|
| 44 |
+
|
| 45 |
+
---
|
| 46 |
+
|
| 47 |
+
|
| 48 |
+
## 4. Playbooks
|
| 49 |
+
|
| 50 |
+
|
| 51 |
+
Great for:
|
| 52 |
+
- Outages
|
| 53 |
+
- Escalations
|
| 54 |
+
- Exceptions
|
| 55 |
+
|
| 56 |
+
|
| 57 |
+
Provide clear ownership.
|