Styleguide: Difference between revisions

8 bytes removed ,  13:05, 24 August 2022
m
no edit summary
(→‎Article Quality: New instructions on lore)
mNo edit summary
 
Line 5: Line 5:
Every time you save your edit a commit is made. This commit will be reviewed by administrators. To make their lives easier try not to split your changes into dozens of separate commits but do them all in one go. Another thing that really helps is adding a summary (aka 'Comment') and make proper use of the ''minor edit'' option. Both will tell the administrator what to look for when checking the edit. Stating your intention as well, can prevent misunderstandings like: <code>Rephrased foreword for increased readability.</code>
Every time you save your edit a commit is made. This commit will be reviewed by administrators. To make their lives easier try not to split your changes into dozens of separate commits but do them all in one go. Another thing that really helps is adding a summary (aka 'Comment') and make proper use of the ''minor edit'' option. Both will tell the administrator what to look for when checking the edit. Stating your intention as well, can prevent misunderstandings like: <code>Rephrased foreword for increased readability.</code>
=== New Pages ===
=== New Pages ===
Avoid duplicates by thoroughly searching in the wiki and asking if need be. Try to following the existing naming schemes including capitalization. Here is an example, if you were to write a guide of how to walk properly:
Avoid duplicates by thoroughly searching in the wiki and asking if need be. Try to follow the existing naming schemes including capitalization. Here is an example, if you were to write a guide of how to walk properly:
* '''Bad:''' Walk
* '''Bad:''' Walk
* '''A bit closer:''' How to Walk
* '''A bit closer:''' How to Walk
Line 21: Line 21:
{| class="wikitable"
{| class="wikitable"
!Correct Language
!Correct Language
|Check grammar / punctuation / typos. Basically make sure it feels like authentic english
|Check grammar/punctuation/typos. Basically make sure it feels like authentic English.
|-
|-
!Consistent Capitalisation
!Consistent Capitalization
|For recipes and lists of ingredients capitalize the first letter if it's a multiword statement (Lime juice), but if it's a proper name (Beepsky Smash / Quadruple Sec), capitalize both. For mixed ingredients only capitalize the actual item ("coil of Wire").
|For recipes and lists of ingredients capitalize the first letter if it's a multiword statement (Lime juice), but if it's a proper name (Beepsky Smash/Quadruple Sec), capitalize both. For mixed ingredients only capitalize the actual item ("coil of Wire").
|-
|-
!Consistent language
!Consistent Language
|Some articles are packed with humour, while others are rather technical. Both is perfectly fine. Try to stay compatible when editing articles.
|Some articles are packed with humor, while others are rather technical. Both are perfectly fine. Try to stay compatible when editing articles.
|-
|-
!Ressources
!Resources
|Check for broken / outdated images and links. Make sure the style of used icons is consistent.
|Check for broken/outdated images and links. Make sure the style of used icons is consistent.
|-
|-
!Correctness
!Correctness
|Making sure that anything stated is true and isn't outdated. Best checked by experienced players and reading the game-code.
|Making sure that anything stated is true and isn't outdated. Best checked by experienced players and reading the game-code.
|-
|-
!Scope / Completeness
!Scope/Completeness
|Anything described should either be complete, or it should be obvious that it isn't meant to be complete. The best example for the latter are things that are meant to be explored by the players. Best checked by experienced players, developers and reading the code. Remember, that guides are not meant to convert the reader into a ultrarobust powergaming machine by spoonfeeding optimized strategies.
|Anything described should either be complete, or it should be obvious that it isn't meant to be complete. The best example for the latter are things that are meant to be explored by the players. Best checked by experienced players, developers and reading the code. Remember, that guides are not meant to convert the reader into an ultrarobust powergaming machine by spoonfeeding optimized strategies.
|-
|-
!Lore
!Lore
Line 42: Line 42:
|-
|-
!Design
!Design
|Even the best article will feel boring without the proper use of icons and formatting. Proper Highlighting, templates and standard structures are to be used to increase readability without being excessive
|Even the best article will feel boring without the proper use of icons and formatting. Proper highlighting, templates and standard structures are to be used to increase readability without being excessive.
|-
|-
!Learning-Context
!Learning-Context
Line 48: Line 48:
|}
|}
Having someone proofread an article for a second opinion never hurt anyone.
Having someone proofread an article for a second opinion never hurt anyone.


== Images ==
== Images ==
Line 71: Line 70:
|}
|}
== Collaboration ==
== Collaboration ==
=== Private pages / sandboxes ===
=== Private pages/sandboxes ===
It is considered rude to change anything on another users private page without prior explicit permission. If you like someones draft you can copy and edit it in your sandbox.
It is considered rude to change anything on another user’s private page without prior explicit permission. If you like someone’s draft you can copy and edit it in your sandbox.


To use your sandbox use [[Special:MyPage/Sandbox]] to be redirected to your own sandbox. You can create as many private sandboxes as you want. Just create an article in the appropriate namespace like:
To use your sandbox use [[Special:MyPage/Sandbox]] to be redirected to your own sandbox. You can create as many private sandboxes as you want. Just create an article in the appropriate namespace like:
Wiki Staff
6,186

edits