Help:Editing 'How To' Articles: Difference between revisions
Jump to navigation
Jump to search
Line 11: | Line 11: | ||
# 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 the imperative voice, but try to write in complete sentences and paragraphs, rather than a bulleted list. | # Write your article. Use the imperative voice, but try to write in complete sentences and paragraphs, rather than a bulleted list. | ||
# Add <tt><nowiki> | # Add <tt><nowiki>{{How To Header}}</nowiki></tt> at the top of your page to link the page back to the rest of the How Tos. |
Revision as of 21:51, 22 May 2007
What Is a 'How To'?
"How To" articles generally give instructions for accomplishing some goal, and their titles should describe the action of completing that goal. Good examples of How To pages are:
- How To:Dump Via an SSH Tunnel
- How To:Recover SQLite Databases From Backups
Bad examples might be:
- How To:Amcheck Errors -- "Amcheck Errors" is not an action.
- How To:Backup With Amanda -- That's what the whole wiki is about! Be more specific.
Beginning a 'How To' Article
- Edit How Tos to add a link to your (as-yet nonexistant) article.
- Click on the red link that results when you save your changes.
- Write your article. Use the imperative voice, but try to write in complete sentences and paragraphs, rather than a bulleted list.
- Add {{How To Header}} at the top of your page to link the page back to the rest of the How Tos.