Vintage Story Wiki:Guidelines: Difference between revisions

From Vintage Story Wiki
(Created page with "Writing a wiki is hard! But it is easier when more people work together. This page outlines various guidelines to help collaboration. {{Protip |This is only a guideline, it i...")
 
(:))
Line 1: Line 1:
Writing a wiki is hard! But it is easier when more people work together. This page outlines various guidelines to help collaboration.
Writing a wiki is [[Vintage Story Wiki:To-Do|hard]]! But it is easier when more people work together. This page outlines various guidelines to help collaboration.


{{Protip
{{Protip
Line 9: Line 9:


=== General ===
=== General ===
==== Content ====
Content should...
* not be redundant, if you need info on two pages, say, an item's page and it's source, put a link to the other page with a brief detail of the relevant info.
* be grouped on pages generally following the asset's variants, for example, all the plank types should be on one page because they don't really have much individual content.
* fit with American English spellings, 'color' over 'colour', and formattings, 'MM/DD/YY' not 'DD/MM/YY'.
[https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style|Wikipedia's MOS] is useful.
==== Titles ====
==== Titles ====
Titles should...
Titles should...

Revision as of 15:39, 19 November 2019

Writing a wiki is hard! But it is easier when more people work together. This page outlines various guidelines to help collaboration.

Protip:
This is only a guideline, it is a living standard and may be changed as we grow as a community, and it's not strictly required. All rules can be broken and this is no exception.


Content Page Formats

Content pages should follow a general format so we can make sure the right info is on the page. Different topics have different formats, but each format isn't set in stone.

General

Content

Content should...

  • not be redundant, if you need info on two pages, say, an item's page and it's source, put a link to the other page with a brief detail of the relevant info.
  • be grouped on pages generally following the asset's variants, for example, all the plank types should be on one page because they don't really have much individual content.
  • fit with American English spellings, 'color' over 'colour', and formattings, 'MM/DD/YY' not 'DD/MM/YY'.

MOS is useful.

Titles

Titles should...

  • have the first word capitalized and all following words lowercase, for example: 'Stationary basket' not 'Stationary Basket'.
  • reflect the name of the item in the game's assets, for example: 'Ore blasting bomb' not 'Bomb'.

Infobox usage

Try to use infoboxes wherever possible. See Category:Infoboxes for a list of all infoboxes.