Burnout Wiki:Contributor guide: Difference between revisions

Added general section and format documentation section. Moved relevant text to format documentation page.
No edit summary
(Added general section and format documentation section. Moved relevant text to format documentation page.)
Line 1:
Basic guidelines for the creation and editing of articles are listed below.
= Style =
* File extensions for file names from all Burnout games before Paradise should be written in uppercase, as the original casing is inconsistent, both between platforms and between files on the same platform.
** In cases where the file name contains a parameter, such as <code>EXPORT/VALUEDB/VEHICLEPHYSICS/%s.CFG</code>, leave the parameter string - in this case, <code>%s</code> - with its original capitalisation.
 
= General =
* When adding a new build to the [[Prototype_Documentation|prototype documentation]] article, be sure to use the '''ISO 8601''' (yyyy-mm-dd) standard for the build's compilation date.
* All content must be related to Burnout.
* Pages should be as objective, clear, and unbiased as possible.
* Sources should be referenced whenever possible.
** In the instance original research is conducted and the games themselves are the source, the aspect of the game that was used should be mentioned.
 
=== Example content ===
* Numeric data type names should be represented as fixed-width types where appropriate. For example, prefer <code>int64_t</code> over <code>long</code>. Where a <code>long</code> could be 64-bit on one machine, it could be 32-bit on another. Fixed-width types are guaranteed to be of the size in their name.
In regards to objectivity and sources, sentences should be structured following these guidelines. For example, take the following sentence:
{{quote|The Rai-Jin Turbo is the fastest car in Burnout Paradise.}}
 
This may be true, but it is also ambiguous and potentially subjective. A more appropriate sentence for the wiki would be:
* Hexadecimal values should always be quoted in '''big-endian''' byte-order, regardless of their original endianness.
{{quote|At 201 MPH, the Rai-Jin Turbo has the highest top speed attribute of any vehicle in Burnout Paradise.}}
 
Here the user is informed of the source (the vehicle's attributes), the specific field being referenced (MaxSpeed), and the value (201). All of these things help to create a clearer understanding of what is meant by the text and where the information came from.
 
= Format documentation =
See the [[Format documentation guide | format documentation guide]] for details on how to document technical information on assets.
 
= Style =
* File extensions for file names from all Burnout games before Paradise should be written in uppercase, as the original casing is inconsistent, both between platforms and between files on the same platform.
** In cases where the file name contains a parameter, such as <code>EXPORT/VALUEDB/VEHICLEPHYSICS/%s.CFG</code>, leave the parameter string - in this case, <code>%s</code> - with its original capitalisation.
* When adding a new build to the [[Prototype_DocumentationPrototype documentation | prototype documentation]] article, be sure to use the '''ISO 8601''' (yyyyYYYY-mmMM-ddDD) standard for the build's compilation date.
 
== Game Namesnames ==
* The following names should be used for each game:
** Burnout
** Burnout 2
** Burnout 3
** Legends
** Revenge
** Dominator
** Paradise
** Crash
 
= Copyrighted Contentcontent =
* Do '''not''' upload or link '''game ISOs or archives''', even if they have been modified.
 
= Prerelease/development documentation =
* Content along the lines of prerelease footage and screenshots for documenting game content over the game's development should be included separately in a subpage.