Difference between revisions of "ParadiseStation Wiki:Manual of Style"

From Paradise Station Wiki
Jump to navigation Jump to search
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
To coordinate the effort of contributors, a manual of style is required to be discussed and decided upon. All aspects of styling, from table colours, to wording of sections should be consistent.
{{Wip|assign=Sirryan2002}}
{{:ParadiseStation Wiki:Manual of Style/Header}}
To coordinate the effort of contributors, a manual of style is required to be discussed and decided upon. All aspects of styling, from how information is displayed or written to how our wiki is accessible on a macroscale is defined in this set of articles.


== Principles ==
== Principles ==
Line 8: Line 10:
In view of the availability of comprehensive '''Wikipedia''' guides, manuals, and references, all details should be deferred there. As detailing the aspects of writing ''wikicode'' is cumbersome and the quality of Wikipedia's documentation very high, links to Wikipedia's content will be provided at sections and the manual here will present here information that directly affects ''{{SITENAME}}''. In addition,  
In view of the availability of comprehensive '''Wikipedia''' guides, manuals, and references, all details should be deferred there. As detailing the aspects of writing ''wikicode'' is cumbersome and the quality of Wikipedia's documentation very high, links to Wikipedia's content will be provided at sections and the manual here will present here information that directly affects ''{{SITENAME}}''. In addition,  


== General Guidelines ==
==A Good Article==
First of all, our current assortment of [[:Category:Templates|templates]] should be used whenever possible. This allows changes made in the templates to take effect in all articles using it almost immediately. Templates if made, should be made so that it can be used in general
A '''Good Article''' is a level of quality of articles that Wikipedia has set as the standard that all articles should strive to be. It is not always realistic for every page to be a good article but when writing or editing an article, contributors should keep these requirements/checkboxes in mind.


Categorising pages, images, and related items is highly important, as it enables any editor to quickly find and update any relevant articles, create key information portals, and more.
'''A Good Article is:'''
 
# Is well written, on topic, and accurate
== Notes ==
## The Article follows the MOS's Typography and Prose requirements
=== Articles ===
## The information contained is up to date to the latest PR
* Titles (page or section titles, image names, etc.) should be capitalised correctly, e.g. ''"Introduction to Heroism"''.
## Irrelevant, Ambiguous, or needlessly in-depth information is not present or is moved to another article
 
# Broad In its Coverage
=== Files ===
## All mechanics of a feature are explained
* Image names of objects should follow the name presented in the game, and capitalised as same as article titles, e.g. ''"Engineering Radio Headset"''. See the name shown when you right-click it or hover your mouse over it.
## Any relevant information to a role, mechanic, or concept are included
* Images of objects, tiles, and constructions should be exactly ''64x64'' pixels. This is because of:
## The Main aspects of the topic are addressed and well explained
*# Resizing problems. As browsers resizing e.g. ''32x32'' images into larger sizes can make it blurry, and since there is no problem downsizing ''64x64'' images, this is a suitable solution.
# Well Organized
*# Suitably sized images. When displaying an image of an object in-sentence, smaller sized versions are preferred; whereas displaying the image in a framed position, a larger is preferred. In this aspect, using the ''64x64'' size is a compromise, as the images can be sized down without much issue by using wikicode as follows: <code><nowiki>[[File:Engineering Radio Headset.png|size=32x32]]</nowiki></code>
## The Article has a lead section that summarizes the main points of the article in 1-2 paragraphs or less
* Images of objects should not be cropped, for example, screwdrivers. It makes for inconsistently-sized lists of items, and should generally be avoided. Attempt not to crop unless it's more beneficial.
## The Article follows a pyramid structure (BROAD: Most Relevant and Simple Information -> SPECIFIC: Complex/Specific/Nuanced Information)
* Image formats should be either, PNG for still images, and GIF for animated ones. The JPEG format should be avoided due to its lossy nature and its tendency to blur some images.
## The article has proper formatting and header organization assists the reader
* Image extensions should be all in lowercase, and therefore one of the following. Additionally, <code>.jpg</code> should be preferred to <code>.jpeg</code>.
# Illustrated
*: <code>.png</code>
## When necessary, images are used to illustrate referenced objects/locations/roles
*: <code>.gif</code>
## mockup/staged in-game screenshots illustrate explained scenarios
*: <code>.jpg</code>
## Diagrams breakdown/highlight explanations and concepts
 
This checklists is most relevant for ''guide'' and ''role'' pages.
== Tables and Lists ==
Using custom styling should be avoided unless it can clarify the data greatly, e.g. [[Roles]], [[Guide to Xenobiology]].

Latest revision as of 14:34, 25 May 2022

Sloth construction.png
Sloth construction.png
This article or section is a Work in Progress.
Assigned to:Sirryan2002
Please discuss changes with assigned users. If no one is assigned, or if the user is inactive, feel free to edit.
Return to Wiki Contributor Portal Parawiki Manual of Style (MOS) Return to MOS Main Page
Typography Prose Content Layout Templates Files Accessibility

To coordinate the effort of contributors, a manual of style is required to be discussed and decided upon. All aspects of styling, from how information is displayed or written to how our wiki is accessible on a macroscale is defined in this set of articles.

Principles

  1. Clarity. Information should be clear to readers, and presented in the best possible manner.
  2. Consistency. Styling, formatting, etc. should be consistent from article-to-article.
  3. Accuracy and detail. Text and images should be as accurate as possible describing the game, preferring original information and seriousness.

In view of the availability of comprehensive Wikipedia guides, manuals, and references, all details should be deferred there. As detailing the aspects of writing wikicode is cumbersome and the quality of Wikipedia's documentation very high, links to Wikipedia's content will be provided at sections and the manual here will present here information that directly affects Paradise Station Wiki. In addition,

A Good Article

A Good Article is a level of quality of articles that Wikipedia has set as the standard that all articles should strive to be. It is not always realistic for every page to be a good article but when writing or editing an article, contributors should keep these requirements/checkboxes in mind.

A Good Article is:

  1. Is well written, on topic, and accurate
    1. The Article follows the MOS's Typography and Prose requirements
    2. The information contained is up to date to the latest PR
    3. Irrelevant, Ambiguous, or needlessly in-depth information is not present or is moved to another article
  2. Broad In its Coverage
    1. All mechanics of a feature are explained
    2. Any relevant information to a role, mechanic, or concept are included
    3. The Main aspects of the topic are addressed and well explained
  3. Well Organized
    1. The Article has a lead section that summarizes the main points of the article in 1-2 paragraphs or less
    2. The Article follows a pyramid structure (BROAD: Most Relevant and Simple Information -> SPECIFIC: Complex/Specific/Nuanced Information)
    3. The article has proper formatting and header organization assists the reader
  4. Illustrated
    1. When necessary, images are used to illustrate referenced objects/locations/roles
    2. mockup/staged in-game screenshots illustrate explained scenarios
    3. Diagrams breakdown/highlight explanations and concepts

This checklists is most relevant for guide and role pages.

Retrieved from "https://paradisestation.org/wiki/index.php?title=ParadiseStation_Wiki:Manual_of_Style&oldid=37893"