Templates

Help Center Article Template: How to Write Docs Customers Actually Read

Three copy-ready templates for how-to, troubleshooting and explainer articles, the style rules that make them easy to scan, and a checklist to run before you publish.

Eric Dunaway
Eric Dunaway
Spaceli
4 min read

Most help center articles fall into three types: a how-to (do a task), a troubleshooting article (fix a problem) and an explainer (understand a concept). Each type has a shape that works, and customers read articles that follow it. Below are three copy-ready templates, the style rules that make them easy to scan, and a checklist to run before you publish.

Three templates

How-to: do a task

How-to template
# [Verb + task, in the customer's words]

One sentence: what this does and how long it takes.

## Before you start
- Plan, role or setting you need

## Steps
1. Go to **Settings > Billing**.
2. Select **Change plan**.
3. ...

## What happens next
What the customer will see once it's done.

## Related
- Next likely question

Troubleshooting: fix a problem

Troubleshooting template
# [The problem, as the customer would describe it]

One sentence: the most common cause.

## Quick fix
The fix that solves most cases, in two or three steps.

## Still not working?
### Cause 2: [description]
Fix in steps.
### Cause 3: [description]
Fix in steps.

## Contact us
What to include in the message: account, screenshots, error text.

Explainer: understand a concept

Explainer template
# [What is / How does X work]

Two sentences: what it is and why it matters to the customer.

## How it works
Short paragraphs or a diagram.

## Example
One realistic scenario.

## What you can do with it
Links to the how-to articles.

Style rules for help articles

  • Title it the way customers ask. "Change your billing email", not "Billing contact management".
  • Answer in the first line. Many readers stop after it.
  • One action per step. Start each step with a verb, and put button and menu names in bold, exactly as they appear.
  • Show the hard parts. A screenshot for any step where people get stuck; crop it to the relevant area.
  • Use plain words. Write "select", not "utilize the selection functionality". Avoid internal names customers never see.
  • Use callouts sparingly. A Warning for what can't be undone, a Tip for the shortcut. More than two per article and they stop standing out.
  • Keep one task per article. Link to related tasks instead of folding them in.
  • Write for scanning. Short paragraphs, headings every few steps, no walls of text.

Checklist before you publish

  • The title matches how customers phrase the question
  • The first line answers it
  • Every step was tested in the current version of the product
  • Button and menu names match the product exactly
  • Screenshots are current and cropped
  • Related articles are linked at the end
  • Someone outside the team followed it without help

Publishing from Google Docs

If your team writes help articles in Google Docs, you don't need to paste them into a separate help desk editor. Put them in one Drive folder and connect it to Spaceli: make the space public and customers can read it without an account. Every article gets clean typography and a table of contents, callouts and code blocks are written right in the Doc, and a YouTube link on its own line, or the embed code of a Loom recording, becomes an embedded video. Your support team keeps editing in Google Docs, or right inside Spaceli, and changes sync with Drive.

Public spaces aren't indexed by search engines today, so link to articles from your product, emails and support replies. Custom domains are coming soon. The whole setup, from the first folder to getting customers to it, is in how to build a public help center from Google Docs.

FAQ

How long should a help center article be?

As short as the task allows. Most how-to articles fit on one screen; if yours doesn't, it may be two tasks.

Should every article have screenshots?

Only where they help. Screenshots age quickly, so use them for confusing steps, not for every click.

How often should help articles be reviewed?

With every product change that affects them, and the most-viewed articles once a quarter.

Eric Dunaway
Written by Eric Dunaway

Writes about wikis, documentation and how teams keep their knowledge easy to find.

Share

Your knowledge base is already in Google Drive.

Give your team a better way to organize, find, and share knowledge. Keep your documents right where they are.

Start for Free

Free during the beta. Get started in about a minute.

Spaceli only accesses the folders you choose.