Anatomy of a Knowledge Base article

Revision Information
  • Revision id: 32665
  • 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 to 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

Create step-by-step instructions

Create instructions for different operating systems or versions of Firefox