Difference between revisions of "Help:Page validation"

From AquaPedia Case Study Database
Jump to: navigation, search
(→‎Warnings and "Flags)
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
AquaPedia uses a software extension for allowing editors to monitor changes that are made to pages, and thus control more carefully the content that is displayed to readers. Editors and reviewers will read newly added pages and page updates, and then indicated that the pages have been reviewed.  If a given [[Help:Case Study | Case Study]] or section has been previously approved, the default view of that page is considered "stable" which means that it has been checked by an editor. These checks include: spot checking references, reading for glaring factual errors, and also reading to make sure that factual content is presented from a neutral point a view (POV), and particularly nuanced POVs appear only in [[Help: Case Summary| case summaries]] and [[Help:Case Analysis and Synthesis |  case analysis/synthesis]].
+
AquaPedia uses a software extension for allowing editors to monitor changes that are made to pages, and thus control more carefully the content that is displayed to readers. Editors and reviewers will read newly added pages and page updates, and then indicated that the pages have been reviewed.  If a given [[Help:Case Study | Case Study]] or [[Help:Background Article | Background Article]] has been previously approved, the default view of that page is considered "stable" which means that it has been checked by an editor. These checks include: spot checking references, reading for glaring factual errors, and also reading to make sure that factual content is presented from a neutral point a view (POV), and particularly nuanced POVs appear only in [[Help: Key Questions| Key Questions]] and [[Help:Case Analysis and Synthesis |  case analysis/synthesis]].
 
   
 
   
−
If you want to view additional versions of a given page (older or newer) that are not considered to be "stable," you may use the "History" tab located at the upper right of the page content area.
+
If you want to view additional versions of a given page (older or newer) that are not considered to be "stable" or "quality" you may use the "History" tab located at the upper right of the page content area.
  
 +
When editors and administrators review a new case study or section, they may approve it even if it is not comprehensive. The most stable version expreses the version of the page that is considered to be the most ''complete to date'' version that has been read by an editor or administrator and could be considered valuable to an AquaPedia reader. Newer unapproved revisions may not have been read, or editors may be unsure if they improve upon the previous versions of a case. Always check a case discussion page to see if there are conversations about the page.
  
−
== Warnings and "Flags ==
 
−
When editors review a new case study or section, they may approve it even if it is not complete.
 
  
−
When this occurs, they will add a "flag" - a box that warns a reader that the material may not be fully complete or accurate
+
<!-- Comment:  This section uses images from the AquaPedia Whitelist Directory. Only website (not AquaPedia accounts) administrators with FTP access can alter the directory. Please don't alter image tags -->
 +
=Revision/Version Review Ratings=
 +
Unchecked — http://aquapedia.waterdiplomacy.org/whitelist/1.png — marks versions of pages that have not yet been reviewed by an AquaPedia Editor
  
−
Some Examples:
+
Stable — http://aquapedia.waterdiplomacy.org/whitelist/2.png — marks versions of pages that have been read and checked by an Editor, but the case or article could be improved. Case Review flags and discussion pages should document revision reviews.
−
<blockquote>
+
  
−
<nowiki> {{detail box}} </nowiki> {{detail box}}
+
Quality — http://aquapedia.waterdiplomacy.org/whitelist/3.png — marks versions of pages that are very detailed, and contain enough information to be considered complete and up to date at the time of review. These cases may be built upon further, but are considered to contain high quality and detail in terms of information, a strong bibliography, multiple points of view, and comprehensive linked resources.
  
 +
==Guidance for Editors and Contributors on Revision Review Ratings==
  
−
<nowiki> {{not accurate}} </nowiki> {{not accurate}}
+
Editors and Administrators can rate revisions when approving them. Each case/article revision has three categories, and there are multiple rating levels within these categories.
−
</blockquote>
+
  
−
Smaller Boxes just for sections:
+
*'''Accuracy''' — How accurately does this case/article represent the facts? are the sources cited being used appropriately? how reputable are the sources?
−
<blockquote>
+
**Full Check Not Performed
 +
**Many Inaccuracies - references not used properly or missing entirely, inappropriate sources used for potentially contentious or disputed information, several factual mistakes are apparent
 +
**Acceptable - references used appropriately, sources appear to be quality sources, may lack citations in some areas or require additional fact checking for minor details.
 +
**Well-sourced - high quality, references are complete, most references are considered to be high quality
 +
**Best Possible - very high quality, on par with a refereed journal or textbook.
  
−
<nowiki> {{Expand section box}} </nowiki> {{Expand section box}}
+
*'''Depth''' — how detailed is the case/article? does it provide an appropriate level of depth for the topics discussed? does it require additional topics to be discussed?
−
<nowiki> {{Empty section box}}  </nowiki> {{empty section box}}
+
**Sparse Detail — case/article is incomplete, case/article contains only some basic information
 +
**Moderate Detail — case/article is not complete, but contains enough information to be a useful resource
 +
**Very Detailed — case/article is either approaching completeness across a broad range of information or contains detailed information on limited aspects
 +
**Best Possible — case/article contains detail on a broad range of required topics, the depth of the case/article present would be sufficient for inclusion in a refereed journal or textbook.
  
−
</blockquote>
+
*'''Readability''' — How is the grammar/style/punctuation in the case/article? Does the case/article need additional copyediting and proofreading? Would the case/article benefit from a skilled user providing formatting help?
 +
**Very Low — poor grammar/style/punctuation that may effect the reading experience and interpretation of information
 +
**Acceptable — case/article may have minor issues in grammar/style/punctuation or spelling that do not significantly impact readability. Sub-sections may or may not be well organized from a reading perspective
 +
**Good — case/article may have minor issues in grammar/style/punctuation or spelling that do not impact readability and the organization of sub-sections allow for easy reading/scanning for information
 +
**Well-Written — case/article does not have issues with grammar, style, punctuation or spelling. Case is well organized and easily read/scanned. Good incorporation of images/figures/tables and additional sidebars.
 +
**Best Possible  — case/article reads like a professionally edited document. Layout/organizations of sub-sections is professional and clear.
  
−
These boxes will appear at the top of the case or section to which they apply. The editor/reviewer may add a post to the article's discussion page to explain to the author and audience why they placed the flag.
 
  
−
==For Reviewers and Editors ==
+
=Case/Article Review Warnings and "Flags" =
  
−
If you read a section or case that is not fully complete, accurate, or has other issues, just insert the appropriate template code "{{ template code }}" at the top of the section in the edit window.  
+
Editors and confirmed users can use the "case review" or "page review" feature within the editing tabs for any case study or article. There are checkboxes that these users can select if they feel that general readers and potential contributors should be informed of room for improvement in a case.
  
−
If you fix the problem, remove the template code before saving your final edits. It is that simple!
+
If the box appears only as a square icon, you can click on each box and have the alert expand to its full size. These alerts will appear at the top of the article or case study that has been reviewed.
 +
 
 +
'''Examples'''
 +
 
 +
<div style="clear:both;">
 +
''Sections need more information/expansion''
 +
<br />
 +
{{Mediawiki:Expand Section}}
 +
</div>
 +
 
 +
<div style="clear:both;">
 +
''Disputed content''
 +
<br />
 +
{{Mediawiki:Disputed}}
 +
</div>
 +
 
 +
<div style="clear:both;">
 +
''Needs to be better connected to AquaPedia resources ("wikified")''<br />
 +
{{MediaWiki:Wikify}}
 +
</div>
 +
 
 +
<div style="clear:both;">
 +
''Lacks References''<br />
 +
{{Mediawiki:Add References}}
 +
</div>
 +
 
 +
<div style="clear:both;">
 +
''Lacking appropriate range of viewpoints''<br/>
 +
{{Mediawiki:MPOV}}
 +
</div>
 +
 
 +
 
 +
=For Editors and Confirmed Users =
 +
 
 +
If you read a section or case that is not fully complete, accurate, or has other issues, please use the case/page review feature to mark these issues. It is very helpful to open a discussion thread on the case/article discussion page to explain the problem, suggest how it might be fixed, and seek feedback or assistance from others on improving the case.
 +
 
 +
If you fix the problem, uncheck the boxes on the case review tab in the case editing tabs and save the case. Re-review the current revision and only update review values if your changes represent truly significant improvements.

Latest revision as of 10:15, 22 August 2012

AquaPedia uses a software extension for allowing editors to monitor changes that are made to pages, and thus control more carefully the content that is displayed to readers. Editors and reviewers will read newly added pages and page updates, and then indicated that the pages have been reviewed. If a given Case Study or Background Article has been previously approved, the default view of that page is considered "stable" which means that it has been checked by an editor. These checks include: spot checking references, reading for glaring factual errors, and also reading to make sure that factual content is presented from a neutral point a view (POV), and particularly nuanced POVs appear only in Key Questions and case analysis/synthesis.

If you want to view additional versions of a given page (older or newer) that are not considered to be "stable" or "quality" you may use the "History" tab located at the upper right of the page content area.

When editors and administrators review a new case study or section, they may approve it even if it is not comprehensive. The most stable version expreses the version of the page that is considered to be the most complete to date version that has been read by an editor or administrator and could be considered valuable to an AquaPedia reader. Newer unapproved revisions may not have been read, or editors may be unsure if they improve upon the previous versions of a case. Always check a case discussion page to see if there are conversations about the page.


Revision/Version Review Ratings

Unchecked — 1.png — marks versions of pages that have not yet been reviewed by an AquaPedia Editor

Stable — 2.png — marks versions of pages that have been read and checked by an Editor, but the case or article could be improved. Case Review flags and discussion pages should document revision reviews.

Quality — 3.png — marks versions of pages that are very detailed, and contain enough information to be considered complete and up to date at the time of review. These cases may be built upon further, but are considered to contain high quality and detail in terms of information, a strong bibliography, multiple points of view, and comprehensive linked resources.

Guidance for Editors and Contributors on Revision Review Ratings

Editors and Administrators can rate revisions when approving them. Each case/article revision has three categories, and there are multiple rating levels within these categories.

  • Accuracy — How accurately does this case/article represent the facts? are the sources cited being used appropriately? how reputable are the sources?
    • Full Check Not Performed
    • Many Inaccuracies - references not used properly or missing entirely, inappropriate sources used for potentially contentious or disputed information, several factual mistakes are apparent
    • Acceptable - references used appropriately, sources appear to be quality sources, may lack citations in some areas or require additional fact checking for minor details.
    • Well-sourced - high quality, references are complete, most references are considered to be high quality
    • Best Possible - very high quality, on par with a refereed journal or textbook.
  • Depth — how detailed is the case/article? does it provide an appropriate level of depth for the topics discussed? does it require additional topics to be discussed?
    • Sparse Detail — case/article is incomplete, case/article contains only some basic information
    • Moderate Detail — case/article is not complete, but contains enough information to be a useful resource
    • Very Detailed — case/article is either approaching completeness across a broad range of information or contains detailed information on limited aspects
    • Best Possible — case/article contains detail on a broad range of required topics, the depth of the case/article present would be sufficient for inclusion in a refereed journal or textbook.
  • Readability — How is the grammar/style/punctuation in the case/article? Does the case/article need additional copyediting and proofreading? Would the case/article benefit from a skilled user providing formatting help?
    • Very Low — poor grammar/style/punctuation that may effect the reading experience and interpretation of information
    • Acceptable — case/article may have minor issues in grammar/style/punctuation or spelling that do not significantly impact readability. Sub-sections may or may not be well organized from a reading perspective
    • Good — case/article may have minor issues in grammar/style/punctuation or spelling that do not impact readability and the organization of sub-sections allow for easy reading/scanning for information
    • Well-Written — case/article does not have issues with grammar, style, punctuation or spelling. Case is well organized and easily read/scanned. Good incorporation of images/figures/tables and additional sidebars.
    • Best Possible — case/article reads like a professionally edited document. Layout/organizations of sub-sections is professional and clear.


Case/Article Review Warnings and "Flags"

Editors and confirmed users can use the "case review" or "page review" feature within the editing tabs for any case study or article. There are checkboxes that these users can select if they feel that general readers and potential contributors should be informed of room for improvement in a case.

If the box appears only as a square icon, you can click on each box and have the alert expand to its full size. These alerts will appear at the top of the article or case study that has been reviewed.

Examples

Sections need more information/expansion

sections need more detail
This page contains 1 or more sections that lack detail and need improvement! Please consider adding to it. Check the discussion page to see comments about the work requested.

Disputed content

article content disputed!
There is a dispute that the content of this page is not accurate. Check the discussion page to see comments about the work requested. Consider improving it.

Needs to be better connected to AquaPedia resources ("wikified")

Wikify this page!
This page required additional internal links to other AquaPedia cases or pages. Consider improving it or other "wikification" tasks Check the disscussion page to see comments about the work requested.

Lacks References

needs references
This page could use the addition of additional references and citations. Consider improving it. Check the discussion page to see comments about the work requested.

Lacking appropriate range of viewpoints

page needs more viewpoints
This case may only have a limited viewpoint represented. Consider improving it by adding additional Analysis/Synthesis/Insights or adding more details to the case. Check the discussion page to see comments about the work requested.


For Editors and Confirmed Users

If you read a section or case that is not fully complete, accurate, or has other issues, please use the case/page review feature to mark these issues. It is very helpful to open a discussion thread on the case/article discussion page to explain the problem, suggest how it might be fixed, and seek feedback or assistance from others on improving the case.

If you fix the problem, uncheck the boxes on the case review tab in the case editing tabs and save the case. Re-review the current revision and only update review values if your changes represent truly significant improvements.

Retrieved from "http://aquapedia.waterdiplomacy.org/wiki/index.php?title=Help:Page_validation&oldid=4052"