Documentation Verification

Before You Start

  1. Make sure you log into plone so that any pages currently marked "private" are visible to you. 
  2. Verifiers should review the CASA Docs style guide before beginning verification.
  3. Take a quick tour of plone by clicking the wrench in the upper right corner --> "Tutorials" --> "Introduction". It will show you several messages pointing out the different features of plone. You may need to toggle the "developer mode" on to see more content; best to turn this on, just in case. 

Testing Plan

Editorial Content and Style

Note: Validators should plan to make minor document changes directly to the document. Extensive changes should be reported back to the author using the appropriate JIRA ticket.

Page look and feel

  1. Does the page conform to style guide rules?
  2. Does the organization of the page make sense?
  3. Are figures formatted appropriately?
  4. Are text boxes used in a way that enhances the readability of the document?
  5. Are there obvious changes that would improve the overall look and feel of the document?
  6. For tasks and tools, please ensure that the information is divided appropriately between the "Description" and "Examples" tabs, such that "Examples" contains only explicit examples, and all other information falls under "Description". 

Workflow

  1. Load the Google spreadsheet.
  2. Anything with a "1" in the "Ready for Style Check" column is ready for style verification.
  3. Assign yourself the relevant JIRA ticket (which should be in the state "Ready for Verification") and move it to "Under Verification." 
  4. Check through the relevant pages of plone documentation and make your changes.
  5. Once you're satisfied, move the status of the JIRA ticket to "Ready for Validation" and assign it to Jen Donovan Meyer so that she can assign the content check. 
  6. Put a "1" in the "Ready for Content Check" column in the Google spreadsheet. 
  7. You're done!