Contributing Guidelines

From Night Vision Wiki
Revision as of 13:49, 5 May 2023 by Admin (talk | contribs) (→‎General Guidelines)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This page details guidelines and best practices for contributing to this wiki.

The information below should not be interpreted as a set of rules, as the style of this wiki should be allowed to evolve and adapt to the users and contributors. It is only intended to give contributors the right understanding on how to contribute information in the most efficient and reader-friendly format, reducing the workload on other contributors performing revisions.

General Guidelines[edit | edit source]

Don't let grammar and formatting stop you from contributing. It is more important to collect more information than the visual quality. Other users will gladly fix both grammar and formatting for any contributions.

  • Always try to write gramatically correct sentences without typos
  • Consecutive sentences that would loose some of their meaning without eachother should not be separated by line breaks
  • Information should be objectively correct and verifiable when possible
    • Add references (InsertBasic Reference) whenever possible.
    • Unverifiable or consensus-based information should be added only when necessary and when used, it should be relativized accordingly, e.g. "It is believed that..." or "The consensus among experts is..."

Page Structure[edit | edit source]

Any page should follow a basic structure, so readers can quickly find the information they are looking for.

Any page will automatically generate a table of contents once it contains headings.

If the page contains only minimal, incomplete information, please add the Template:Stub at the top.

Introduction[edit | edit source]

The page should start with a very concise definition on the subject of the page, similar to a dictionary. If possible, a picture of the subject should be placed here as well.

Sections[edit | edit source]

The article should be split into sections to make it easy to find specific information on the subject without reading the entire page.

If a section contains unverified claims, please add the Template:Unverified directly below the heading.

References[edit | edit source]

The final section should be called "References" and only contain the auto generated references list.

  • Visual editor: Insert → References List
  • Source editor: <references/>

Images[edit | edit source]

Images should

  • be sufficiently high-res
  • show the subject in a neutral manner
  • be taken in a well lit environment
  • have a neutral background (use a background remover if and only if necessary)
  • have a short description on the image page

They should be inserted before the affiliated text. This will display them exactly next to the following text on the desktop page, and above the following text on the mobile page.

The caption should be as short as possible, and should not contain any information not specific to the image - such information belongs into the text next to the image.