Anatomy of a Knowledge Base article

Revision Information
  • Revision id: 116767
  • Created:
  • Creator: Laucon
  • Comment: I smoothed out one link.
  • Reviewed: No
  • Ready for localization: No
Revision Source
Revision Content

Anatomy of An Article

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 I’ve highlighted sections in different colors both in the wiki mark up textbox and in the finished article.

ArticleAnatomy

WikiMarkupAnatomy

  • In red at the top is the article’s title. Mozillians don’t write out the title in the wiki mark up page. They write the title in the article’s description section. Find out more about categorizing articles here.
  • In orange is the header. Notice how in the wiki mark up section the header is surrounded by two equal signs.
  • In yellow is the introductory information. It’s helpful to add this so that readers know what the article is about and what the article will teach them to do.
  • In green is the first step. Notice how in the wiki markup, steps are distinguished with hash symbols.
  • In blue is 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.
  • In purple is a box containing a note with additional information. Notice how this section is surrounded by a note notation.

To see all wiki markup symbols, see the markup chart. To learn how to create an article step-by-step, click here.