View source for Meta:Contributing/Writing

The most important part of our work is this wiki, which exists as a centralised set of guides, explainers, and resources for community managers and moderators to use as supporting material in their work.

This wiki is built upon a copy of [[mediawikiwiki:MediaWiki|MediaWiki]], the same software that powers [https://www.wikipedia.org/ Wikipedia] and many other wikis. It doesn't use Markdown — instead, it includes a visual editor, with the option of switching to [[wikipedia:Help:Wikitext|Wikitext]] if you need it.

The general writing process looks like this:

# Join our Discord server.
# Post a short proposal and gather feedback.
# We review your proposal and create an account for you.
# You create your page here on the wiki, and we review and approve your page when it's ready.

For more information, please read the sections below.

== Workflow ==
This wiki isn't set up for self-service account creation, and you'll need to talk to us before you can edit here. There are a few reasons we approach things this way — primarily, we expect this wiki will be used by inexperienced community staff members as a primary source, so we need to make sure all contributions meet our standards. '''We currently process all contributions via our Discord server, but we may add other channels later.'''

If you'd like to contribute to the wiki, you'll have to follow these steps:

# Join our Discord server and introduce yourself, making sure you have direct messages enabled.
# Write up a short proposal and create a thread for it in <code>#public-contributions</code> (or <code>#article-submissions</code> if you're verified).
# Wait for a staff member to review your proposal, responding to and incorporating any feedback you get (either from staff members or other users).
# Once we're happy with your proposal, a staff member will send you a direct message, and work with you to set up an account on this wiki.
# Once you have an account, you can start working — navigate to the page you want to create, using your browser's address bar, and start writing.
# Any edits you make will be saved as an unapproved draft, which a staff member will need to approve before it becomes the page's default content — more on that later.
# Once you're happy with your work, please let us know. We'll then review it, providing any feedback we feel is necessary. 
#* Among other things, we'll provide feedback on spelling and grammar, adherence to [[Meta:Contributing/Writing#Writing Standards|our writing standards]], phrasing, structure, and formatting.
#* We aim to review submissions within five business days at most — but please note that this wiki is run by volunteers, and waiting times may vary.
# Once you've addressed our feedback, and we're happy with your contribution, we'll approve it, and it will become visible to the public. Congratulations!

== Draft System ==
We use the [[mediawikiwiki:Extension:Approved_Revs|Approved Revs]] extension on this wiki. This extension means that your edits will be saved, but they won't automatically become the page's default content. We use this system because it allows us to review all edits before they're published, but it does make the contribution process slightly more complicated.

If you're working on something and save your work using the "Save page…" button at the top-right of the editor, your edit will be saved as a new, unapproved revision. You can see this by pressing on the "View history" button at the top of the page. Unapproved revisions are visible to the public via this button as well.

If you need to come back to a page you edited previously, and your edits haven't already been approved, then you'll need to select your last revision before you start editing. You can do this by pressing on the "View history" button at the top of the page, and then on the date link for your latest edit. Once your revision has loaded, feel free to use the "Edit" button to get back to editing.

== Editing Pages ==
We use the visual editor that was added to MediaWiki in 2019. You can learn the specifics of how it works [[mediawikiwiki:Help:VisualEditor/User_guide|in the user guide]], but it largely involves editing the page content directly. If you've ever used Microsoft Word or OnlyOffice, this editor should quickly become familiar to you.

=== Sensitive Topics ===
There are many topics you may potentially need to write about that will be sensitive in nature, and we're happy to help you navigate these topics in a thoughtful and appropriate manner.

If you're submitting a page that deals with a sensitive topic, our feedback will include anything we feel may help to push things in a healthier direction, if needed. For example, we may provide guidance on how to rephrase passages of text, and explanations on how to add content warnings, or how to reference offensive slurs appropriately.

=== Writing Standards ===
This wiki should be a comprehensive, readable resource for anyone involved with running a community space, and we feel it's important to set some baseline standards for all contributions.

==== Writing Tools ====
'''Use''' '''[https://languagetool.org/ LanguageTool].'''

We feel it's essential to have articles written with a consistent style and grammar, so we strongly recommend you install and use [https://languagetool.org/services#browsers the LanguageTool browser extension]. We make this recommendation regardless of your level of English — LanguageTool is useful for everyone!

==== Writing Tone ====
'''Use a semiformal tone, and avoid using slang, slurs, or swear words out of context.'''

Your content must be clear and relatively unambiguous, and it must be accessible to people dealing with traumas and oppression. It must also be accessible to people that don't have a native-level understanding of English, and semiformal writing is sometimes easier for translation tools to process.  

You may use slurs and other objectionable terms as examples within relevant contexts, as long as that context is educational rather than for emphasis.  We make an exception to this rule for third-party content linked to by your submissions.

'''Example:''' Instead of "some people be wildin'", consider "some users may behave strangely".

==== Proper English ====
'''Use proper English.'''

We expect that all written content uses proper English spelling and grammar. However, we understand that many potential contributors may not have a strong grasp of English. If you feel that your command of the English language doesn't meet a level you're happy with, we encourage you to use the recommended tools, and to contact us if you're struggling and need help.

'''Example:''' Instead of "ppl b like", consider "some folks like to".

==== Inclusive Language ====
'''Consider diverse readers.'''

We expect that all contributors try their best to use [[wikipedia:Inclusive_language|inclusive language]], writing articles that don't include unnecessary biases, and avoid using bigoted or otherwise discriminatory language outside of examples. This can be a little tricky if you're not used to it, and we'll include guidance on this in our feedback if necessary.

We understand that the world changes rapidly, and many common terms have underlying issues that aren't generally understood, such as terms like "[[wikipedia:Rice_burner|ricing]]". We strive to approach this issue from a corrective, educational perspective, and contributors are expected to be receptive and inquisitive about it, rather than rude or condescending.

'''Examples:'''

* Instead of "humans" or "people", consider "folks" or other similar terms. If you're not familiar with why, please refer to [[wikipedia:Otherkin|this page on Wikipedia]].
* Instead of gendered words like "guys", consider non-gendered terms instead. This includes using non-gendered pronouns ("they") when referring to folks in general, and you should avoid gendered terms anywhere they aren't necessary, unless it's relevant to the section you're writing.

==== Consistent Dialect ====
'''Use a consistent dialect.'''

We will accept submissions written using either American English or British English. However, we believe that consistency is important, and we expect pages to use one or the other, instead of mixing them. Tools like [https://languagetool.org/ LanguageTool] make this considerably easier to manage.

We make an exception to this rule if the difference between dialects is relevant to the content you're submitting.

'''Example:''' Instead of "brightly coloured stores", consider "brightly coloured shops" or "brightly colored stores".

==== Media Transcriptions ====
'''Provide text''' '''alongside (or instead of) media.'''

While multimedia may be a useful tool of engagement for non-disabled people, it may not be accessible to others for various reasons. Because of this, we require that you provide a textual description for any embedded images, and we ask that you provide a transcription of any videos or other types of multimedia you include.  

If audio files make up part of your submission, you should also include a transcription for each file. If you don't have a transcription tool, please refer to our recommended tools below.  Long transcriptions should be given a separate sub-page, categorised with [[:Category:Transcriptions]], and linked in your article.

=== Page Structure ===
To make things easier to navigate, we've decided to use a sub-page structure, where pages are nested using <code>/</code> as a separator. This structure is a little different from how most MediaWiki-based wikis function, but we feel that they make it easier to navigate our wiki, as a reader.

We expect that the vast majority of articles should exist within a broader topic, and we represent those topics with what we call "hub pages". Hub pages provide a broad description of the topic, and contain links to the articles that exist within that topic.

Examples of hub pages include:

* [[Disinformation]]
* [[Plurality]]

Occasionally, a contribution may concern a broad topic, and need to be split into multiple pages. When this happens, this contribution will also need to include a hub page of its own. If your contribution needs a hub page, you should still consider placing it within another hub page if that categorisation makes sense — for example, [[Disinformation/Transgender|Disinformation/Transgender.]]

=== Edit Summary ===
All edits should be accompanied by a brief description, which you can provide in the summary box when you press the "Save changes…" button in the editor. This description should ideally be a single line of text that briefly explains what you changed.

Occasionally, the editor might add a header reference to the summary automatically, which looks like this: <code>/* Header */</code>. When this happens, don't remove it — just write your description after it.

The "This is a minor edit" checkbox is meant for small edits that correct spelling, grammar, and simple formatting issues, without changing what the edited content means. Unless this accurately describes your edit, you shouldn't check this box.

=== Categories ===
Although we structure this wiki using hub pages, we still require that you apply the correct MediaWiki categories to all of your submissions. You can add categories to your pages in the editor, by pressing on the menu button at the top-right of the editor and selecting "Categories".

You can find a list of existing categories on the [[:Category:Categories]] page, but if your contribution would fit better under a category we haven't yet created, you can still apply it to your pages, and we'll work with you to create them.

=== Templates ===
Templates represent re-usable pieces of content that you can include on your pages. They're a relatively advanced concept, but you may find them useful for laying out and formatting your submissions.

We provide several templates you can use on your pages, by pressing the "Insert" button in the editor and selecting "Template". You can find a list of templates on the [[:Category:Templates]] page, and each template is documented. You can read a template's documentation by navigating to its page, as listed in the Templates category.

=== Talk Pages ===
While we currently prefer Discord for all discussions, we have no problem with contributors using talk pages to record their discussions if they wish. If you do use talk pages, please let us know so we can keep an eye on them, and contribute to them as well.

=== Tools ===
We require that you avoid using generative AI tools when contributing to this wiki, and avoid linking to AI-generated content where possible. If you submit AI-generated content, we will deny your submission, and may decide to ban you from the wiki or our community spaces on a case-by-case basis.

We make exceptions for the following AI-based tools, as no reasonable replacements exist, and they significantly improve contributions:

* [https://languagetool.org/ LanguageTool] and [https://www.jetbrains.com/grazie/ JetBrains Grazie], both of which are important spelling and grammar checkers, and help to keep your writing clean and readable. If you need to pick between them, we strongly recommend LanguageTool.
* [https://www.granola.ai/ Granola] and [https://otter.ai/ Otter], but only when used to generate transcriptions from audio. The generated transcription must be checked for accuracy and reformatted to ensure it's clear who said what, and the entire transcription must be copied to a sub-page, categorised with [[:Category:Transcriptions]], and linked in your article. If you need to pick between these tools, we recommend Granola.

If you've already used a banned tool to create a contribution before reading this section, contact us immediately. Likewise, please contact us if you feel there's another tool we should let contributors use that we currently don't.

We have some interest in media poisoning tools, which would make our images and other multimedia useless for AI companies to train on. However, we won't implement or recommend anything that creates undue burdens on our staff team, especially when it comes to reviewing submissions.
[[Category:Meta]]