Anatomy of a Knowledge Base article

Revision Information
  • Revision id: 119034
  • Created:
  • Creator: Laucon
  • Comment: I put the google form in a box.
  • Reviewed: No
  • Ready for localization: No
Revision Source
Revision Content

Mozilla support articles have several basic sections. Mozillians write out articles in a wiki markup style in the textbox. The text is then published as a Mozilla article. Here you find some highlighted sections in different colors, both in the wiki markup textbox and in the finished article, followed by the corresponding explanation.

ArticleAnatomy

WikiMarkupAnatomy

  • The red line at the top shows the article’s title. Mozillians don’t write out the title in the wiki markup page. They write the title in the article’s description section. Here you find more information about categorizing articles.
  • The orange section shows the header. Notice how in the wiki markup section the header is surrounded by two equal signs.
  • The yellow section contains the introductory information. It’s helpful to add this so that readers know what the article is about and what they can learn by reading it.
  • Green shows the first step. Notice how in the wiki markup the individual steps are distinguished with hash symbols.
  • Blue contains a screenshot. Screenshots are crucial for illustrating concepts in articles. Readers may not understand a concept if they can’t visualize it. Notice how the wiki markup designates a screenshot with an image name. Find out how to make screenshots here.
  • The purple box contains a note with additional information. Notice how this section is surrounded by a note notation.

More Information

  • All wiki markup symbols can be found in the Markup chart.
  • To learn how to create an article step-by-step, click here.
  • Learn how to use the For function and templates.
  • Learn how to categorize an article with an article's description.
  • Learn how to edit articles by looking through an article's history.

After reading this article, please fill out this quick form.