GENERAL / CROSS-FUNCTIONAL TEMPLATE
Knowledge Base Article Template
Help article: overview, step-by-step instructions, troubleshooting, and FAQ.
Use this templateWhat's inside
Field | Details |
|---|---|
Topic | |
Audience | Who this article is for |
Author | |
Last Updated |
Overview
What does this article cover and who is it for? One paragraph so readers can quickly tell if this is the right article.
Before You Start
What does the reader need before following these instructions? Delete this section if there are no prerequisites.
Prerequisite 1
Prerequisite 2
Instructions
Walk through the steps clearly. Number them. Be specific about what to click, type, or select.
Step | Action | Expected Result |
|---|---|---|
1 | Describe what to do | What the user should see after this step |
2 | ||
3 | ||
4 | ||
5 | Verify the result | How to confirm it worked |
Troubleshooting
Common problems and how to fix them. Delete if not applicable.
Problem | Cause | Solution |
|---|---|---|
What went wrong | Why | How to fix it |
FAQ
Question | Answer |
|---|---|
Common question | Clear answer |
Related Articles
Link to related article
