Help:Editing

From Frictional Wiki
Revision as of 09:36, 15 July 2020 by Mudbill (talk | contribs) (Wrote some initial guidelines)
Jump to navigation Jump to search

So you would like to contribute to the wiki's content? Awesome! Before you get started, please have a glance at the guidelines below so we can ensure quality content for the reader.

Basic rules

Structure is important to make people feel that the wiki is intuitive to use. Therefore we expect all articles to adhere to a few simple rules:

  • Introduction: The beginning of the page should have a small introduction or summary of the rest of the page, and comes before any additional headings. This enables it to appear above the table of contents.
  • Formatting: Proper formatting allows the wiki to structure itself more predictably. Use "Heading" for new sections and "Sub-headings" for sub-sections that go under it. This allows the table of contents to lay itself out in a way that makes sense.
  • Hyperlinks: Provide links to other pages on different topics, instead of writing existing content in detail several times. This allows us to keep information in one place which makes it easier to update when things change. However, you are free to provide smaller snippets or examples as this may be convenient, but please include a link for further information on the topic regardless. Additionally, when selecting which text the hyperlink appears on, include enough text to describe where the link leads, as if read in isolation. If the destination is on a specific topic, this might only include the name of the topic itself, however if the name of the topic is not obvious or included in your article, you may extend the text to a sentence that encapsulates a description instead.
  • Public domain: This wiki provides information to the public for free and we expect the content to not infringe on others' copyrights. You may still quote such content as long as it falls under fair use.

Formatting

Using appropriate formatting makes text easier to read by emphasising important words, highlighting particular sections or provide the most useful content quickly. MediaWiki provides a nice set of formatting options, so use them when you see fit. This includes simple things such as paragraphs or bold text, but also hyperlinks, code blocks, tables and images. Read more about how you can use formatting on the official MediaWiki website.