Policy:Standard documentation format
From Conworld
(Redirected from Standard documentation format)
- 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)
- Changed things to make it more convenient and clear. Ketsu Drop a MsgAlex 07:19, 26 September 2008 (PDT)
Contents |
Titles
- Lower-case titles only.
- Titles must not contain a ':' unless otherwise stated.
Notes Header
- A comment should be added for every edit/addition to an article.
- Comments are under the "Edit:" section at the top of every article.
- Each comment ends with ~~~~ (FourTildes to automatically insert callsign, date and time).
e.g.:
* Something under "title" was edited/added ~~~~
Discussion Page
- The discussion page is for discussion of the article in question.
- New topics are started with the new section header, at the bottom of the page:
== Topic Title ==
- Topics with no reply after 30 days will be either automatically archived by KetsuBot, or manually archived by Ketsu.
- If there is a discussion on the forums about an article, link to the forum topic at the top of the article.
Departments
Any article should include a department. Here is the list of departments:
The document shall indicate the department by [[Category:Department Name]]. E.g.: [[Category:Administrative]]
A document may be in more than one department or sub-department.
The department markers come at the very end of the document.