Difference between revisions of "WikiAnesthesia:Author guide"

From WikiAnesthesia
Tag: 2017 source edit
Tag: 2017 source edit
Line 22: Line 22:


=== Creating a new article ===
=== Creating a new article ===
<div class="thumb tright"><div class="thumbinner" style="width:400px;">[https://wikianesthesia.s3.amazonaws.com/WikiAnesthesia_Create_Article_From_Redlink.gif https://wikianesthesia.s3.amazonaws.com/WikiAnesthesia_Create_Article_From_Redlink.gif]<div class="thumbcaption">Creating a new article from a '''<span style="color:#9B1B2F">red</span>''' link</div></div></div>
<div class="thumb tright"><div class="thumbinner" style="width:400px;">[https://wikianesthesia.s3.amazonaws.com/WikiAnesthesia_Create_Article_From_Search.gif https://wikianesthesia.s3.amazonaws.com/WikiAnesthesia_Create_Article_From_Search.gif]<div class="thumbcaption">Creating a new article using search</div></div></div>
New articles can be created in two ways:
New articles can be created in two ways:
* Click any '''<span style="color:#9B1B2F">red</span>''' link to start the creation of a new article with the link's title. We '''highly''' recommend you create articles by following links from either:
* Click any '''<span style="color:#9B1B2F">red</span>''' link to start the creation of a new article with the link's title. We '''highly''' recommend you create articles by following links from either:
Line 31: Line 33:
*#* Capitalize only the first word and proper nouns
*#* Capitalize only the first word and proper nouns
*# On the search results page, a link to start the creation of the article will be shown in the text "Create the page "[...]" on this wiki!"
*# On the search results page, a link to start the creation of the article will be shown in the text "Create the page "[...]" on this wiki!"
<div class="thumb tright"><div class="thumbinner" style="width:400px;">[https://wikianesthesia.s3.amazonaws.com/WikiAnesthesia_Create_Article_From_Redlink.gif https://wikianesthesia.s3.amazonaws.com/WikiAnesthesia_Create_Article_From_Redlink.gif]<div class="thumbcaption">Creating a new article from a '''<span style="color:#9B1B2F">red</span>''' link</div></div></div>
<div class="thumb tright"><div class="thumbinner" style="width:400px;">[https://wikianesthesia.s3.amazonaws.com/WikiAnesthesia_Create_Article_From_Search.gif https://wikianesthesia.s3.amazonaws.com/WikiAnesthesia_Create_Article_From_Search.gif]<div class="thumbcaption">Creating a new article using search</div></div></div>


==== Using page templates ====
==== Using page templates ====

Revision as of 09:22, 21 February 2021

WikiAnesthesia is an open platform in which anyone is welcome to contribute. Our philosophy is that knowledge should be freely accessible and that sharing information is most successful when barriers to contribution are reduced. Similar to Wikipedia and other medical wikis, WikiAnesthesia is based on the idea that a dedicated community will self-regulate to produce high-quality, accurate, and useful content.

Getting started

Create an account

To give credit for contributions and help prevent spam, an account must be created in order to contribute to WikiAnesthesia.

  1. Create an account. We ask for users' real name and credentials to attribute credit appropriately and facilitate growth of the WikiAnesthesia community.
  2. Confirm your email address (required before creating content). If you do not receive a confirmation email, check your spam folder. You can also resend the email from the email options section of your preferences.

New users can create and edit most articles on the site immediately. To combat spam, any changes made by new users will be visible to that user, but not immediately reflected to the public until they are reviewed by an editor. Once a new user has made several successful edits, their account will be promoted to the contributor level which will bypass editor review of future contributions.

Contributing content

General guidelines

Our goal is for WikiAnesthesia to be readily useful in the clinical environment. We suggest that articles:

  • Strive to be comprehensive but concise
  • Reflect current evidence-based best practices
  • Include appropriate reference citations
  • Place the most high-yield content in the article's infobox
  • Use bulleted lists and tables whenever feasible

Creating a new article

WikiAnesthesia_Create_Article_From_Redlink.gif
Creating a new article from a red link
WikiAnesthesia_Create_Article_From_Search.gif
Creating a new article using search

New articles can be created in two ways:

  • Click any red link to start the creation of a new article with the link's title. We highly recommend you create articles by following links from either:
    • The homepage, which lists articles which have been prioritized for development
    • The table of contents, which lists many more articles planned for future development
  • If an appropriate listing is not available in the table of contents, an article with any title can be created:
    1. Input the exact title for the article you wish to create into WikiAnesthesia's search bar and hit enter. Article titles should:
      • Use the most commonly-recognized formal name for the topic (i.e. how the name would be used in a journal article)
      • Capitalize only the first word and proper nouns
    2. On the search results page, a link to start the creation of the article will be shown in the text "Create the page "[...]" on this wiki!"

Using page templates

New articles should use a predefined page template whenever possible. Page templates can be accessed from the page templates menu (Page templates menu icon) of the editor. When using a page template:

  • Fill out the applicable standardized fields of the infobox
    • The infobox should contain the article's highest-yield content in the most concise form possible
  • The predefined structure should serve a basis for the article, but can be freely modified as warranted by the content

Editing an existing article

Citing references

Organizing content

Adding categories to articles

Adding redirects (aliases) to articles

Getting credit for contribution

Contributions to WikiAnesthesia are automatically associated with user accounts in several ways.

Contribution scores

Every user has a user profile which shows the number of pages edited, the total number of edits, and an overall contribution score which is defined as:

(number of unique pages edited) + 2 * square root ((number of edits) - (number of unique pages edited))

Article contributors

The top contributors are listed at the bottom of each article.

Editorial levels

WikiAnesthesia has several user levels which are reflected on users' profile pages and determine access to editorial and site administration tools.

  • User: The default user group assigned to new accounts. Users can create and edit most articles, but changes will not appear publicly until reviewed by an Editor.
  • Contributor: Contributors can create and edit articles without editor review (changes appear publicly immediately). Users are promoted to Contributor by Editors after one or more substantive contributions have been made.
  • Editor: Editors can approve or reject pending contributions from Users, promote users to Contributors, and edit most protected pages. Users are promoted to editor at the discretion of the editorial board.
  • Administrator: Administrators can edit all protected pages and modify site-wide configuration.

How to create and edit an article

  1. You must first create an account
    1. Once your account has been registered and email confirmed, you can begin creating/editing articles.
    2. Initial edits are considered provisional (and not publicly visible) until your account is approved by an editor
  2. Find an article to create or edit. You can find an article by:
    1. Searching for an article
      1. If an article does not already exist, you will have the option to create the article you searched for.
        1. Click the link for "Create the page on this wiki!" in order to create the new article for your search term.
    2. Referring to the Table of contents
    3. Selecting an article featured on the homepage
      1. The homepage has a list of articles that have been prioritized for development.

[Note: Need to include guidelines around what type of articles to create, including specificity of articles, etc.]

Style guidelines

  • Use lists, bullets, and tables whenever feasible
  • Organize content in a manner that is mobile-friendly

General guidelines

  • Keep articles as brief as possible, while still be informative
    • Our goal is to have articles easily digestible in a couple minutes.
    • Use the article's inbox to highlight the most high-yield content within an article
  • Focus on practical knowledge that is readily useful in the clinical environment
  • References you sources
    • This is especially important when adding information that is not universally agreed upon by medical professionals.