Software Quality Assuracen Plan

Alpha Unit

Table of Content
CHAPTER 1........................................................................................................................................................................3
1.1. INTRODUCTION.......................................................................................................................................................3
1.1.1. DOCUMENT PURPOSE.........................................................................................................................................3
1.1.2. PROJECT OVERVIEW..........................................................................................................................................3
1.1.3. PEOPLE....................................................................................................................................................................3
1.1.3.1. CLIENT..................................................................................................................................................................3
1.1.3.2. TEAM MEMBERS...............................................................................................................................................3
CHAPTER 2........................................................................................................................................................................4
2.1. DOCUMENT REFERENCES...................................................................................................................................4
2.2. SOFTWARE QUALITY ASSURANCE PLAN (SQAP)..........................................................................................4
2.2.1. SOFTWARE REQUIREMENTS SPECIFICATION (SRS)................................................................................4
2.2.2. SOFTWARE ARCHITECTURAL DESIGN DOCUMENT (SADD)..................................................................4
2.2.3. SOFTWARE DESIGN DOCUMENT (SDD).........................................................................................................4
2.2.4. SOFTWARE TEST PLAN (TP)..............................................................................................................................4
2.2.5. SOFTWARE USABILITY TEST PLAN (SUTP)..................................................................................................5
2.2.6. PROJECT PLAN (PP).............................................................................................................................................5
2.2.7. USER DOCUMENTATION (UD)...........................................................................................................................5
2.2.8. DESIGN NOTEBOOK (DN)...................................................................................................................................5
CHAPTER 3........................................................................................................................................................................6
3.1. MANAGEMENT.........................................................................................................................................................6
3.1.1. ORGANIZATION....................................................................................................................................................6
3.1.1.1. ROLE ALLOCATION..........................................................................................................................................6
3.1.1.2. DOCUMENT ALLOCATION..............................................................................................................................6
3.1.2. TEAM MEMBERS RESPONSIBILITIES............................................................................................................7
3.1.2.1. PROJECT MANAGERS......................................................................................................................................7
3.1.2.2. LIBRARIAN..........................................................................................................................................................7
3.1.2.3. SYSTEM ARCHITECT........................................................................................................................................7
3.1.2.4. GUI DESIGNER....................................................................................................................................................7
3.1.2.5. QUALITY MANAGER........................................................................................................................................7
3.1.2.6. CODE TEST MANAGER....................................................................................................................................7
3.1.2.7. USABILITY TEST MANAGER..........................................................................................................................7
3.1.2.8. REVIEW MANAGER..........................................................................................................................................8

________________________________________________________________________________
-1-

Software Quality Assuracen Plan

Alpha Unit
CHAPTER 4........................................................................................................................................................................9
4.1. STANDARDS...............................................................................................................................................................9
4.1.1. MEETING PROCEDURES....................................................................................................................................9
4.1.1.1. TEAM MEETING PROCEDURE......................................................................................................................9
4.1.2. REVIEW MEETING PROCEDURE.....................................................................................................................9
4.1.3. DOCUMENTATION FORMAT STANDARD......................................................................................................9
4.1.4. CODING STANDARDS..........................................................................................................................................9
4.1.5. TESTING STANDARDS AND PROCEDURES.................................................................................................10
4.1.6. FILE NAMING CONVENTIONS........................................................................................................................10
CHAPTER 5......................................................................................................................................................................11
5.1. REVIEWS..................................................................................................................................................................11
5.1.1. OVERVIEW............................................................................................................................................................11
5.1.2. EXTERNAL REVIEWS........................................................................................................................................11
5.1.3. INTERNAL REVIEWS.........................................................................................................................................11
5.1.4. SOFTWARE QUALITY ASSURANCE REVIEW.............................................................................................11
5.1.5. SOFTWARE REQUIREMENT REVIEW...........................................................................................................11
CHAPTER 6......................................................................................................................................................................12
6.1. SOFTWARE ARCHITECTURAL DESIGN REVIEW.........................................................................................12
6.1.1. SOFTWARE DESIGN REVIEW..........................................................................................................................12
6.1.2. TEST PLAN REVIEW..........................................................................................................................................12
6.1.3. USABILITY TEST PLAN REVIEW....................................................................................................................12
6.1.4. USER DOCUMENTATION REVIEW................................................................................................................12
CHAPTER 7......................................................................................................................................................................13
7.1. TESTING...................................................................................................................................................................13
CHAPTER 8......................................................................................................................................................................14
8.1. PROBLEM REPORTING AND CORRECTIVE ACTION.................................................................................14
8.1.1. DOCUMENT PROBLEMS...................................................................................................................................14
8.1.2. CODE PROBLEMS...............................................................................................................................................14
CHAPTER 9......................................................................................................................................................................14
9.1. TOOLS, TECHNIQUES AND METHODOLOGIES............................................................................................14
9.1.1. DESIGN METHODOLOGY.................................................................................................................................14
9.1.2. VERSION CONTROL...........................................................................................................................................14
9.1.3. RECORDS COLLECTION, MAINTENANCE AND RETENTION...............................................................14
9.1.4. MEDIA CONTROL...............................................................................................................................................15
9.1.5. BACKUPS...............................................................................................................................................................15
9.1.6. TOOLS AND SOFTWARE (OVERVIEW).........................................................................................................15

