Help center · Template
A simple help article template you can copy
Most help articles have the same shape: the question, the short answer, the steps, and what to do if it fails. Here's that shape as a template, plus a filled-in example.
The template
Title: [The question or task, in the customer's words]
e.g. "How do I export my data?"
Short answer (1–2 sentences):
[What to do and where. Name the menu path.]
Before you start (optional):
[A plan, permission or thing they need first. Skip if none.]
Steps:
1. [One action. Use the exact button name.]
2. [Next action.]
3. [What they should see when it worked.]
If it doesn't work:
- [Most common reason and the fix.]
- [Second most common reason and the fix.]
- Still stuck? [Link to contact.]
Related:
- [The one article people usually need next.]
A filled-in example
Say you run a small invoicing app, and three people this month asked how to get their invoices out.
How do I export my invoices?
Open Invoices, select Export at the top right and pick CSV or PDF. The file downloads right away.
Before you start: the export includes invoices from the date range in the filter. Set it to “All time” to get everything.
- Open Invoices from the left menu.
- Set the date filter to the range you need.
- Select Export, then CSV (for spreadsheets) or PDF (for printing).
- The file appears in your downloads folder.
If it doesn't work:
- Nothing downloads: your browser may be blocking downloads from our site. Look for a blocked-download icon in the address bar.
- The file is empty: the date filter may leave out every invoice. Set it to “All time.”
- Still stuck? Send us a message with the date range you tried.
Related: How to import invoices from another tool
Why this shape works
The short answer helps people who only need a reminder. The steps help people doing it for the first time. The “if it doesn't work” part catches people who already tried and failed. Those are often the ones who would otherwise write to you.
When to bend the template
- Explanations, like “How billing works,” don't need steps. Use a few short parts with clear headings.
- Troubleshooting articles, like “Emails aren't arriving,” can be a list of causes, most common first.
- Some answers fit in the title and one sentence. That's fine. Don't pad them.
Quick rule: Write the article right after you answer the question by email. The details are fresh, and your reply is already a first draft.
More on the writing itself: how to write help articles people actually read. In MVPKit, paste the template into a new article and fill it in. Each article gets its own page on your project's help center, grouped in categories, with search.
Have a few answers ready? Publish them with MVPKit.