Quality Assurance Tutorial

Please note that you should be following this tutorial only for page(s) that YOU are responsible for.

  1. Intro
  2. QA Overview
  3. Issues
    1. Broken links (overall)
    2. Documents in formats other than PDF and XML
    3. Documents in need of updating
    4. Images larger than 1MB
    5. Media files in need of updating
    6. Misspellings (overall)
    7. Pages at level... with broken links
    8. Pages that are difficult to read
    9. Pages with documents in formats other than PDF or XML
    10. Pages with images larger than 1MB
    11. Pages with long sentences
    12. Pages with misspellings
  4. Next Steps

I. Intro

Upon your first time using Siteimprove, you will be prompted to enter your UA username and password.  Login using your UA username and password.  Once logged in, the dashboard will appear, showing various statistics such as the Digital Certainty Index and Accessibility scores.  Along the left side of the screen is a menu bar where you can get more details regarding these statistics.  Displayed at the top of the page is your campus and the group(s) of pages you are responsible for. 

For this tutorial, we will only be concerned with the quality assurance score.  Click on the "Quality Assurance" tab on the left menu bar, and then "QA Overview".  Alternatively, you can click the "Improve score" button in the Quality Assurance panel on the dashboard.

Screenshot of Dashboard

II. QA Overview

The Quality Assurance Overview page will be displayed, detailing the progress for the quality assurance score among other things.  Under the panel titled Quality Assurance Overview are two lists titled "Fix These Issues to Improve Your Score" and "Fixed Issues."   

Screenshot of QA Overview

III. Issues

To see the unresolved issues with the pages that you are responsible for, click "See all issues" under the first list.  A new list titled All Quality Assurance Issues will be displayed, showing what issues you can fix to raise your quality assurance score, how many points you can gain from fixing each issue, and the points already gained.  You can click any of these issues to view and fix them.  There are different types of issues that may or may not appear in the list:

IIIa. Broken links (overall)

The Broken Links page will show all broken links that exist on the site.  You can examine one by clicking the magnifying glass button to the left of the listed broken link.  A preview of the page with the broken link on it will appear on the right side of the screen, and a Broken Links menu on the left.  Within this menu, all broken links on the page will appear under "Occurrences on this page."  After clicking any of the occurrences in the list, you can make a decision for each occurrence to ignore the issue on all pages, open the broken link in a new window, or highlight the link in the page content or HTML code.  The HTTP status code is also listed.

Screenshot of Broken Links menu

If a broken link contains "ouedit" OR is an internal link (one that can only be accessed while connected to the UAA network), please ignore these occurrences.  These are false positives and must be fixed by administrators.

IIIb. Documents in formats other than PDF and XML

A list of documents titled "All documents" will be displayed, showing files that aren't PDF or XML files (e.g., Word and Excel files) and the links to them.  To the left of the document name, the document format is displayed, with a button to open the document to the right of the document name.

IIIc. Documents in need of updating

A list of documents titled "All documents" will be displayed, showing documents that were last modified over three years ago.  To the left of the document name, the document format is displayed, with a button to open the document to the right of the document name.

IIId. Images larger than 1MB

A list of images titled "Images" will be displayed, showing images with a filesize over 1MB (one megabyte).  To the right of the image URL is a button to open the image.

IIIe. Media files in need of updating

A list of media titled "All media" displays media files that were last modified over three years ago.  To the right of the media URL is a button to open the media file.

IIIf. Misspellings (overall)

The Find Misspellings page will display all misspelled words on your pages.  The words are broken up into three categories:

  1. Confirmed misspellings
    • These are words that are incorrectly spelled, no matter the context that they may be in.
  2. Words needing review
    • These are words that may be misspelled or correct depending on the context they are in, and require manual approval.
  3. Approved words
    • These are words that have been manually approved and won't be marked as misspelled in the future.

You can filter through the categories by clicking the respective "Misspellings," "Needs Review," or "Approved Words" tabs.  You can quickly approve a word by clicking its thumbs up button in the list.  Conversely, you can click the thumbs down button to mark it as a misspelling.

IIIg. Pages at level...

A list titled "Pages with Broken Links" shows the title and URL of each page and the number of broken links it has.  Click on one of the links in the list to examine the page's broken links.  The same screen shown in section IIIa (Broken Links [Overall]) will appear.

IIIh. Pages that are difficult to read

A list titled "Pages" displays the title and URL of each page that could be difficult to read based on the Flesch Kincaid Grade Level.  The Flesch Kincaid Grade Level is described on the list.  Click on one of the links in the list to examine the readability issues.  A list titled "Issues" will appear in a menu on the left side of the screen, and a preview of the page on the right.  The issues pertaining to readability will be listed under the Readability category.

IIIi. Pages with documents in formats other than PDF or XML

A list of documents titled "All documents" displays documents that are not PDF or XML files, and shows which page they are on along with the size of the file and the number of pages it appears on.

IIIj. Pages with images larger than 1MB

A list of images titled "All media files" displays images that have a file size larger than 1MB (one megabyte), along with the number of pages it appears on.

IIIk. Pages with long sentences

A list titled "Pages" displays the title and URL of each page that has long sentences (sentences with at least 25 words) based on the Flesch Kincaid Grade Level.  The Flesch Kincaid Grade Level is described on the list.  Click on one of the links in the list to examine the readability issues.  A list titled "Issues" will appear in a menu on the left side of the screen, and a preview of the page on the right.  The issues pertaining to readability will be listed under the Readability category.

IIIl. Pages with misspellings

A list titled "Pages with Misspellings or Words to Review" displays pages that have words that need to be reviewed, along with the number of misspellings and words to review each page has.  Click on one of the links in the list to open up the page and fix the misspelling(s) or approve/disapprove word(s).  If it's a misspelled word, you can click "Edit in CMS" near the top of the screen to edit the word in OUCampus.

IV. Next Steps

You can return to the QA Overview page to review other issues and fix them to increase your Quality Assurance score.