User:Jcreer/Style Guide: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
Line 18: Line 18:


===Navbox and Categories===
===Navbox and Categories===
 
Every page should be included in a category. Categories make it easier to see all pages related to a certain topic which both makes the pages easier to find and easier to update if there is a major change.
 


=Writing Guide=
=Writing Guide=

Revision as of 22:46, 14 October 2014

Article Guide

Article Titles

All articles must have a unique title. The title should indicate the subject of the article with clarity and simplicity. Long titles should be avoided. Articles should start with the appropriate prefix for each product—GMS: for GMS, SMS: for SMS, and WMS: for WMS. If the subject of the article clearly applies to all programs, do not include a prefix.

Redirects

Redirects are helpful in directing users to the correct article for a subject. Most articles should have redirect pages that link to it. For example, an article about a Preferences dialog could be entitled either "Preferences" or "Preferences Dialog." Whichever title the article is given, the other title should be used as a redirect page.

Article Length and Content

When to Merge Articles

Article Components

Intro

Sections

Infoboxes

Related Topics

When appropriate, end articles with a section entitled "Related Topics." This section should contain links to pages with closely related content. Avoid placing an excessive number of links in this section, one or two links should be enough. Avoid having more than four links in this sections. It is not necessary to include every article related to the topic. For example, an article on using nodestrings in the mesh module could have a link to the main mesh module page. A link to every article about nodestrings or the mesh module would be inappropriate.

Long list of links to help navigate a complex topic, such as the mesh module, should place in an infobox or navbox.

Navbox and Categories

Every page should be included in a category. Categories make it easier to see all pages related to a certain topic which both makes the pages easier to find and easier to update if there is a major change.

Writing Guide