Smartsite Documentation Testing
- Lisa Wilson
SmartSite Documentation Testing
The Smartsite Program Manager is looking for consistent presentation for Smartsite support documentation including information sites, downloadable files, and training and marketing materials.
The QA Group is asked to review these materials and verify the content is clear, concise, and is easily identifiable as associated with Smartsite. Some general test standards for validating material is listed below. Use these standards as guidelines in addition to any specific requests when providing QA service for information materials.
Documentation Test Requests
Requests for the QA group to review Smartsite documentation are listed here:
Jira |
Description |
Test Plan |
Released to QA |
QA Results/Date |
|---|---|---|---|---|
Test the content and links for a main link on the SmartSite-Test project site on the Smartsite production server: FAQs |
Follow the checkpoints in the test standard described below and check for document links to pages as specified in the jira. Report results to SAK-896 |
8/13/07 |
Pass with comments 8/15/07 RE SmartSite Web Updates.txt |
|
Test the content and links for two main links on the SmartSite-Test project site on the Smartsite production server: Get Started by Creating a Site and Set up a Class or Project Site |
Follow the checkpoints in the test standard described below. Report results to SAK-871 |
7/27/07 |
Fail 1st pass: 7/30/07 Pass with comments 8/15/07 RE SmartSite Web Updates.txt |
Information Site Test Standards
When verifying that a project or website within or outside of Smartsite measures up to standards, use the following checkpoints:
- Review all text content on the current page for clarity, grammar, and spelling. Does the content read easily if read out loud? Are there any obvious typos or grammatical errors? Check against other references if you're not sure.
- Validate that page links meet the following standards:
- Page links are displayed in descriptive text and the page the user is sent to is consistent with that text; for example, the new page title contains some or all of the text in the descriptive link and the user is not surprised by the content of the page.
- Verify links in the page footer (if their is one) as well as within the page.
- In general, page links, including css and other smartsite pages, are relative links, for example 'get_involved.html' or 'CreatingSites/set_up_a_site.html' EXCEPT when referring to an outside link, such as 'http://iet.ucdavis.edu'. View the page source from within the frame to verify.
- Verify email links within the page or page footer are accurate. Questions should link to smartsite-help@ucdavis.edu.
- Check for content repetition. Make sure that headers, footers or links are not duplicated unnecessarily.
- If you're asked to verify content for a page that's recently updated, let the editor know if there is a 'Last updated: ' date - and it's not recent.
- Verify downloadable documents and files. If there is text associated with the download, verify that it is descriptive of the document content and type. For example, Instructions for Stewing Rabbits: PDF should be a link to a PDF file with information about stewing rabbits; you should be able to open it, open it in a new window, and save the PDF.
- Verify the content, if it is instructions-based. If there are steps for an action in smartsite, follow those steps where possible and verify the information is accurate and does not skip any explanations to the user.