Technical & ProductContent Creator

Knowledge base template: one help page organized by the questions people ask

A knowledge base template is one organized page that answers the questions readers ask most often, grouped by task rather than by internal department. Each section should give the answer first, then the steps, then the exceptions, and end with a route to a person when the page does not solve the problem. Keep the page short enough to scan in a few minutes, and use a dedicated knowledge base tool when you need search across a large, changing library of articles.

Quality checklist

Check the page against the questions people actually ask

  • Every question a reader would type has a section heading or a quick answer.
  • Each section gives the answer before the steps, not after the background.
  • Steps use the exact labels readers see on screen, with the same capitalization.
  • Each troubleshooting entry names a cause you have confirmed, not a guess.
  • Terms are defined once, at first use, and then used the same way throughout.
  • The page shows the date it was last checked and the person who corrects it.
  • Every link on the page has been opened, and the contact hours are current.
  • Examples contain no passwords, account numbers or internal system addresses.
Section outline

Sections in the order readers need them

  1. Purpose and scope

    Two sentences on who the page helps and what it does not cover, so a reader with a different question leaves early.

    40 words
  2. Quick answers

    Three to five of the most common questions, each answered in one or two sentences for readers who need only a fact.

    120 words
  3. Topic sections

    One section per task, headed with the words a reader would type. Each gives the answer, then the steps, then the exceptions.

    320 words
  4. Troubleshooting

    Symptom, confirmed cause and fix, in a short table or list. Include only problems you have seen and can reproduce.

    150 words
  5. Still stuck?

    Who to contact, the hours they answer, and what to include in a request so the reply does not start with questions.

    60 words
  6. Last checked

    The date the page was last reviewed and the owner responsible for corrections.

    30 words

Total: 720 words

Example excerpt

Sample section: checking an order status

Sample section

Illustrative example: the print studio, its name and its steps are fictional. Check the status of a print order Short answer: Find the order number in your confirmation email, then enter it on the order lookup page. The status line shows one of four stages: received, in production, ready for pickup, or delivered. Steps 1. Open the confirmation email from Larkspur Print Studio and copy the order number. It starts with LP and has six digits. 2. Go to the order lookup page using the link in the email. Enter the number and the email address you used to order. 3. Read the status line. In production means the files are being printed, so no action is needed. If the status has not changed in two business days Reply to the confirmation email with the order number and the word status. Do not send card numbers or full account details. If you cannot find the order number Search your inbox for Larkspur Print Studio. If nothing appears, contact the front desk with the name on the order and the date you placed it.

Format notes

Format for scanning, not for reading straight through

Write headings in the reader's words

Title each section with the question or task, such as Change the delivery address, rather than an internal team or product name. On a single page, readers rely on the browser's find command, so the words they type should appear in the headings.

Answer first, then explain

Start each section with the answer in one or two sentences. Put background, edge cases and history after the steps, so a reader who needs only the fix does not have to read the story first.

Keep one page to one job

A single page suits a bounded set of questions, a few dozen at most. When answers run long or cover several products, split the subject into separate pages and link them from a short index near the top.

Show the check date near the top

A help page with no date leaves readers unsure whether the steps still apply. Put the last-checked date on the first screen, not in the footer.

Mistakes to avoid

Mistakes that make one page hard to use

Organizing by the org chart

Headings such as Account administration describe your departments. A reader looking for how to reset a password will skip past them. Organize by task, and keep department names in the body text.

Burying the answer under background

A section that opens with the history of a policy makes the reader scroll before learning what to do. Move the instruction to the top and the history to the end.

Repeating one answer in several places

Copies of the same answer drift apart. When a step changes, one copy gets fixed and the others stay wrong. Keep one authoritative answer and link to it from the other places.

Promising a search the page cannot give

A single page gives readers the browser's find command, not a search across many articles. If you find yourself needing a search box, the subject has outgrown one page.

Leaving out the still-stuck route

A reader who reaches a case the page does not cover needs a named contact or a request form. Without one, they guess, and may write to a team that cannot help.

Frequently asked questions

Is a knowledge base template the same as knowledge base software?

No. A knowledge base template in this sense is one page that you write and share as a single document. Knowledge base software manages many articles, search, categories and several editors. If you need search across a large library that several people edit, use a dedicated knowledge base tool.

Can I start a knowledge base page without a template?

Yes. Start with the questions that your support messages and staff questions repeat most. Group them by task, answer each one in the order the reader needs, and add the troubleshooting section last, once you know which problems recur.

Where should an internal knowledge base live?

For answers that change often and need several editors, a shared wiki or a dedicated help center keeps one current copy. A single shared page suits a short, stable set of answers, such as the steps for a fixed process that a team reads but rarely changes.

Should a knowledge base page include screenshots?

Use one only where a label or layout is hard to describe, and crop it to the element the step refers to. Screenshots go out of date when a screen changes, so keep the written step as the main instruction and date each screenshot.

Browse by category

More references in Technical & Product

How to build it

  1. Follow the eight-step wizard: type, assets and description, images, branding, contact and call to action, Atty Suggestions, blueprint, and generate. Atty generates one HTML page in the background. Review it, then publish and share the page link or download the HTML file.

Attain OS BETA