Help:Editing FAQs: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (typo) |
||
| Line 2: | Line 2: | ||
"FAQ" articles give specific answers to common questions. They are usually fairly short, and link to other pages describing some feature of Amanda, or to a [[How Tos|how to]] article telling the reader how to do what they want. Try not to duplicate how-to information in a FAQ. | "FAQ" articles give specific answers to common questions. They are usually fairly short, and link to other pages describing some feature of Amanda, or to a [[How Tos|how to]] article telling the reader how to do what they want. Try not to duplicate how-to information in a FAQ. | ||
= Beginning a ' | = Beginning a 'FAQ' Article = | ||
# Edit [[FAQ]] to add a link to your (as-yet nonexistant) article. The title should start with "FAQ:" and end with a question mark. | # Edit [[FAQ]] to add a link to your (as-yet nonexistant) article. The title should start with "FAQ:" and end with a question mark. | ||
# Click on the red link that results when you save your changes. | # Click on the red link that results when you save your changes. | ||
# Write your article. Use complete sentences, rather than a bulleted list of your thoughts. If you only have time for a bulleted list, write that and then ''ask someone else on the mailing list to summarize it.'' | # Write your article. Use complete sentences, rather than a bulleted list of your thoughts. If you only have time for a bulleted list, write that and then ''ask someone else on the mailing list to summarize it.'' | ||
# Add <tt><nowiki>{{FAQ Header}}</nowiki></tt> at the top of your page to link the page back to the rest of the FAQs. | # Add <tt><nowiki>{{FAQ Header}}</nowiki></tt> at the top of your page to link the page back to the rest of the FAQs. | ||
Revision as of 15:22, 9 January 2008
What Is a 'FAQ'?
"FAQ" articles give specific answers to common questions. They are usually fairly short, and link to other pages describing some feature of Amanda, or to a how to article telling the reader how to do what they want. Try not to duplicate how-to information in a FAQ.
Beginning a 'FAQ' Article
- Edit FAQ to add a link to your (as-yet nonexistant) article. The title should start with "FAQ:" and end with a question mark.
- Click on the red link that results when you save your changes.
- Write your article. Use complete sentences, rather than a bulleted list of your thoughts. If you only have time for a bulleted list, write that and then ask someone else on the mailing list to summarize it.
- Add {{FAQ Header}} at the top of your page to link the page back to the rest of the FAQs.