Self-Service-KB-Assistant / kb /kb_best_practices.md
sofzcc's picture
Update kb/kb_best_practices.md
d1514bf verified

A newer version of the Gradio SDK is available: 6.5.1

Upgrade

📘 1. What Makes an Excellent Knowledge Base Article


4. Use a Support-Friendly Tone

Tone should feel:

  • Friendly
  • Confident
  • Supportive

Good: “Let’s walk through how to reset your password.”

Not so good: “Resetting a password requires following the steps below.”


5. Test Before Publishing

Ensure someone else:

  • Follows the steps
  • Tests the flow
  • Flags unclear phrasing

Writers are often too close to see gaps.


6. Keep It Short — But Complete

Balance:

  • Minimalism (no fluff)
  • Completeness (no missing steps)

Provide just enough context for understanding.


7. Evolve With Product Changes

Update articles when:

  • UI changes
  • Buttons are renamed
  • Policies shift
  • Processes change

A KB is a living system.