DocForge:Naming conventions
From DocForge
Naming conventions are a list of guidelines on how to appropriately create and name pages.
It is important to note that these are conventions, not rules carved in stone. As DocForge grows and changes, some conventions that once made sense may become outdated, and there may be cases where a particular convention is inappropriate. No convention must be strictly followed in every case. But when in doubt, follow convention.
DocForge is a wiki for software developers and other technically savvy people. Therefore we have a guiding principle: Names of DocForge articles should be optimized for readers over editors; and for the technically knowledgeable over a general audience.
A redirect should be created for articles that may reasonably be found under two or more names (such as different spellings or former names). Conversely, a term that may be used to describe several different search terms may require a disambiguation page.
Contents |
[edit] General Conventions
[edit] Lowercase Second and Subsequent Words in Titles
Do not capitalize second and subsequent words unless the page title is a proper noun (such as a name) or is otherwise almost always capitalized. The first letter of an internal wikilink need not be capitalized and will direct the reader to the same page.
Category names, however, do have second and subsequent words capitalized. Section titles within pages should also have full capitalization.
[edit] Prefer Singular Nouns
In general create page titles that are in the singular, unless that noun is usually in a plural form in English.
Category names follow different pluralization conventions. Pluralize a category name when it will obviously create a list. For example, Category:Programming Languages.
[edit] Prefer Spelled-Out Phrases to Acronyms
Avoid the use of acronyms in page naming unless the term you are naming is almost exclusively known only by its acronym and is widely known and used in that form. For example, PHP and search engine optimization.
[edit] Add Language or Platform to Title When Applicable
Some large topics or terminology will apply to multiple programming languages or platforms. When creating a page specific to a language or platform, yet the topic or name is applicable to others, add it under the applicable parent page using a forward slash delimiter ("/"). For example, regular expressions are a large topic and apply to multiple languages and platforms. A PHP specific page is titled PHP/Regular expressions. In another example, an article about PHP performance is too large to be included directly in the PHP page, so we have a separate article titled PHP/Performance.
Be sure that each major page is also categorized to the applicable language for easy lookup.
