The University of Lahore
A “W4” Category University
Lecture 19
CHAPTER 3
The University of Lahore
A “W4” Category University
Phases of Formal Review
A typical formal review process consists of six main steps:
1- Planning
2- Kick-off
3- Preparation
4- Review Meeting
5- Re-work
The University of Lahore
A “W4” Category University
Phases of Formal Review
Planning
1. The review process for a particular review begins with a
“request for review” by the author to the moderator.
2. Moderator always performs an entry check and defines at this stage formal exit criteria.
3. Entry check ensure that the reviewers time is not wasted on a document that is not ready for review.
de-The University of Lahore
A “W4” Category University
Phases of Formal Review
Planning
The following can be regarded as the minimum set for performing the entry check:
1. A short check of a product sample by the moderator does not disclose a large numbers of major defects. For example, after 30 minutes of checking, no more than 3 major defects are found on a single page or fewer than 10 major defects in total in a set of 5 pages.
The University of Lahore
A “W4” Category University
After Entry Check
1. Moderator and author decide which part of the document to review i.e. human mind can see the limited number of pages at one time.
2. For review the maximum size is between 10 to 20 pages.
3. Those pages will be reviewed by the reviewer which contain major defects.
The University of Lahore
A “W4” Category University
Phases of Formal Review
Planning
1. After the document size has been set and the pages to be checked have been selected, the moderator determines, in co-operation with the author, the composition of the review team. 2. The team normally consists of four to six participants including
moderator and author.
The University of Lahore
A “W4” Category University
Phases of Formal Review
Planning
Review role for a document under review
1. Does the design according to the requirement?
2. Consistency, clarity, templates.
3. Interfaces between software functions. 4. Usability, reliability,
The University of Lahore
A “W4” Category University
Planning (SUMMARY)
1. Selecting the personnel
2. Allocating roles
3. Defining the entry and exit criteria
The University of Lahore
A “W4” Category University
Kick – Off (optional step in a review procedure)
1. The reviewers receive a short introduction on the objectives of the review and the documents are explained.
2. To get everybody on the same wavelength and to commit to the time that will be spent on checking.
3. Results of entry check and exit criteria are discussed. 4. It motivates reviewers.
The University of Lahore
A “W4” Category University
The University of Lahore
A “W4” Category University
Kick-off (SUMMARY)
1. Distributing documents
2. Explaining the objectives, process and documents to the participants
The University of Lahore
A “W4” Category University
Preparation
1. Participants work individually on the document under review to identify defects.
2. Issues are recorded using a logging form e.g. spelling mistakes, but not mentioned during the meeting.
3. The annotated (to add a short opinion or explanation of the text)
document is given to the author at the end of the meeting.
The University of Lahore
A “W4” Category University
Preparation
The optimum checking rate is the result of a mix of factors:
1. Type of document 2. Complexity
3. Number of related documents 4. Experience of the reviewers
The University of Lahore
A “W4” Category University
Preparation (SUMMARY)
1. Work done by each of the participants on their own before the review meeting
2. Logging defects
The University of Lahore
A “W4” Category University
Review Meeting
This meeting consists of
1- Logging phase
The University of Lahore
A “W4” Category University
Logging Phase
1. During this phase defects that have been identified during the preparation are mentioned page by page and are logged by the author or scribe
2. To ensure progress and efficiency, no real discussion is allowed in this phase.
The University of Lahore
A “W4” Category University
Severity (Seriousness) Classes
Critical:
defects will cause damage; the scope and impact
of the defect is beyond the document under inspection.
Major: defects could cause the downstream effect (fault in
the design can result in an error in the implementation)
Minor:
defects are not likely to cause downstream
The University of Lahore
A “W4” Category University
Logging Phase
1. During this phase the focus is on logging as many
defects as possible within a certain timeframe.
2. Partially focus on spelling mistakes.
3. Ensure the good number of defects logged per minute.
4. Logging rate should be between one and two defects
The University of Lahore
A “W4” Category University
Discussion Phase
1. The items which were logged in the logging phase, need to be discussed in this phase.
2. During discussion the _____________ take care of people issues.
3. ______________ prevents discussion from getting too personal, rephrases remarks if necessary and calls for a break to cool down.
4. Reviewers who do not need to be in the meeting may leave, or stay as a learning exercise.
5. Moderator ensures that all discussed items either have an outcome by the end of the meeting.
The University of Lahore
A “W4” Category University
Decision Phase
Decision based on exit criteria.
Exit Criteria
1. Is to prevent a task from being considered completed when there are still outstanding parts which have not been finished. 2. Is used to report when to stop testing.
3. The important exit criteria is the average number of critical or major defects found per page.(no more than three major defects found per page.)
The University of Lahore
A “W4” Category University
Review Meeting (SUMMARY)
1. Logging defects
2. Discussion about the defects
3. Decision of exit criteria
The University of Lahore
A “W4” Category University
Re-work
1. Based on defects detected, the author will improve
the document under review step by step.
2. Not every defect that is found leads to rework. It is
the author’s responsibility to judge if a defect has to
be fixed.
3. Changes that are made to the document should be
easy to identify during follow-up.
The University of Lahore
A “W4” Category University
Re-work (SUMMARY)
The University of Lahore
A “W4” Category University
Follow-up
The University of Lahore
A “W4” Category University
Roles and Responsibilities
The Moderator (review leader)
The main leader who leads the review process.
Responsibilities
1- Performs entry check.
2- Performs exit criteria with other participants. 3- Follow-up on the re-work.
4- Control the quality of the review process. 5- Schedule the meeting
6- Paces the meeting
The University of Lahore
A “W4” Category University
Roles and Responsibilities
The author
Writer of the document under review.
Responsibilities
1- Understand the defects found
2- Learn as much as possible to improve the quality of the
document.
The University of Lahore
A “W4” Category University
Roles and Responsibilities
The Scribe (recorder)
Records each defect mentioned and any suggestions for
process improvement.
Question
The University of Lahore
A “W4” Category University Ranked Amongst The Top 550 Universities of The WORLD!
If authors record their own defects in their own words, it helps them to understand the log better.
BUT
The University of Lahore
A “W4” Category University
Roles and Responsibilities
The Reviewers
A person who identifies and describe defects.
The Manager
The University of Lahore
A “W4” Category University
Types of Review
1. Walkthrough
2. Technical Review
The University of Lahore
A “W4” Category University
Walkthrough
A step by step presentation by the author of a document in order to gather information and to establish a common understanding of its content.
OR
The University of Lahore
A “W4” Category University
Walkthrough
1. It is useful if the people from outside the software
discipline are present, who are not used to, or cannot
easily understand software development documents.
The University of Lahore
A “W4” Category University
3. The participants who are selected from different departments and backgrounds are not required to do a detailed study of the documents in advance.
The University of Lahore
A “W4” Category University
GOALS of Walkthrough
The University of Lahore
A “W4” Category University
Key Characteristics of Walkthrough
1. The main purposes are learning & understanding the product 2. Defect finding.
The University of Lahore
A “W4” Category University
Technical Review
“A peer group discussion activity that focuses on
achieving consensus on the technical approach to be
taken.”
The University of Lahore
A “W4” Category University
A technical review is a form of peer review in which "a team of qualified personnel ... examines the suitability of the software product for its intended use and identifies discrepancies (difference between two things that should be same) from specifications and
standards.
The University of Lahore
A “W4” Category University
1. Software product" normally refers to some kind of technical document. This might be a software design document or program source code, test case specifications, and a variety of other technical documentation, may also be subject to technical review.
2. Technical review differs from software walkthroughs in its specific focus on the technical quality of the product reviewed.
The University of Lahore
A “W4” Category University
Key Characteristics of Technical Review
1. It is a document defect-detection process that involves
peers and technical experts.
2. It is often performed as a peer review without
management participation.
The University of Lahore
A “W4” Category University
GOAL of Technical Review
1. Establish consistency in the use and representation of technical concepts.
2. Ensure, at an early stage that technical concepts are used correctly.
The University of Lahore
A “W4” Category University
Inspection
1. It is the most formal review type.
2. The document under inspection is prepared and checked thoroughly by the reviewers, comparing the work product with its source and other referenced documents.
The University of Lahore
A “W4” Category University
Goals of Inspection
1. Help the author to improve the quality of the document under inspection.
2. Improve product quality.
3. Create common understanding by exchanging information among the inspection participants.
4. Train new employees in the organization’s development process.
The University of Lahore
A “W4” Category University
Characteristics of Inspection
1. It is usually lead by a trained moderator. 2. It is a most formal review type.
3. It involves peers to examine the product. 4. Product is examined and defects are found.
5. The defects found are documented and logged.
