Creating FAQs

  • Revision slug: Project:Creating_FAQs
  • Revision title: Creating FAQs
  • Revision id: 196366
  • Created:
  • Creator: Dria
  • Is current revision? Yes
  • Comment /* Example entry */

Revision Content

If you have any questions about anything related to the creation of FAQs, please ask on mozilla.dev.mdc or email deb@mozilla.com.

How to create a FAQ

If you would like to help write a FAQ, the process is very simple:

  1. Pick the Topic you would like to write a FAQ for.
  2. Look for that Topic's FAQ page, which should be named "{{ mediawiki.external('Topic') }} FAQ", e.g.: XPCOM FAQ
  3. If the page does not exist yet, you can create it by following the directions outlined here.
  4. Add your question and answer to the page using the following format, with the question as a third-level subheading, and the answer as regular text below it. See the example in the yellow box, below.
  5. If it makes sense to break the FAQ up into subsections, feel free to do so. Until there are a relatively large number of questions on the list, however, it probably won't be necessary. Eventually, after the FAQs get particularly long, we will look at breaking them up into smaller subdocuments, but for now don't worry about that too much.

Example entry

How do I start a new page?

The easiest way to start a new page is to create a link for it on your user page, then use that link to enter into the "Edit" mode for the page.

To get to your user page, click on your user name in the top blue bar of the wiki. If you haven't added anything to your user page, you'll be brought immediately into the editing form for the page where you can add whatever content you like.

Creating a link to the page you want to add is as simple as writing the title for the page enclosed with double square brackets, like this: [[Here is an example]]. When saved, that will be turned into a link, like this: Here is an example.

Revision Source

<p> </p><p>If you have any questions about anything related to the creation of FAQs, please ask on <a class="external" href="http://groups.google.com/group/mozilla.dev.mdc">mozilla.dev.mdc</a> or email <a class="link-mailto" href="mailto:deb@mozilla.com">deb@mozilla.com</a>.
</p>
<h3 id="How_to_create_a_FAQ" name="How_to_create_a_FAQ"> How to create a FAQ </h3>
<p>If you would like to help write a FAQ, the process is very simple:
</p>
<ol><li> Pick the Topic you would like to write a FAQ for.
</li><li> Look for that Topic's FAQ page, which should be named "{{ mediawiki.external('Topic') }} FAQ", e.g.: <a href="en/XPCOM_FAQ">XPCOM FAQ</a>
</li><li> If the page does not exist yet, you can create it by following the directions outlined <a href="Project:en/Getting_started#Starting_a_new_page">here</a>.
</li><li> Add your question and answer to the page using the following format, with the question as a third-level subheading, and the answer as regular text below it. See the example in the yellow box, below.
</li><li> If it makes sense to break the FAQ up into subsections, feel free to do so. Until there are a relatively large number of questions on the list, however, it probably won't be necessary. Eventually, after the FAQs get particularly long, we will look at breaking them up into smaller subdocuments, but for now don't worry about that too much.
</li></ol>
<h3 id="Example_entry" name="Example_entry"> Example entry </h3>
<h4 id="How_do_I_start_a_new_page.3F" name="How_do_I_start_a_new_page.3F"> How do I start a new page? </h4>
<p>The easiest way to start a new page is to create a link for it on your user page, then use that link to enter into the "Edit" mode for the page. </p><p>To get to your user page, click on your user name in the top blue bar of the wiki. If you haven't added anything to your user page, you'll be brought immediately into the editing form for the page where you can add whatever content you like. </p><p>Creating a link to the page you want to add is as simple as writing the title for the page enclosed with double square brackets, like this: <code><span class="nowiki">[[Here is an example]]</span></code>. When saved, that will be turned into a link, like this: <a href="en/Here_is_an_example">Here is an example</a>.
</p>
Revert to this revision