QUALITY ASSURANCE PLAN
Project or System Name
U.S. Department of Housing and Urban Development
Month, Year
Revision Sheet
Revision Sheet
Release No. Rev. 0 Rev. 1 Rev. 2 Date 5/30/00 6/13/00 4/12/02 Revision Description Quality Assurance Plan Template and Checklist New section 2.0 (Task and Responsibilities) and additional text in section 3.1 Conversion to WORD 2000 format
Quality Assurance Plan
Page i
Quality Assurance Plan Authorization Memorandum
I have carefully assessed the Quality Assurance Plan for the (System Name). This document has been completed in accordance with the requirements of the HUD System Development Methodology. MANAGEMENT CERTIFICATION - Please check the appropriate statement.
______ The document is accepted.
______ The document is accepted pending the changes noted.
______ The document is not accepted.
We fully accept the changes as needed improvements and authorize initiation of work to proceed. Based on our authority and judgment, the continued operation of this system is authorized. _______________________________ NAME Project Leader _______________________________ NAME Operations Division Director _______________________________ NAME Program Area/Sponsor Representative _______________________________ NAME Program Area/Sponsor Director _____________________ DATE
_____________________ DATE
_____________________ DATE
_____________________ DATE
Quality Assurance Plan
Page ii
QUALITY ASSURANCE PLAN
TABLE OF CONTENTS
Page # 1.0 GENERAL INFORMATION .......................................................................................................... 1-1 1.1 1.2 1.3 1.4 1.5 1.6 Purpose ................................................................................................................................... 1-1 Scope ...................................................................................................................................... 1-1 System Overview ................................................................................................................... 1-1 Project References .................................................................................................................. 1-1 Acronyms and Abbreviations ................................................................................................. 1-2 Points of Contact .................................................................................................................... 1-2
1.6.1 1.6.2 Information .............................................................................................................................1-2 Coordination ...........................................................................................................................1-2
2.0 3.0
SCHEDULE OF TASKS AND RESPONSIBILITIES .................................................................... 2-1 SYSTEM DOCUMENTATION ...................................................................................................... 3-1 3.1 Documents by Phase .............................................................................................................. 3-1
3.1.1 3.1.2 3.1.3 3.1.4 3.1.5 3.1.6 Initiate Phase ...........................................................................................................................3-1 Define Phase ...........................................................................................................................3-1 Design Phase ...........................................................................................................................3-2 Build Phase .............................................................................................................................3-2 Evaluate Phase ........................................................................................................................3-2 Operate Phase .........................................................................................................................3-2
3.2 4.0
Discipline for Documentation Standard Practices ................................................................. 3-3
REVIEWS AND AUDITS ............................................................................................................... 4-1 4.1 4.2 4.3 4.4 4.5 Review Process ...................................................................................................................... 4-1 Formal Reviews and Audits ................................................................................................... 4-1
4.2.1 4.2.2 Lifecycle Reviews ...................................................................................................................4-1 Audits ......................................................................................................................................4-1
Informal Reviews ................................................................................................................... 4-2 Review Reports ...................................................................................................................... 4-2 Review and Audit Metrics ..................................................................................................... 4-2
5.0 6.0
TESTING ......................................................................................................................................... 5-1 PROBLEM REPORTING AND CORRECTIVE ACTION ............................................................ 6-1 6.1 6.2 Problem/Issue Documentation ............................................................................................... 6-1 Report Metrics ........................................................................................................................ 6-1
7.0 8.0
TOOLS ............................................................................................................................................. 7-1 PROJECT CONTROLS ................................................................................................................... 8-1 8.1 8.2 Product Control ...................................................................................................................... 8-1 Supplier Control ..................................................................................................................... 8-1
9.0
TRAINING....................................................................................................................................... 9-1
Quality Assurance Plan
Page iii
1.0 General Information
1.0
GENERAL INFORMATION
Quality Assurance Plan
1.0 General Information
NOTE TO AUTHOR: Highlighted, italicized text throughout this template is provided solely as background information to assist you in creating this document. Please delete all such text, as well as the instructions in each section, prior to submitting this document. ONLY YOUR PROJECTSPECIFIC INFORMATION SHOULD APPEAR IN THE FINAL VERSION OF THIS DOCUMENT. This Quality Assurance Plan (QAP) presents a framework for activities, which when followed, will ensure delivery of quality products and services. The SDM provides the project standards and procedures to be used as the basis for the QA group's reviews and audits.
1.0 1.1
GENERAL INFORMATION Purpose
Describe the purpose of the Quality Assurance Plan.
1.2
Scope
Describe the scope of the Quality Assurance Plan as it relates to the project.
1.3
System Overview
Provide a brief system overview description as a point of reference for the remainder of the document. In addition, include the following: Responsible organization System name or title System code System category
Major application: performs clearly defined functions for which there is a readily identifiable security consideration and need General support system: provides general ADP or network support for a variety of users and applications
Operational status
Operational Under development
System environment and special conditions
1.4
Project References
Page 1-1
Quality Assurance Plan
1.0 General Information
Provide a list of the references that were used in preparation of this document. Examples of references are: Previously developed documents relating to the project Documentation concerning related projects HUD standard procedures documents Quality Assurance Guidelines
1.5
Acronyms and Abbreviations
Provide a list of the acronyms and abbreviations used in this document and the meaning of each.
1.6
Points of Contact
1.6.1 Information
Provide a list of the points of organizational contact (POCs) that may be needed by the document user for informational and troubleshooting purposes. Include type of contact, contact name, department, telephone number, and e-mail address (if applicable). Points of contact may include, but are not limited to, helpdesk POC, development/maintenance POC, and operations POC.
1.6.2 Coordination
Provide a list of organizations that require coordination between the project and its specific support function (e.g., installation coordination, security, etc.). Include a schedule for coordination activities.
Quality Assurance Plan
Page 1-2
2.0 Schedule of Tasks and Responsibilities
2.0
SCHEDULE OF TASKS AND RESPONSIBILITIES
Quality Assurance Plan
2.0 Schedule of Tasks and Responsibilities
2.0
SCHEDULE OF TASKS AND RESPONSIBILITIES
Based on the tasks described in your Project Plan, provide a schedule of the QA activities for the duration of the project. Tasks may include, but are not limited to, those listed below. (Refer to the Quality Assurance Guidelines in the SDM for a complete description of these tasks.) A waiver exempting the project from any of these tasks is required. Identify Standards and Guidelines Evaluate Software Tools Evaluate Facilities Evaluate Software Products Review Process Evaluate Project Planning, Tracking, and Oversight Processes Evaluate Requirements Analysis Process Evaluate Design Process Evaluate Code and Unit Testing Process Evaluate Integration Testing Process Evaluate Acceptance Testing Process Evaluate Release Process Evaluate the Corrective Action Process Evaluate Media Certification Process Certify Non-deliverable Software Evaluate Storage and Handling Process Evaluate Deviations and Waivers Process Evaluate Configuration Management Process Evaluate Software Development Library Control Process Evaluate Non-developmental Software Perform Configuration Audits Evaluate Risk Management Process
Quality Assurance Plan
Page 2-1
3.0 System Documentation
3.0
SYSTEM DOCUMENTATION
Quality Assurance Plan
3.0 System Documentation
3.0
SYSTEM DOCUMENTATION
This section describes all documentation that will be generated, by lifecycle phase, for the project. The identified documentation listed will be that which control the development, verification and validation, use and maintenance of the software.
3.1
Documents by Phase
List and briefly describe the documentation expected to be produced during this project. Depending on the size of your project, this may include, but is not limited to, the documents in the following subsections. (Note that some of the documents listed below are updated in subsequent phases.) The HUD SDM Documentation Standards lists the objectives for producing standardized system documentation. The QAP may include any other deliverables cited in the project Work Breakdown Structure (WBS).
3.1.1 Initiate Phase
Needs Statement Project Plan (including WBS) Configuration Management Plan Quality Assurance Plan Feasibility Study Cost/Benefit Analysis Risk Analysis
3.1.2 Define Phase
System Support and Acquisition Plan (initial) Functional Requirements Document Data Requirements Document System Security and Privacy Plan Internal Audit Plan Project Plan (updated)
Quality Assurance Plan
Page 3-1
3.0 System Documentation
3.1.3 Design Phase
System/Subsystem Specifications Database Specifications Program Specifications System Support and Acquisition Plan (final) Validation, Verification, and Testing Plan (initial) Training Plan (initial) Project Plan (updated)
3.1.4 Build Phase
Installation and Conversion Plan (initial) Test Plan User’s Manual Operations Manual Maintenance Manual Validation, Verification, and Testing Plan (final) Training Plan (final) Project Plan (updated)
3.1.5 Evaluate Phase
Test Results and Evaluation Reports Installation and Conversion Plan (final) Project Plan (updated)
3.1.6 Operate Phase
Pilot Test Results Training Material Project Plan (updated)
Quality Assurance Plan
Page 3-2
3.0 System Documentation
3.2
Discipline for Documentation Standard Practices
Describe the criteria that will be applied during review and evaluation of all lifecycle documents. If HUD documentation standard templates are not used in the creation of project documents, describe the alternative. A waiver exempting the project from standard template usage is required.
Quality Assurance Plan
Page 3-3
4.0 Reviews and Audits
4.0
REVIEWS AND AUDITS
Quality Assurance Plan
4.0 Reviews and Audits
4.0
REVIEWS AND AUDITS
This section discusses quality assurance’s role in the reviews and audits that will be conducted during the lifecycle of the project to ensure the quality, consistency, comprehension, and completeness of the project documentation and activities.
4.1
Review Process
Define the steps of the review process and the procedures that will be used to conduct reviews. Address management and attendee responsibilities with respect to the review process.
4.2
Formal Reviews and Audits
This subsection addresses the formal, scheduled reviews and audits that will be conducted on the project. Reviews are a monitoring mechanism to assess the progress and well being of the project.
4.2.1 Lifecycle Reviews
Identify the types of SDM associated lifecycle or non-lifecycle reviews that will be conducted within each project lifecycle phase. Include a schedule of reviews and include how the results of each review will be used on the project. Typically, the lifecycle reviews include: Requirements Review Preliminary Design Review Specification Review Design Review Critical Design Review Test Readiness Review Formal Qualification Review Production Readiness Review Acceptance Test Review Post-Implementation Review
4.2.2 Audits
Describe the audits that will be conducted on the project and when they will be scheduled. Audits are independent examinations of a deliverable or a set of deliverables. Audits are accomplished by comparing the actual characteristics of a deliverable with those required or specified.
Quality Assurance Plan
Page 4-1
4.0 Reviews and Audits
4.3
Informal Reviews
Outline the types of informal reviews that will be conducted. Types of reviews may include walkthroughs, desk check codes, peer reviews, and quality control reviews.
4.4
Review Reports
Identify QA reports that will be produced throughout the project lifecycle and their uses. These reports may include: Review issues list Review summary report Action tracking report
4.5
Review and Audit Metrics
Describe the metrics that will be used to capture management information, and how they will be analyzed and reported.
Quality Assurance Plan
Page 4-2
5.0 Testing
5.0
TESTING
Quality Assurance Plan
5.0 Testing
5.0
TESTING
Identify the roles and responsibilities of the QA function in relation to testing throughout the various stages of the project. These include but are not limited to: Unit testing System testing Integration testing Regression testing Acceptance testing
Quality Assurance Plan
Page 5-1
6.0 Problem Reporting and Corrective Action
6.0
PROBLEM REPORTING AND CORRECTIVE ACTION
Quality Assurance Plan
6.0 Problem Reporting and Corrective Action
6.0
PROBLEM REPORTING AND CORRECTIVE ACTION
Discuss QA responsibilities and activities concerned with the reporting and tracking of project-related problems and resolutions.
6.1
Problem/Issue Documentation
Explain how problems and issues will be documented.
6.2
Report Metrics
Describe how metrics from the above reports will be collected and analyzed to determine and coordinate corrective actions.
Quality Assurance Plan
Page 6-1
7.0 Tools
7.0
TOOLS
Quality Assurance Plan
7.0 Tools
7.0
TOOLS
This section discusses QA responsibilities and activities concerned with the reporting and tracking of project related problems and resolutions. Describe the tools that will be used for QA and the methodology employed to implement usage of the mentioned tools. The tools may include, but are not limited to: Operating system utilities Debugging aids Documentation tools Code and structure analyzers Monitors Statistical analysis packages Static or dynamic test tools
Quality Assurance Plan
Page 7-1
8.0 Project Controls
8.0
PROJECT CONTROLS
Quality Assurance Plan
8.0 Project Controls
8.0 8.1
PROJECT CONTROLS Product Control
Identify how QA will monitor the methods and tools used to maintain and store controlled versions of system products.
8.2
Supplier Control
Describe the provisions for assuring that products provided by suppliers meets established requirements. In some cases, projects do not foresee purchasing certain products. If that is the case, the following paragraph may be used: All supplier products have been operationally tested in the target system. No future product acquisition is planned.
Quality Assurance Plan
Page 8-1
9.0 Training
9.0
TRAINING
Quality Assurance Plan
9.0 Training
9.0
TRAINING
Identify the training activities that will be provided to meet the needs of QA on this project. Suggested training may include: Project orientation on roles, responsibilities, and quality assurance staff authority Software engineering skills and practices Project standards, procedures, and methods Understanding and using automated tools Interpersonal communications
Quality Assurance Plan
Page 9-1