Anatomy of a Knowledge Base article

Revision Information
  • Revision id: 32805
  • Created:
  • Creator: Michael Verdi
  • Comment: [Work in Progress]
  • Reviewed: No
  • Ready for localization: No
Revision Source
Revision Content

This is the introduction where I give you some context for this article and a brief overview of what's in it. By doing this you can quickly determine if this is the right article for you.

In this case, you want lean how to write help articles for Mozilla Support. So in this article I'll show you examples of the most common writing techniques and wiki markup that we use. You can use both the article and it's wiki source as a guide when you write.

In general, we have two basic kinds of articles with two kinds of introductions:

  • Tutorial or how-to article intros: A brief summary of the feature or task and what things can be learned (example).
  • Troubleshooting article intros: A brief summary of the symptoms and the solution (example).

How to structure an article

The general idea here is to try to build skills from simple to complex while trying to keep the information needed by most people near the top. So a simple, common solution would usually come before a complex or edge-case solution.

For example, in this Tab Groups article we start with why you should use the feature, then move on to how to make a group and end with more complicated tasks like searching and organizing.

Write descriptive section headings

By naming the section after the task or solution it allows people to quickly browse the article or scan the table of contents to see the scope of the article. In some cases this may be enough information for some users and they wouldn't even need to read the rest of the article.

Create step-by-step instructions

There's nothing more frustrating than finally finding the instructions you need and then getting stranded while trying to follow them because the writer assumed you knew something you didn't. This is why we break our instructions out into complete, step-by-step instructions. If you have to click "OK" at some point we even make that a step.

Here's an example from the How to set the home page article:

  1. Open up the website you want to be your home page.
  2. Click on the icon to the left of the web address, drag it to the Home button and then let go.
  3. Click Yes to set this as your home page.

Create instructions for different operating systems or versions of Firefox