Content Review Guidelines: Difference between revisions

No edit summary
mNo edit summary
Line 19: Line 19:
'''If you independently reviewing a page in Physiopedia:'''  
'''If you independently reviewing a page in Physiopedia:'''  


You can choose any page!  Choose a page that you have seen needs improvement, that is within your specialist area of knowledge or that you would like to learn more about. You can use the search box at the top of the page to search for pages on specific topics or you can [[Articles|browse the articles list.]]  
You can choose any page!  Choose a page that you have seen needs improvement, that is within your specialist area of knowledge or that you would like to learn more about. You can use the search box in the navigation bar to search for pages on specific topics or you can [[Articles|browse the articles list.]]  


'''If you have joined the Content Review Team:'''  
'''If you have joined the Content Team:'''  


Each month Physiopedia runs a Topic of the Month. This is a great way to focus your content reviewing. At the beginning of the month the [http://www.physio-pedia.com/Content_Manager Content Manager] will contact all of the Content Reviewers via our online messaging service, Slack, with a list of pages that need reviewing. This provides a great place to start from in choosing your page, however if you do not see something that takes your fancy or fits you area of expertise, please feel free to work on any other page of your choice.
Each month Physiopedia runs a Topic of the Month. This is a great way to focus your content reviewing. At the beginning of the month the [http://www.physio-pedia.com/Content_Manager Content Manager] will contact the Team via our online messaging service, Slack, with a list of pages that need reviewing. This provides a great place to start from in choosing your page, however if you do not see something that takes your fancy or fits you area of expertise, please feel free to work on any other page of your choice.


== Reviewing the content of a page is done in four parts:  ==
== Reviewing the content of a page is done in four parts:  ==


#'''Content review''' - you will use your physiotherapy knowledge and experience to ensure that the content represents the best in current evidenced based information. You should perform a quick literature search and add in additional evidence, explanations or arguments as you feel appropriate.
#'''Content review''' - you will use your physiotherapy knowledge and experience to ensure that the content represents the most informative and current evidenced based information on the topic.
#'''Literature search''' - you should use your literature searching skills to review the most recent evidence on this topic and update the page as appropriate.   
#'''Literature search''' - you should use your literature searching skills to review the most recent evidence on this topic and add in additional evidence, explanations or arguments as you feel appropriate.   
#'''Page layout and presentation''' - here you will check the formatting and layout of the page, and make improvements as necessary using the wikitext editor. 
#'''Page layout and presentation''' - here you will check the formatting and layout of the page is in line with the [[Quality Standards]], and make improvements as necessary (you may need to edit the source code of the page).
#'''Media and links''' - here you will check that the media in the page is appropriate and does not infringe copyright. You can make the page even better by adding additional media.  You should also make links from the content to other pages within Physiopedia so that all the related pages link together.
#'''Media and links''' - here you will check that the media in the page is appropriate and does not infringe copyright. You can make the page even better by adding additional media (images and video).  You should also make links from the content to other pages within Physiopedia so that all the related pages link together.
 
A step by step review guide is provided below.
As you work through the review you will be make any changes directly in Physiopedia using the wiki editor. Full instructions on using the wiki editor are provided [http://www.physio-pedia.com/Editing_pages here].
 
The is more guidance on each of these three steps below.  


== Submitting your review  ==
== Submitting your review  ==
Line 41: Line 38:


#[https://physiopedia.formstack.com/forms/content_review Submit your page here].  
#[https://physiopedia.formstack.com/forms/content_review Submit your page here].  
#The Physiopedia team will review your reviewed and updated page submission.  
#The Physiopedia team will review your updated page submission.  
#You will be informed within 2 weeks if further improvements need to be made to the page.  
#You will be informed within 2 weeks if further improvements need to be made to the page.  
#Once your review is accepted&nbsp;we will add your name and the date the review was completed to the page.<br>
#Once your review is accepted&nbsp;we will add your name and the date the review was completed to the page.  
#You will be sent a certificate of completion and awarded the appropriate PP+ points and badges (you need to be a Physiopedia Plus member for this step).<br>
#You will be sent a certificate of completion and awarded the appropriate PP+ points and badges (you need to be a Physiopedia Plus member for this step).


== Need help?  ==
== Need help?  ==
Full instructions on editing the source code are provided [http://www.physio-pedia.com/Editing_pages here].


Check out our [[Help:User Tutorials|User Tutorials]]  
Check out our [[Help:User Tutorials|User Tutorials]]  
Line 64: Line 63:
Use your physiotherapy knowledge and experience to ensure that the content represents clinically useful information. &nbsp;As you read the content of the page, answer the following questions:  
Use your physiotherapy knowledge and experience to ensure that the content represents clinically useful information. &nbsp;As you read the content of the page, answer the following questions:  


#Is the content on the page comprehensive and appropriately structured?&nbsp;If not edit the structure using the wiki editor.<br>
#Is the content on the page comprehensive and appropriately structured?&nbsp;If not edit the structure.  
#Are there any topics that are not included on the page that you would like to see?&nbsp;If so add these topics and any references using the wiki editor.  
#Are there any topics that are not included on the page that you would like to see?&nbsp;If so add these topics.  
#Did you find any errors in the content?&nbsp;If so correct these references using the wiki editor.  
#Did you find any errors in the content?&nbsp;If so correct these.  
#Did you feel the content was current? If not, update the content using the wiki editor.  
#Did you feel the content was current? If not, update the content.  
#Are any key and recent pieces of research missing from the page? If yes, add them.&nbsp;<br>
#Are any key and recent pieces of research missing from the page? If yes, add them.&nbsp;<br>


=== Literature search  ===
=== Literature search  ===


Next you should perform a quick search of the literature to ensure that the content represents&nbsp;the best in current evidenced based information. &nbsp;Update and add references using the wiki editor:  
Next you should perform a quick search of the literature to ensure that the content represents&nbsp;the best in current evidenced based information. &nbsp;Update and add references:  


#Perform a quick literature search on the topic to gather all the most recent evidence. &nbsp;Read our page on [[How to Perform a Simple Literature Search|how to perform a quick literature search]] if you need help.  
#Perform a quick literature search on the topic to gather all the most recent evidence. &nbsp;Read our page on [[How to Perform a Simple Literature Search|how to perform a quick literature search]] if you need help.  
Line 83: Line 82:
'''Title'''  
'''Title'''  


Check that the page title is appropriate. &nbsp;If it isn’t email [http://www.physio-pedia.com/User:Rachael_Lowe Rachael Lowe] who will change it.<br>
Check that the page title is appropriate. &nbsp;If it isn’t email [http://www.physio-pedia.com/User:Rachael_Lowe Rachael Lowe] who will change it.  


'''Red Warning Box'''  
'''Red Warning Box'''  


If the page has been part of an educational project there may be a red warning box at the top of the page. &nbsp;This box should be removed if there have not been any edits to that page for the past 3 months (you can see when the last edits were made by clicking on the History tab).  
If the page has been part of an educational project there may be a red warning box at the top of the page. &nbsp;This box should be removed if there have not been any edits to that page for the past 3 months (you can see when the last edits were made by clicking on the History link).  


To remove the box:  
To remove the box:  


*click on the wikitext link in the editing toolbar
*click on Edit Source in the Edit drop down menu.
*find this bit of code below and remove it! The key here is to remove the text between and including the &lt;div&gt; and &lt;/div&gt; tags.
*find this bit of code below and remove it! The key here is to remove the text between and including the &lt;div&gt; and &lt;/div&gt; tags.
<blockquote>'''<nowiki><div class="noeditbox">Welcome to [[Name of project]]. There will be some text here about the project. Please do not edit unless you are involved in this project, but please come back in the near future to check out new information!!</div></nowiki>''' </blockquote>  
<blockquote>'''<nowiki><div class="noeditbox">Welcome to [[Name of project]]. There will be some text here about the project. Please do not edit unless you are involved in this project, but please come back in the near future to check out new information!!</div></nowiki>''' </blockquote>  
'''Credit Original Editors'''  
'''Credit Original Editors'''  


Make sure that the original editors are credited in a box on the top right of the page. &nbsp;The original editor/s is/are the first person/people that contributed significant content to that page (this person can be identified by looking at the page history - click the History tab). They are credited with a link to their profile page in the grey box at the top right of the article.  
Make sure that the original editors are credited on the page. &nbsp;The original editor/s is/are the first person/people that contributed significant content to that page (this person can be identified by looking at the page history - click the History link). They are credited with a link to their profile page in the grey box at the top right of the article.  


The wikitext for this box is:  
The Source Code for this box is:  
<blockquote>'''<nowiki><div class="editorbox">
Original Editor - [[User:Name|Name]]  
<blockquote>'''<nowiki><div class="editorbox">
Original Editor - [[User:Name|Name]]  
Top Contributors - {{Special:Contributors/{{FULLPAGENAME}}}}
</div></nowiki>'''</blockquote>  
Top Contributors - {{Special:Contributors/{{FULLPAGENAME}}}}
</div></nowiki>'''</blockquote>  
Line 107: Line 106:
'''PubMed Feed'''  
'''PubMed Feed'''  


Check that an appropriate PubMed Feed has been added, if it is not there, add it.&nbsp;
If the page has a section subtitled “PubMed Feed” this entire section is now redundant and should be deleted.  
 
If the wikitext in the box on the page says “add feed here!!” you will need to go to pubmed, create an RSS feed for the page topic and replace the words “add feed here” with your new RSS feed. &nbsp;For more instructions see the adding [[Adding PubMed Feed|PubMed feed Tutorial
]]


'''Referencing'''  
'''Referencing'''  


Check that the referencing function is being used correctly.&nbsp;There is a special way to add references in Physiopedia. See [http://www.physio-pedia.com/Adding_References Adding references tutorial]. Once you get the hang of it, it is really very easy (try it out in the Sandbox). However often people just type out references by hand instead of using the referencing function. &nbsp;If this is the case you should replace all the hand typed references with the appropriately used referencing function.<br>
Check that the referencing function is being used correctly.&nbsp;There is a special way to add references in Physiopedia. See [http://www.physio-pedia.com/Adding_References Adding references tutorial]. Once you get the hang of it, it is really very easy. However often people just type out references by hand instead of using the referencing function. &nbsp;If this is the case you should replace all the hand typed references with the appropriately used referencing function.  


'''Categories'''  
'''Categories'''  


All pages should be assigned to appropriate categories.&nbsp;Categories can be found at the bottom of the page. &nbsp;  
All pages should be assigned to appropriate categories which can be viewed at the top of the page. &nbsp;  


To add the page to categories:  
To add the page to categories:  


#click ‘Edit’,  
#click ‘Edit’,  
#then in the editing box you will see this [C], click on this and a pop up box will appear,  
#then in the right of the editing toolbar you will see this three horizontal lines, click on this and a pop up box will appear,  
#double click on the categories from the list that are appropriate for this page (subcategories are found under the blue categories!!)
#click on the categories and add appropriate categories in the pop up box.
#click OK when you are done.
#click Apply Changes when you are done.


If you feel it is appropriate to add a category that is not on the list please do this in the pop up box.<br>
If you feel it is appropriate to add a category that is not on the list please do this in the pop up box.  


'''Copyright'''  
'''Copyright'''  


Check that there are no [[Physiopedia:Copyrights|copyright violations]]. &nbsp;If you suspect that some of the content on the page has been plagiarised copy a section of it and place it into a Google search. &nbsp;If it is copied you will see it come up in your search. &nbsp;If there are major copyright violations please [mailto:[email protected] let us know].<br>
Check that there are no copyright violations. &nbsp;If you suspect that some of the content on the page has been plagiarised, copy a section of it and place it into a Google search. &nbsp;If it is copied you will see it come up in your search. &nbsp;If there are major copyright violations please [mailto:[email protected] let us know].  


'''Formatting'''  
'''Formatting'''  


As you work through the page please go ahead and tidy any formatting issues such as sub­headings, bullet points, numbered lists and spacing may all need tidying up. Use the formatting tools that are displayed in the second line of links in the editing toolbar.<br>
As you work through the page please go ahead and tidy any formatting issues such as sub­headings, bullet points, numbered lists and spacing may all need tidying up. Use the formatting tools that are displayed in the editing toolbar.  
 
=== Adding media and links<br>  ===


A good Physiopedia page has images and video that represent and/or explain the topic. &nbsp;It also has many links to other pages in Physiopedia to connect all the related pages.  
=== Adding media and links  ===
A good Physiopedia page has images and video that represent and/or explain the topic. &nbsp;It also has many links to other pages in Physiopedia to connect all the related pages.


'''Add media to the page'''  
'''Add media to the page'''  

Revision as of 07:28, 15 August 2017

Introduction[edit | edit source]

These guidelines will guide you through the process of reviewing content in Physiopedia.

Before you start:

  1. Read about content review - before you do anything else this week read about the content review process in Physiopedia. 
  2. Familiarise yourself with our quality standards - also make sure that you have read the Quality Standards document so that you are aware of the quality that we expect in all Physiopedia pages.

Choosing a page to review[edit | edit source]

If you independently reviewing a page in Physiopedia:

You can choose any page!  Choose a page that you have seen needs improvement, that is within your specialist area of knowledge or that you would like to learn more about. You can use the search box in the navigation bar to search for pages on specific topics or you can browse the articles list.

If you have joined the Content Team:

Each month Physiopedia runs a Topic of the Month. This is a great way to focus your content reviewing. At the beginning of the month the Content Manager will contact the Team via our online messaging service, Slack, with a list of pages that need reviewing. This provides a great place to start from in choosing your page, however if you do not see something that takes your fancy or fits you area of expertise, please feel free to work on any other page of your choice.

Reviewing the content of a page is done in four parts:[edit | edit source]

  1. Content review - you will use your physiotherapy knowledge and experience to ensure that the content represents the most informative and current evidenced based information on the topic.
  2. Literature search - you should use your literature searching skills to review the most recent evidence on this topic and add in additional evidence, explanations or arguments as you feel appropriate. 
  3. Page layout and presentation - here you will check the formatting and layout of the page is in line with the Quality Standards, and make improvements as necessary (you may need to edit the source code of the page).
  4. Media and links - here you will check that the media in the page is appropriate and does not infringe copyright. You can make the page even better by adding additional media (images and video).  You should also make links from the content to other pages within Physiopedia so that all the related pages link together.

A step by step review guide is provided below.

Submitting your review[edit | edit source]

Once you have completed your review you should submit it to the Physiopedia team so that they can review your work.  This is the process:

  1. Submit your page here.
  2. The Physiopedia team will review your updated page submission.
  3. You will be informed within 2 weeks if further improvements need to be made to the page.
  4. Once your review is accepted we will add your name and the date the review was completed to the page.
  5. You will be sent a certificate of completion and awarded the appropriate PP+ points and badges (you need to be a Physiopedia Plus member for this step).

Need help?[edit | edit source]

Full instructions on editing the source code are provided here.

Check out our User Tutorials

See the wikitext help

Use the mediawiki help (this is the software that Physiopedia uses)

Or contact us directly

Step by step content review[edit | edit source]

When performing your review follow these steps:

Content review[edit | edit source]

Use your physiotherapy knowledge and experience to ensure that the content represents clinically useful information.  As you read the content of the page, answer the following questions:

  1. Is the content on the page comprehensive and appropriately structured? If not edit the structure.
  2. Are there any topics that are not included on the page that you would like to see? If so add these topics.
  3. Did you find any errors in the content? If so correct these.
  4. Did you feel the content was current? If not, update the content.
  5. Are any key and recent pieces of research missing from the page? If yes, add them. 

Literature search[edit | edit source]

Next you should perform a quick search of the literature to ensure that the content represents the best in current evidenced based information.  Update and add references:

  1. Perform a quick literature search on the topic to gather all the most recent evidence.  Read our page on how to perform a quick literature search if you need help.
  2. If you find any recent evidence relating to the topic that you are reviewing that should be added to the page you should add it.  See help page on Referencing.

Page layout and presentation[edit | edit source]

Next you need to ensure that the content on the page is well presented.  Check and improve as appropriate the following things:

Title

Check that the page title is appropriate.  If it isn’t email Rachael Lowe who will change it.

Red Warning Box

If the page has been part of an educational project there may be a red warning box at the top of the page.  This box should be removed if there have not been any edits to that page for the past 3 months (you can see when the last edits were made by clicking on the History link).

To remove the box:

  • click on Edit Source in the Edit drop down menu.
  • find this bit of code below and remove it! The key here is to remove the text between and including the <div> and </div> tags.

<div class="noeditbox">Welcome to [[Name of project]]. There will be some text here about the project. Please do not edit unless you are involved in this project, but please come back in the near future to check out new information!!</div>

Credit Original Editors

Make sure that the original editors are credited on the page.  The original editor/s is/are the first person/people that contributed significant content to that page (this person can be identified by looking at the page history - click the History link). They are credited with a link to their profile page in the grey box at the top right of the article.

The Source Code for this box is:

<div class="editorbox">
Original Editor - [[User:Name|Name]] Top Contributors - {{Special:Contributors/{{FULLPAGENAME}}}}
</div>

Search Strategy

If the page has a section subtitled “Search Strategy” this entire section should be deleted.

PubMed Feed

If the page has a section subtitled “PubMed Feed” this entire section is now redundant and should be deleted.

Referencing

Check that the referencing function is being used correctly. There is a special way to add references in Physiopedia. See Adding references tutorial. Once you get the hang of it, it is really very easy. However often people just type out references by hand instead of using the referencing function.  If this is the case you should replace all the hand typed references with the appropriately used referencing function.

Categories

All pages should be assigned to appropriate categories which can be viewed at the top of the page.  

To add the page to categories:

  1. click ‘Edit’,
  2. then in the right of the editing toolbar you will see this three horizontal lines, click on this and a pop up box will appear,
  3. click on the categories and add appropriate categories in the pop up box.
  4. click Apply Changes when you are done.

If you feel it is appropriate to add a category that is not on the list please do this in the pop up box.

Copyright

Check that there are no copyright violations.  If you suspect that some of the content on the page has been plagiarised, copy a section of it and place it into a Google search.  If it is copied you will see it come up in your search.  If there are major copyright violations please let us know.

Formatting

As you work through the page please go ahead and tidy any formatting issues such as sub­headings, bullet points, numbered lists and spacing may all need tidying up. Use the formatting tools that are displayed in the editing toolbar.

Adding media and links[edit | edit source]

A good Physiopedia page has images and video that represent and/or explain the topic.  It also has many links to other pages in Physiopedia to connect all the related pages.

Add media to the page

All pages should have appropriate media (images and videos) added to enhance the page. Copyright free images can be found at wikimedia commons - see Adding Images tutorial. Videos can be found on YouTube or Vimeo - see Adding Videos tutorial.

Make links in the page

If you see any words or strings of text in the page that obviously link to another page in Physiopedia, please make that link. For example, if you see mention of ‘low back pain’ in the text make a link from those words to the 'Low Back Pain' page in Physiopedia.
See the tutorial on making links.