Help talk:Wiki guidelines

From AssaultCube

Jump to: navigation, search

Documentation redundancy

First of all, the wiki is an good idea. On the other hand, there are currently 2 many different places 2 become information about the game (forum, documentation, website, ingame help, reference and now the wiki).

This wiki make only sense, if it uses as an instrument to reduce this places in a sinfull manner. So that is the point, why i started with "console commands" - cause the wiki structure can be used better then the other places to provide more detailed infos.

So, for that its useless to link to the (reduced) reference. It's better to migrate the reference into the wiki.

Apollo 10:10, 8 July 2007 (GMT)

See http://assault.cubers.net/forum/comments.php?DiscussionID=284 The wiki is of course a good tool to organize the teamwork, however you can not easily extract the 'pure' data out of it to use it in an offline reference site or in the ingame help. Accessing the data requires a defined storage of text, which isn't provided by a wiki, therefore the reference will remain in the xml files. Instead of documenting single commands in the wiki, it's better to write articles that give an __overview__ of the available tools and to show how they work together. Focus on guides not on reference material, see the guidelines article.

~driAn 13:30, 3 November 2007 (GMT)

Ok, the first point is clear. The second point is - simply said - nonsense. First of all, I dont know why we need an offline reference. If we are online for playing and reading or writing the forum or wiki, then we can also look into the online reference. With this aspect it make no sense not to merge the command reference into wiki.

With the now existing Media Upload we have the chance to create a more detailed (and for neebies more handsome) reference AND to create guides for special aspects and problems around AC them. Apollo 00:04, 14 November 2007 (UTC)

Ok, let me explain why we need an offline reference:

  • For the ingame doc system as explained previously.
  • To document the game _across_ different versions, not only the current state. The AC package is standalone and must endure time and therefore requires a proper documentation of the respective released version, it must available at any later time bundled in the package. Not only players need a quick lookup of the commands, also consider people building stuff ontop of AC. How could we have created AC if cube was documented in a wiki only? We would now have nothing but documentation about the current Cube version (Sauer aka Cube 2) that isn't very helpful for previous versions (Cube 1).

Why it makes no sense to merge the command reference into the wiki:

  • Redundancy is bad, that's a fact. If I change the behavior of commands how can I be sure it will properly be reflected in the wiki? How can we control that all reference sources describe the same behavior (in all languages in the wiki).
  • References are not for noobs. References are for people knowing some basics. On the other hand, noobs need guides e.g. articles that describe solutions as task-focused description not as command-focused description. Noobs don't need a list of available commands (sendmap, getmap), they need guides (How to send and download maps).

There is no problem describing the most important commands, but trying to merge the reference into the wiki will end up in a mess for sure. ~driAn 21:22, 17 November 2007 (GMT)

We need an media upload

Please activate the "upload page". Sometimes its better to add some media to illustrate an article. Currently there is no chance to implement a simple screenshot. Apollo 14:53, 6 October 2007 (GMT)

Thx. Apollo 00:04, 14 November 2007 (UTC)

"not "Multiplayer Guide" but "Multiplayer guide", since "guide" is just a normal word"

Shouldn't this page be named "Wiki guidelines"? --Nicholas 16:55, 17 November 2007 (UTC)

Personal tools