________________________________________________________________________________
-2-

Software Quality Assuracen Plan

Alpha Unit

Chapter 1
Chapter 2 Introduction
Chapter 3 Document Purpose
The Software Quality Assurance Plan (SQAP) defines the activities performed to provide assurance
that the software-related items delivered to the customer conform to the established and contracted
technical requirements. The SQAP also describes how the project will be audited to ensure that the
policies, standards, practices, procedures, and processes applicable to the project are followed.
This document is provided as reference for team members and auditors to facilitate the process of
quality assurance.

Chapter 4 Project Overview

This project aims to provide the portal service Alfa a/s with software that will, firstly improve the
quality and efficiency of creating, maintaining and regulating a hierarchy of categorized resources.
Secondly it will aid internal communication among employees of alpha a/s. To accomplish this a
waterfall model has been chosen with early use of paper based GUI prototypes. End solution will be
a web-based application.

Chapter 5 People
Chapter 6 Client
Name:
Address:
Contact:

Alpha a/s
Nye Kongensgade 3
4457 Kge
Sravan Kumar
Tel 50 90 71 46

Chapter 7 Team Members

Navn

Tlf. nr.

e-mail

Bente Bek Petersen

Hrvard Semundseth
Helene Nrgaard Bech
Martin LeBoeuf
Martin Mlvig
Orri Plsson
Mohammed Marouf
Rafat A. Oubida

48 47 61 64/20 82 66 64
51 55 93 46
29 72 78 10
23 29 41 72
28 80 93 68
33 21 89 29/26 81 11 50

bek@itu.dk
havard@itu.dk
helenebech@itu.dk
boeuf@itu.dk
martinm@dk.ibm.com
orri@itu.dk
marouf@itu.dk
oubida@itu.dk

51 31 75 74

________________________________________________________________________________
-3-

Software Quality Assuracen Plan

Alpha Unit

Chapter 8
Chapter 9 Document References
This section describes the nature, purpose and audience of every document that is produced.
Review method and procedures would be described in chapter 5. For dates for each of the
documents see chapter x.x.x. Refer to section 8.x.x. for location of the documents.
All documents audience will be general audience unless other is stated. We defined the general
audience as follows:
The client
Team
Auditors

Chapter 10 Software Quality Assurance Plan (SQAP)

Refer to chapter 1.x

Chapter 11 Software Requirements Specification (SRS)

Define the overall requirements of the software covering in a concise and unambiguous way,
covering all aspects of the system including:
1. The softwares functionality.
2. Content and attributes.
3. Design requirements.
4. Performance constraints.

Provide a base of common understanding for both the client and the team.
Provide a framework that can measure against during acceptance testing.

Chapter 12 Software Architectural Design Document (SADD)

Give an overview of the design of the system but maintain data abstraction.
Partition the system into smaller parts (modules).
Specify the interface and control flow between modules.
Describe the Graphical User Interface (GUI).

Chapter 13 Software Design Document (SDD)

The Software Design Document is build upon the SADD.

Detail how the Software will meet the requirement detailed in the SRS.
Describe various components and sub-components of the system.
Identify major data structures.

Chapter 14 Software Test Plan (TP)

Explain test philosophies and techniques.

Describe the derivation of test cases and approaches used to apply the in the code.
Identify the techniques used for test result collection and bug monitoring.
Specify the order in which modules are to be tested.

________________________________________________________________________________
-4-

Software Quality Assuracen Plan

Alpha Unit

Chapter 15 Software Usability Test Plan (SUTP)

Leverage the quality of the software usability.

Identify usability defects.

Chapter 16 Project Plan (PP)

Assist the Project Manager in planning all aspects of the project.

The project plan should be a reference to the team members and identify the current phase of
the development.

Chapter 17 User Documentation (UD)

