Policy:Standard documentation format

From Conworld

(Difference between revisions)
(Updating for current system.)
 
(10 intermediate revisions not shown)
Line 1: Line 1:
-
STATUS: INCOMPLETE
+
* To standardize the documents and ideas that would flow through this wiki. [[User:Ketsu|Ketsu]] 10:34, 18 July 2007 (EDT)
-
 
+
-
Log 180707_W1
+
-
 
+
-
//To standardize the documents and ideas that would flow through this wiki. <nowiki>[</nowiki>[[User:Ketsu|Ketsu]]<nowiki>]</nowiki>
+
-
 
+
Edits:
Edits:
-
 
+
* Logs are required, added Section under "Notes Header" and "Departments" [[User:Arkyonite|Arkyonite]] 10:34, 18 July 2007 (EDT)
-
logs are required. [[User:Arkyonite|Arkyonite]] 10:34, 18 July 2007 (EDT)
+
* Changed things to make it more convenient and clear. [[User:Ketsu|Ketsu]] <sup><font size=-2>[[User_talk:Ketsu|Drop a Msg]]</font></sup><sub>Alex</sub> 07:19, 26 September 2008 (PDT)
-
 
+
-
Section under "Notes Header" added. [[User:Arkyonite|Arkyonite]] 10:34, 18 July 2007 (EDT)
+
-
 
+
-
"Departments" added. [[User:Arkyonite|Arkyonite]] 10:34, 18 July 2007 (EDT)
+
-
 
+
-
~
+
==Titles==
==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.
+
* Lower-case titles only.
-
 
+
* Titles must not contain a ':' unless otherwise stated.
==Notes Header==
==Notes Header==
-
Every document must contain a notes header, where each user adds on a comment when the page is created or edited (optional when previous edits were made by the same author). Each comment starts with //, and ends with <nowiki>~~~~</nowiki>. Every user must sign his or her comment with <nowiki>~~~~</nowiki>, also known as [[FourTildes]]. The MediaWiki software will automatically repace the [[FourTildes]] with your [[callsign]] and the current date and time.
+
* 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 <nowiki>~~~~</nowiki> ([[FourTildes]] to automatically insert [[callsign]], date and time).
-
The ending of the notes header is marked by a single ~.
+
e.g.:
-
 
+
<pre>* Something under "title" was edited/added ~~~~</pre>
-
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
+
-
 
+
-
Right after the status header comes the Log.
+
-
The log is stated like so:
+
-
Log <nowiki>[DATE]_[DEPARTMENT]</nowiki>
+
-
 
+
-
<nowiki>(refer to ==departments==)</nowiki>
+
-
 
+
-
Then any edits/additions to the articles under the "edit:" section. Every edit should be stated clearly, followed by the date of edition.
+
-
 
+
-
eg. <nowiki>"something under "title" was edited/added ~~~~"</nowiki>
+
-
( note the previous part about the fourTildes.)
+
==Discussion Page==
==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.
+
* 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:
-
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:  
+
<pre>== Topic Title ==</pre>
<pre>== Topic Title ==</pre>
-
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 [[User:Ketsu|Ketsu]].
-
 
+
* If there is a discussion on the forums about an article, link to the forum topic at the top of the article.
-
Topics with no reply after 30 days will be either automatically archived by [[KetsuBot]], or manually archived by [[User:Ketsu|Ketsu]].
+
==Departments==
==Departments==
-
Any Log should include a department. Here is the list of departments:
+
Any article should include a department. Here is the list of departments:
-
 
+
* [[:Category:Administrative|Administrative]]
-
W1 = Administrative
+
* [[:Category:Plot Development|Plot Development]]
 +
* [[:Category:Design|Design]]
 +
* [[:Category:Logistics|Logistics]]
 +
* [[:Category:Programming|Programming]]
-
W2 = Development of Plot
+
The document shall indicate the department by <nowiki>[[Category:Department Name]]</nowiki>. E.g.: <nowiki>[[Category:Administrative]]</nowiki>
-
W3 = Design
+
A document may be in more than one department or sub-department.
-
W4 = Logistics
+
The department markers come at the very end of the document.
-
W5 = Programming
+
[[Category:Administrative]]

Current revision as of 14:19, 26 September 2008

  • 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.

Retrieved from "http://editthis.info/conworld/Policy:Standard_documentation_format"
Personal tools
ConPlanets