Policy:Standard documentation format
From Conworld
m (Standard documentation format moved to Policy:Standard documentation format) |
Revision as of 00:09, 2 September 2007
STATUS: INCOMPLETE
//To standardize the documents and ideas that would flow through this wiki. Ketsu 10:34, 18 July 2007 (EDT)
Edits:
- Logs are required, added Section under "Notes Header" and "Departments" Arkyonite 10:34, 18 July 2007 (EDT)
~
Contents |
Titles
Titles should be in lowercase, unless it is a proper name. Titles should not contain the ':' or '/' characters, unless the meaning of these characters is known and the user wants do make use of the respective namespace or subpage features of MediaWiki.
Notes Header
Every document must contain a notes header, where each user adds on a comment when the page is created or edited . Each comment starts with //, and ends with ~~~~. Every user must sign his or her comment with ~~~~, also known as FourTildes. The MediaWiki software will automatically repace the FourTildes with your callsign and the current date and time.
The ending of the notes header is marked by a single ~.
Just before the notes header comes the status header. This shows the current status of the document, and can be changed by anyone editing the document.
List of possible statuses:
- INCOMPLETE
- COMPLETE
- PENDING APPROVAL
- PENDING DISCUSSION
- REQUESTING HELP
- REQUESTING CREATION
Then any edits/additions to the articles under the "Edit:" section. Every edit should be stated clearly, followed by the date of edition. This is optional when previous edits were made by the same author. Please list only, at most, one sentence per edit.
e.g.: * Something under "title" was edited/added ~~~~ ( note the previous part about the FourTildes.)
Discussion Page
Every user shall make use of the discussion page for discussion, and the article may only be edited when an agreement has been come to. This is to prevent "edit-wars" that may ensue.
Each user will start a new topic on the discussion page at the very bottom of it, leaving some space from the previous topic. The topic will start with the following MediaWiki markup:
== Topic Title ==
where the title comes in between a pair of ==s.
Topics with no reply after 30 days will be either automatically archived by KetsuBot, or manually archived by Ketsu.
Departments
Any Log should include a department. Here is the list of departments:
The document shall indicate the department by [[Category:Department Name]]. E.g.: [[Category:Administrative]]
The department marker comes at the very end of the document.