Insure proper use of the software.

Chapter 18 Design Notebook (DN)

Organize a method for documenting all design proposals and decisions.

Store all relevant information from meetings (i.e. print-outs, sketches, etc).
Contain results of reviews.

________________________________________________________________________________
-5-

Software Quality Assuracen Plan

Alpha Unit

Chapter 19
Chapter 20 Management
Chapter 21 Organization
Chapter 22 Role Allocation
Roles are allocated to team members as listed below.
Roles
Project Manager 1
Project Manager 2
Librarian
System Architechture
GUI Design
Test Manager
Review Manager
Quality Manager
Usability Test Manager
Implemntation Manager

Member
Helene Nrgaard Bech
Martin Mlvig
Bente Bek Petersen
Hrvard Semundseth
Orri Plsson
Martin LeBoeuf
Mohammed Marouf
Orri Plsson/ Hrvard Semundseth
Rafat A. Oubida
Martin LeBoeuf

Chapter 23 Document Allocation

Each team member is responsible for managing one or more documents, as allocated
below.
Document
Software Quality Assurance Plan (SQAP)
Software Requirement Specification (SRS)
Software Architectural Design Document (SADD)
Software Design Document (SDD)
Software Usability Test Plan (UTP)
Software Test Plan (TP)
Project Plan (PP)
User Documentation (UD)
The Design Notebook

Document Manager
Orri Plsson
Martin Mlvig
Hrvard Semundseth
Rafat A. Oubida
Martin Mlvig/ Helene Nrgaard
Martin LeBoeuf
Martin Mlvig/ Helene Nrgaard Bech
Bente Bek Petersen
Orri Plsson

Chapter 24 Team Members Responsibilities

Chapter 25 Project Managers
Manages and updates the project plan.
Informs team members of the project plan at team meetings.
Has an overview over what milestones have been met and which ones are next.
Informs team member of progress.
________________________________________________________________________________
-6-

Software Quality Assuracen Plan

Alpha Unit

Delegates tasks to team members.

Ensures everyone is notified of meetings and keeps track of who will be present.
Creates agenda for meetings and e-mails them to team members, updates agenda in case of
eventual inputs by team.
Maintains contact with H.O.D in Alpha a/s.
Tries to maintain a fair and balanced workload for all team members.

Chapter 26 Librarian
Is responsible for maintaining a structure in the CVS repository by creating new directories
and imposing establishing naming conventions.
Informs team members of eventual changes regarding document handling.
Chapter 27 System Architect
Defines architecture for the entire system.
Responsible for writing the Software Architectural Design Document (SADD).
Chapter 28 GUI Designer
Designs the user interface of the system.
Responsible for creating the design notebook.
Chapter 29 Quality Manager
Defines quality standards to be followed by writing the writing a quality assurance
plan(sqap)
Manages the proof reading of all documents.
Ensures that audits and reviews are carried out.
Chapter 30 Code Test Manager
Is responsible for writing the Software Test Plan (TP).
Manages the process of testing by delegating tests to team members.
Documents all tests that are carried out.
Chapter 31 Usability Test Manager
Organizes usability test, this includes gathering test group and preparation (as purposed by
Sren Lausen)
Documents test according to method purposed by Sren Lausen
Classifies eventual usability errors and together with GUI designer suggests improvement to
GUI
Chapter 32 Review Manager
Find sources to participate in the external review.
Keep track of internal reviews by exchanging documents between team member.
Organizes review meetings and ensures that they are properly documented.

________________________________________________________________________________
-7-

Software Quality Assuracen Plan

Alpha Unit

________________________________________________________________________________
-8-

Software Quality Assuracen Plan

Alpha Unit

Chapter 33
Chapter 34 Standards
Chapter 35 Meeting Procedures
Chapter 36 Team Meeting Procedure
Team meeting are held Mondays at 12.30. If additional meeting are required, they are held on
Thursdays between 19:0021:00. Project manager is chairman of meeting. The purpose of the team
meeting is the project managers can delegate tasks to team member and is to inform them of the
progression of the project. At each meeting we will examine what milestones weve met and which
ones approaching. In this way the whole team can gain impression of how the project is
progressing. The agenda should be placed in CVS repository under administration
/monday_meetings/agenda, 24 hours before the meeting. Team members may add items to the
agenda after it has been written by updating the agenda file using CVS. Project Manager is
responsible for bringing a hard copy of the updated agenda to the meeting. Project Manager is
responsible for specifying the duration of the meeting when informing the team members of the
agenda. Due to the time constraint on this project, meetings with the whole team should not last
longer than 45 minutes.

