User:Jcreer/Style Guide: Difference between revisions
| Line 9: | Line 9: | ||
Articles should be long enough to give the reader enough information that multiple questions can be answered without needing to go to another article. Short articles should be avoided as they cause users to have to conduct a longer search to find what they need. | Articles should be long enough to give the reader enough information that multiple questions can be answered without needing to go to another article. Short articles should be avoided as they cause users to have to conduct a longer search to find what they need. | ||
===Stub Articles=== | ===Stub Articles=== | ||
In general, short articles should be marked as stub article and placed in the stub category. A stub article is a short article that could user further development. In general if an article has fewer than 250 words of content, than is is likely that the article does not contain enough information to be useful to a user. | In general, short articles should be marked as stub article and placed in the stub category. A stub article is a short article that could user further development. In general if an article has fewer than 250 words of content, than is is likely that the article does not contain enough information to be useful to a user. An exception to this rule might be if the article has a large detailed graphic or multiple useful graphics. | ||
===When to Merge Articles=== | ===When to Merge Articles=== | ||
Revision as of 22:08, 15 October 2014
Article Guide
Each article has multiple components.
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
Articles should be long enough to give the reader enough information that multiple questions can be answered without needing to go to another article. Short articles should be avoided as they cause users to have to conduct a longer search to find what they need.
Stub Articles
In general, short articles should be marked as stub article and placed in the stub category. A stub article is a short article that could user further development. In general if an article has fewer than 250 words of content, than is is likely that the article does not contain enough information to be useful to a user. An exception to this rule might be if the article has a large detailed graphic or multiple useful graphics.
When to Merge Articles
Short articles that cannot be expanded should be looked at to see if they can be merged with another article.
Article Components
Intro
All articles should begin with a short paragraph that directly explains what the article is about. Neatly summarize what will be discussed in other sections of the article when appropriate. Do not begin an article with a subtitle or other heading.
Sections
Article Table of Contents
The wiki will automatically generate a table of contents for an article that has more than three headings. It is not advisable to hide the table of contents. The table of contents may appear in an unusual place in the article depending on where the first heading starts. The placement of the table of contents can be moved. Large table of contents that have more than seven items can be moved to the right side of the page.
Infoboxes
Most articles do not require an infobox.
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.
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.
