Contribution Guide: Difference between revisions

From The Brainfog Wiki
(Added a brief guide and additional contribution philosophy)
m (→‎Requirements: Edited text about account creation to reflect invite only nature and added contact us link)
Line 9: Line 9:
=== Requirements ===
=== Requirements ===


To make changes to this wiki, you will also need to register for an account, this is something we require and it is to help protect the wiki.
To make changes to this wiki, you will need an account, this is something we require and it is to help protect the wiki. You can request an account by reaching out to the site administrators in [[Contact Us]].


Once you meet our requirements and understand what to do, take a look below to learn how to fit right in with our existing content which is specially crafted to be easy to read and reference.
Once you meet our requirements and understand what to do, take a look below to learn how to fit right in with our existing content which is specially crafted to be easy to read and reference.

Revision as of 16:12, 4 April 2024

Getting Started

So, you want to contribute? This is excellent news!

It might seem a bit intimidating at first but mediawiki (the software this wiki uses to function) will quickly become your bestfriend.

Creating and editing

The primary way of making edits and creating pages is simply just to search them in the search bar! If, for example, you want to make a page on Depression, type 'Depression' in the searchbar. If you get no results, you will get the opportunity to create the page there and then, and when someone else searches 'Depression' that page will come up! If the page already exists, and we have not protected the page (We may do this for various reasons), there will be a nifty edit button on the page for you to put your own contribution in.

Requirements

To make changes to this wiki, you will need an account, this is something we require and it is to help protect the wiki. You can request an account by reaching out to the site administrators in Contact Us.

Once you meet our requirements and understand what to do, take a look below to learn how to fit right in with our existing content which is specially crafted to be easy to read and reference.

Contribution Philosophy

This section is designed to help you understand how to best serve the users of this information database by understanding and implementing the philosophy this wiki functions best by. These aren't rules, but following them helps to create a consistent and easy viewing experience and reduces the amount of edits that need to be made to polish contributions.

Clean and concise

As much information should be provided as possible, in as little as possible. The target audience for this wiki is brainfogged individuals and it will be discouraging to read walls of text, even if it is helpful. Writing as much as possible in as little as possible without unreasonably compromising on information regarding the subject should be the goal.

As it relates to brainfog

Many of the pages here can be steered off topic if the focus of this wiki is not kept in mind. Whilst you might be able to include additional facts compared to what is already avaliable, it could be that it was never included because the facts were not useful knowledge when in light of the reason it is mentioned at all on a brainfog wiki.

Formatting

It stands to reason that it would be a good idea to make your contribution human readable given the target audience, and although it sounds like it could be complicated and daunting, it is rather simple! Take a look here at our personal favourite cheatsheet.

Ontop of using markup, giving appropriate pacing to sections is also important. Text is much easier to read and reference when it is broken up into headings.

Complex Grammar

Avoiding the use of language that requires a high understanding of the language it is written in is helpful both to translation and comprehension of what has been wrote, especially for brainfogged individuals. Without compromising on the message, you should aim to use lower level language (not slang) to aid in peoples understanding.