Chapter 37 Review Meeting Procedure

Review meetings should meet the following requirements.
Participants should be between three and five people (external review).
Participants should be between one and three people (internal review).
At least one person who has not directly worked on the document should participate.
Participant should prepared for the meetings
The duration of a review meeting should be 1-2 hours

Chapter 38 Documentation Format Standard

(Talk to librarian regarding this)

Chapter 39 Coding Standards

The document Code Convention for the Java Programming Language is used as guidelines for
coding standards. In addition to those guidelines team members should remember following:
Variables and method names should be chosen that are short, unique and descriptive.
All code should be written in English.
Good use of descriptive comments for all methods and relevant variables.
All code must include java doc tags/doc, to generate java documentation using javadoc
comments See: http://java.sun.com/j2se/javadoc/writingdoccomments/
A coding template that demonstrates coding java convention will be located at
code/code_structure/code_template/template.java

________________________________________________________________________________
-9-

Software Quality Assuracen Plan

Alpha Unit

Chapter 40 Testing Standards and Procedures

Exact detail of system testing will be included in the Test Plan (TP) and usability tests in Usability
Test Plan (UTP)

Chapter 41 File Naming Conventions

Check with Bente

________________________________________________________________________________
- 10 -

Software Quality Assuracen Plan

Alpha Unit

Chapter 42
Chapter 43 Reviews
Chapter 44 Overview
Following is a list of all reviews which will be held in the course of this project. Review meeting
procedures are described in section 4.1.2

Chapter 45 External Reviews

Selected documents are submitted for external reviews. The review manager is responsible for
finding participants and providing them with the correct documents.

Chapter 46 Internal Reviews

Reviews are made internally by the group members of Alpha Unit. The review manager keeps track
of which documents are produced and manages the exchange of review tasks between the sub
teams.

Chapter 47 Software Quality Assurance Review

This document should contain sufficiently detailed descriptions of quality processes for the Team to
follow throughout the duration of the project. Among the criteria to be examined are following:
Has the project been described and the team identified?
Are all necessary texts referenced?
Named team members are matched with clear responsibilities.
Does the Project Plan show the phases of the project and submission dates?
Is a standard meeting procedure described?
Have design, coding and testing methodologies been specified?
Have problem reporting and correction procedures been established?
Have the tools and systems for documenting decisions and design been decided upon?

Chapter 48 Software Requirement Review

This review is held to ensure that the requirements detailed in the Software Requirements
Specification (SRS) describes the system to be delivered. The client will be involved in this review.
It is important to ask weather task specified in (SRS) are sufficient to meet the customers
expectations.

________________________________________________________________________________
- 11 -

Software Quality Assuracen Plan

Alpha Unit

Chapter 49
Chapter 50 Software Architectural Design Review
To ensure that the main design structure is completed, with respect to the SRS,
a Software Architectural Design Review should be held.
The document must describe the intended implementation structure for all aspects of the systems
functionality.
By verifying the SADD by comparing it to the SRS and ensuring that every requirement can be
traced to one or more parts of the SADD.
The Software Architectural Design Review should clarify and determine the following:
Traceability: is the requirement found in the SRS?
Completeness: does the design satisfy the requirement?
Clarity: is the design clear enough to ensure that the requirement is satisfied
Feasibility: can the design be completed with using existing tools?

Chapter 51 Software Design Review

The Software Design Review is held to determine the acceptability of the software design as
described in the Software Design Description (SDD).
It must be completed, including how all routines interact and the structure of each routine.
Routine for satisfying all the requirements specified in the SRS should also be described.

Chapter 52 Test Plan Review

The Test Plan Review is held to ensure correctness and completeness of the testing methods in the
Test Plan (TP). The Test Plan Review should check if the TP contains testing criteria such as:
Does the TP contain
1. An overall plan for testing the code?
2. Does it provide a Unit Testing Strategy?
Are the TP done according to the testing procedures outlined in the SQAP?
Are all important test cases included?
Is the result of the test cases included?
Are all requirement stated in the SQAP tested?

Chapter 53 Usability Test Plan Review

The Usability Test Plan Review is held to make sure that the usability test would uncover possibility
defects in the design of the GUI.

Chapter 54 User Documentation Review

User Documentation must be verified against the final working system. This to ensure that all
possible interaction with the system is fully described. As this document should aid its users it is
critical that it remains internally consistent, and is written in an understandable and pedagogic way.

________________________________________________________________________________
- 12 -

Software Quality Assuracen Plan

