User:Matt

From doityourselfchristmas.com
Jump to: navigation, search

The Vixen pages in the wiki are somewhat disorganized. The following are some proposed (they do not apply to anything, please disregard them at this point) guidelines I thought up to make the naming and format of pages relating to Vixen more consistent.

  • How-to pages are pages that contain step-by-step instructions to perform a task. Reference pages are pages that contain information that is not in step-by-step format.
  • How-to pages should be linked to from the Vixen How-to's page, with the exception of troubleshooting how-tos, which should be linked to from the Vixen Troubleshooting page.
  • Reference pages should be linked to from the Vixen Reference page, or another appropriate page.
  • All pages should be a part of the Vixen category. Put a link to Category:Vixen at the top of the wikitext.
  • How-to pages should not begin with any form of the words "How to" (ex. "Create a profile" rather than "How to create a profile").
  • How-to pages should be in the present tense verb form (not progressive). To check, see if the words "How to" make sense in front of them (Ex. (How to)"Add a sequence to a program" instead of (How to)"Adding a sequence to a program")
  • It is important that "in Vixen" is added to How-To titles when the fact that they are related to Vixen may not be apparent (ex. use "Set up a Renard in Vixen" rather than "Set up a Renard"). If it is obvious that the article has to do with Vixen (ex. "How to set up a LedTriks sequence"), "in Vixen" can be omitted.
  • How-to pages should use the wiki software's ordered lists (by adding a pound sign at the beginning of each step, like this:
  1. Step 1
  2. Step 2

If each step is lengthy (more than a couple of sentences), it should use nested section headers (with equals signs) like this:

Blah

txt

Blah

txt

Blah

txt

In this case (nested sections), the section headers should be descriptive (ex. use "Set up the channel colors" rather than "Step 5").