Central Washington University Quality Assurance Planmain content
Assignment Learning Objectives
Be able to
- Use a Microsoft Office Word template to format a technical report
- Use sections and page breaks to break up and format a multi-page document
- Use Microsoft Word's automatic table of contents to generate and update table of contents for a technical report based on headings
- Use tables with captions and row/column headings to effectively present information
- Use the inverted pyramid style of writing to present key information and conclusions first
- Write paragraphs that begin with strong topic sentences, demonstrate unity, and flow logically and smoothly from one to the next
- Use Microsoft Office Word to develop project forms to help with quality assurance
- Write clear, complete, and unambiguous standards and procedures
Assignment
Use Microsoft Word to create a Quality Assurance Plan containing the following sections:
- Title Page
- Include your team name & logo, project name, and date
- Include the names of the document editor and list as authors the team members who wrote content for this document
- Use a different document editor from the Software Project Plan and Requirements Specification Document
- Do not list as authors the team members who did not write content
- Include your client and faculty advisor names
- Table of Contents
- Use Word's built-in automatic table of contents feature
- The first page of the Introduction Section should appear as page 1
- Do not include page numbers on the Title Page or Table of Contents page
- Do not include the title or table of contents section in the Table of Contents
- Introduction
- Briefly describe the project you are working on
- Describe the role quality assurance plays in your software development process
- Describe the purpose, scope, and intended audience of this document. Preview the sections of the document that follow.
- Document Standards
- Describe the standards and procedures in place to ensure consistent, correct, and timely preparation of project documentation
- Be specific. Identify the Word templates and styles your group will use
- Coding Standards
- Describe the standards and procedures in place to ensure consistent, correct, and useful code comments and documentation
- Code template examples are a good way to illustrate your standards
- User Interface Guidelines
- Describe the user interface guidelines your team developed for assuring a consistent, easy-to-use user interface
- Explain the computer skills of the intended user(s) and include the reasons behind the UI guidelines you have developed
- Change Control Process
- Describe the process your group will use to control change from this point forward
- Discuss how your group will protect against creeping requirements and insure that all team members are advised of all changes
- Testing Process
- Describe the process your team will follow for testing your software
- Include details on your team's methods for unit testing, integration testing, and system testing
- Describe the criteria and procedures you will use for client acceptance testing
- Present this material in project-specific terms. Avoid stating this material in generic software engineering terms
- Appendices
- Include forms your team has developed for quality assurance (e.g. Change Request Form, Client Acceptance Form)
- Any others as appropriate (optional)
Grading criteria
Your grade will be based on both your demonstrated writing proficiency and on the contents of the document.
Two scoring rubrics will be used in assessing this document: a content scoring rubric [PDF] and a writing proficiency scoring rubric [PDF]. You are encouraged to print these rubrics and use them as checklists for expectations, writing guidelines, and quality assurance.
You may wish to examine the previous years' CS 480 Quality Assurance Plans kept in the computer science department. Ask LaVelle to show you where the binders containing the documents are stored. Note: These binders are not to leave the department office.
Honor code: The work needs to be your own. You may wish have someone from outside the team help by proofreading a draft version and identifying problems, but the words and content contained in the documents should be your own.
Submission Guidelines
Turn in two printed copies of your Quality Assurance Plan. One copy is graded and returned to you; the other copy is archived in the computer science departmental files.
Include a link to your Quality Assurance Plan (saved as a *.doc file) on your team's Web site. I will download the file from your site to help with my grading.
Ask, and if desired, provide your faculty advisor and/or client with a printed copy of your Quality Assurance Plan.