Alpha Unit

Chapter 55
Chapter 56 Testing
This section will describe the verification validation approach to be used by the project team to
ensure that the system meets user requirements, function as designed, and is free of defects. See
Test plan (TP) and Usability Test Plan (UTP)

________________________________________________________________________________
- 13 -

Software Quality Assuracen Plan

Alpha Unit

Chapter 57
Chapter 58 Problem Reporting and Corrective Action
This section will attempt to identify problems and suggest solution and provide a clear problem
reporting method when problems occur.

Chapter 59 Document Problems

Provided a document has not yet been released (i.e. has not reached second revision), any team
member may change and commit to CVS. The file should be given an accurate description of the
changes made in the CVS log.
All non-trivial changes to a document after it has been released should be recorded in the
documents changelog file, located in the same directory.

Chapter 60 Code Problems

For testing methodologies and bug handling procedures, see documentation in the Test Plan (TP).

________________________________________________________________________________
- 14 -

Software Quality Assuracen Plan

Alpha Unit

Chapter 61
Chapter 62 Tools, Techniques and Methodologies
Chapter 63 Design Methodology
The Design Methodology chosen for the project is the Booch Method, which is a well documented,
proven method for object-oriented analysis and design. Refer to Section 4.2 of the Software Requirements
Specification (SRS) for details of each phase.

Chapter 64 Version Control

CVS (Concurrent Versions System) will be used to manage version control (see Section 7.1 Document Problems for document modification information). CVS Tortoise will be used for checking
in/out file(s) from the repository under a Windows environment.
Refer to Section 4.6.x CVS Procedures for information regarding CVS usage.

Chapter 65 Records Collection, Maintenance and Retention

All document sources and source code will be stored in the CVS repository.
Documents will be made available through CVS or a hardcopy will be kept by the Secretary.
The directory structure for the team directory is as follows:
Note that each directory in the repository shall contain a read_me.text file describing the directory and file
structure on that level.

________________________________________________________________________________
- 15 -

Software Quality Assuracen Plan

Alpha Unit

administration/
administration/hands_in
administration/monday_meetings
administration/project_description
administration/project_plan
administration/ time_plan
code/
personal/
personal/bente
personal/havard
personal/helene
personal/martin_l
personal//martin_m
personal/muhammed
personal/orri
personal/rafat
project_handbook/
project_handbook/contact_list
report
requirement_spec
roles/
roles/configuration
roles/project_managers
roles/quality_assurance
roles/test

Administration files for the TeamAlfa

Contains document for handing in HOD
Meeting documents
The project description
The project plan
The time plan
Project code structure described in detail below
Personal storage space
Personal storage space for team member Bente
Personal storage space for team member Hvard
Personal storage space for team member Helene
Personal storage space for team member Martin L.
Personal storage space for team member Martin M.
Personal storage space for team member Muhammed
Personal storage space for team member Orri
Personal storage space for team member Rafat
Project handbook
Contact list for team members
Contains reports not completed!
Contains the software requirement specification (SRS)
Contains roles for team members
Contains files for configuration team members - configuration
Contains files for configuration team members project_managers
Contains files for configuration team members quality assurance
Contains files for configuration team members test

The basic CVS directory structure for the project code is as follows:
code
code/code_structure/
code/code_structure/bak
code/code_structure/classes
code/code_structure/src
code/code_structure/src/images
code/code_structure/test
code/code_structure/docs

Contains files regarding the source code

Contains the structure of the code
Project backup files of java source code
Project java class files
Project development java source files
Images used in the project
Testkits for integration and unit testing
Project documentation of java source files

This is not completed

Chapter 66 Media Control

Work will be done in home directories (or where the team members prefers), and
CVS used to check in changes.
The librarian is responsible for creating new directories in the teams CVS repository. Suggestions to new
directories should be e-mailed to the librarian.

Chapter 67 Backups
Librarian is responsible for making backups once a week.
________________________________________________________________________________
- 16 -

Software Quality Assuracen Plan

Alpha Unit
Backups will be stored remotely at two locations. The first backup will be stored at the AlfaTeam
project storage space at itu.dk.
A second backup will be stored at? Suggestions?

Chapter 68 Tools and Software (Overview)

Tools that will be used in the development of this system:
CVS (Concurrent Versions System)
RDBMS (Oracle)
LATEX
Microsoft Visio
Microsoft Word
Microsoft Project????????
Apace Ant
Apache Tomcat
JBuilder X
Adobe Photoshop
Adobe Acrobat
Not completed!

________________________________________________________________________________
- 17 -