SEM Structured Walkthrough Process Guide
SEM Structured Walkthrough Process Guide
October 2014
Version 1.3
Revision History
REVISION HISTORY
October 1014 State of Michigan Structured Walkthrough (SWT) Process Guide Page i
Preface
PREFACE
The initial development of the Structured Walkthrough Process Guide was published in August 2007, and was
developed as part of a continuing effort to improve the quality, performance, and productivity of State of
Michigan information systems. Development of the Process Guide was governed by the Michigan State Unified
Information Technology Environment (SUITE) initiative. This update incorporates revisions to the templates
associated with the Structured Walkthrough process.
The purpose of SUITE is to standardize methodologies, procedures, training, and tools for project management
and systems development lifecycle management throughout the Department of Technology Management and
Budget (DTMB) in order to implement repeatable processes and conduct development activities according to
Capability Maturity Model Integrated (CMMI) Level 3 requirements. A formal enterprise level support structure
will be created to support, improve and administer all SUITE components, including the System Engineering
Methodology (SEM), the SMG, the Project Management Methodology (PMM) and related enterprise initiatives.
Until that structure is in place, questions regarding this process guide should be sent to the SUITE Core Team at
SUITE@michigan.gov.
October 1014 State of Michigan Structured Walkthrough (SWT) Process Guide Page ii
Table of Contents
TABLE OF CONTENTS
October 2014 State of Michigan Structured Walkthrough (SWT) Process Guide Page iii
Table of Contents
October 2014 State of Michigan Structured Walkthrough (SWT) Process Guide Page iv
Table of Contents
October 2014 State of Michigan Structured Walkthrough (SWT) Process Guide Page v
Chapter 1.0 - Overview
Organization
This process guide consists of the following sections:
Overview
Responsibilities Before the Walkthrough
Responsibilities During the Walkthrough
Responsibilities After the Walkthrough
Additional Activities After the Walkthrough
Structured Walkthroughs for Lifecycle Stages
Structured Walkthroughs for Other Documents
Description
A structured walkthrough is an organized procedure for a group of peers to review and discuss the technical
aspects of software development work products. The major objectives of a structured walkthrough are to find
errors and to improve the quality of the product. Errors typically occur as omissions or contradictions, flaws in
logic, or inconsistencies in the work product style (e.g., poorly stated requirements and inefficient code).
Structured walkthroughs should not be used to discuss solutions for the errors that are found. The basic purpose
of a walkthrough is error detection, not error correction. When the walkthrough is completed, the author of the
work product is responsible for taking the necessary actions to correct the errors. The author may hold private
conversations with reviewers or conduct follow-up meetings to discuss potential solutions.
Structured walkthroughs should be conducted during all stages of the system lifecycle. Walkthroughs can be
conducted in various formats, with various levels of formality, and with different types of participants.
In some cases, it might be useful and expedient to include end users in walkthroughs. Management
representatives do not participate in structured walkthroughs. Regardless of the variations in format and
participants, the basic activity (peer review) and the major objectives (find errors and improve quality) of the
structured walkthroughs remain the same.
General Information
Structured walkthroughs are appropriate for reviewing the technical accuracy and completeness of system
development work products, project management tools, and other types of documents (e.g., technical operating
October 2014 State of Michigan Structured Walkthrough (SWT) Process Guide Page 1
Chapter 1.0 - Overview
procedures). The walkthroughs should be scheduled to review small, meaningful pieces of work. The progress
made in each lifecycle stage should determine the frequency of the walkthroughs.
Benefits
Structured walkthroughs provide the following benefits.
Save time and money by finding and correcting errors earlier in the lifecycle.
Provide value-added input from reviewers with different technical backgrounds, experience, and
expertise.
Validate and improve the related lifecycle work products.
Keep the project team informed of the development progress.
Provide professional growth to participants by giving them an opportunity to look at different
development methodologies and approaches.
Participants
Each participant in the structured walkthrough process has a specific role. For a small size project, a person may
fulfill multiple roles.
The author of the work product is responsible for requesting the walkthrough when a meaningful portion of the
product has been developed and is free from casual errors (e.g., spelling errors). The author attends the
walkthrough as an observer and answers reviewer's general questions. The author is not a reviewer.
The presenter usually develops the agenda for the walkthrough and presents the work product being reviewed.
The presenter should be familiar with the work product and be a member of the project team.
The moderator facilitates the walkthrough session, ensures that the walkthrough agenda is followed, and
encourages the participation of all reviewers. The moderator may also be the scribe.
The reviewers evaluate the work product to determine if it is technically accurate. The reviewers also assess
whether the project guidelines or standards are being followed, the project requirements are met, and the
product is properly prepared.
The scribe takes notes during the walkthrough. The scribe records the errors identified and any other technical
comments, suggestions, and unresolved questions. The scribe should not be a reviewer.
The Analysis tab contains three pivot tables titled Defect Analysis (total), UAT Defect Analysis, and Production
Defect Analysis. These pivot tables collect data from the previous tabs and generate defect summary information
by:
October 2014 State of Michigan Structured Walkthrough (SWT) Process Guide Page 2
Chapter 1.0 - Overview
The Summary tab summarizes the information from the pivot tables on the Analysis tab: Defect Tally Summary,
UAT Tally Summary, and Production Tally Summary. These summaries provide counts of defects by Status type.
While the N/A and Future Release summary counts are displayed, they are not included in the net defect totals.
A copy of the Defect Tracking Log is available electronically on the DTMB SUITE website. The Defect Tracking Log
has been developed for teams that do not have an acceptable method for recording and tracking defects.
Meeting Record
The Structured Walkthrough Meeting Record (SEM-0187) is completed during the formal SWT meeting to
capture SWT information such as attendees and SWT date information. The Meeting Record is finalized after the
meeting and includes the recording of defect summary totals. The Meeting Record is used during each stage of
the software lifecycle will be checked during the Stage Exit process. The Meeting Record is also used by Quality
Assurance to maintain statistical data on structured walkthroughs. The presenter is responsible for the
preparation of the Structured Walkthrough Meeting Record. A copy of the Structured Walkthrough Meeting
Record is available electronically on the DTMB SUITE website.
Implementation
This procedure describes a formal structure for conducting walkthroughs. The formality and structure of the
walkthrough sessions should be tailored to meet the needs of the development team, and the purpose and
scope of the work product.
Note
The Structured Walkthrough procedure is a Maturity Level 3 Key Process Area of the SEI Software Capability
Maturity Model Integration (CMMI) model.
October 2014 State of Michigan Structured Walkthrough (SWT) Process Guide Page 3
Chapter 2.0 - Responsibilities Before the Walkthrough
Step Activity
Complete a meaningful segment of a work product. Avoid requesting walkthroughs on
1 incomplete segments or on a segment(s) that is too large to be adequately reviewed in
less than 2 hours.
Proofread work product segment and eliminate non-technical errors such as spelling or
2 typographical mistakes. Non-technical errors can distract reviewers from the technical
aspects of the work product.
Notify the presenter that a completed segment of a work product is ready for a
3 structured walkthrough. May also discuss potential reviewers with the presenter.
Prepare any support materials, such as flow charts, to assist reviewers with their
4 understanding of the entire work product and how the segment being reviewed fits into
the entire product.
Provide the work product and all support materials to the presenter for advance
5 distribution to the reviewers.
When the segment to be reviewed is finished, the author should be prepared to work on
6 other segments of the work product (or other project tasks) while waiting for the
walkthrough to occur.
Presenter's Responsibilities
Prior to the walkthrough session, the presenter must:
Step Activity
Determine if the size of the work product segment is appropriate for one walkthrough
session; walkthrough sessions should not exceed 2 hours in length. If more time is
1 necessary, the work product segment should be divided into smaller portions and each
portion reviewed separately.
Select reviewers who are appropriate for the work product, such as systems analysts,
programmers, technical writers, and testers. Reviewers should include people on and off
the project. In some cases, the participation of software users may be considered
2
desirable. If necessary, the presenter can discuss who should participate in the
walkthrough with the manager of the project team.
Select the moderator and the scribe. Determine whether the scribe will be responsible for
3 completing the Structured Walkthrough Meeting Record (SEM-0187) and the Defect
Tracking Log (SEM-0186).
Schedule the meeting date, time, and location. Notify all participants of these
4 arrangements at least two days prior to the walkthrough.
Establish the agenda. Review the agenda and any important issues with the moderator.
5
October 2014 State of Michigan Structured Walkthrough (SWT) Process Guide Page 4
Chapter 2.0 - Responsibilities Before the Walkthrough
6 Provide reviewers with copies of all materials to be reviewed at least 2 days prior to the
walkthrough.
Reviewers’ Responsibilities
Prior to the walkthrough session, the reviewers must:
Step Activity
Carefully review the materials provided by the presenter. Make a note about the amount
1 of time spent reviewing the material. Give this information to the scribe at the beginning
of the walkthrough session.
Identify technical errors. Insert comments and questions directly on the review materials
2 for easy reference during the walkthrough discussion.
Note directly on the review materials any non-technical errors found during the review,
3 such as spelling or typographical mistakes. While these errors are not discussed during
the walkthrough, they should be provided to the author at the conclusion of the
walkthrough.
Notify the presenter immediately if the reviewer will not be able to complete the review
4 in time for the walkthrough session. An unprepared reviewer will hinder the walkthrough
process. If enough time is available, the presenter can select a new reviewer.
Review the procedures for the structured walkthrough process. Each reviewer should be
5 familiar with the procedures prior to participating in a walkthrough session.
Step Activity
1 Review the materials provided by the presenter to become familiar with the contents.
2 Review the agenda and discuss any questions with the presenter.
Note directly on the review materials any non-technical errors found during the review,
such as spelling or typographical mistakes. While these errors are not discussed during
3 the walkthrough, they should be provided to the author at the conclusion of the
walkthrough.
Review the procedures (ground-rules) for the structured walkthrough process. Clarify
4 specific roles and responsibilities with the presenter. The moderator and scribe should be
familiar with the procedures prior to participating in a walkthrough session.
October 2014 State of Michigan Structured Walkthrough (SWT) Process Guide Page 5
Chapter 3.0 - Responsibilities During the Walkthrough
Step Activity
Call the walkthrough session to order. It is important to start the session at the scheduled
1 time.
Ask participants to introduce themselves and state their current responsibility/job
2 assignment.
3 Briefly review the procedures and agenda for the walkthrough session.
Facilitate the walkthrough session. Every attempt should be made to adhere to the
agenda and the established meeting procedures.
If the session exceeds 2 hours, the moderator should stop the session at a logical
breaking point and schedule another session to continue the discussion. When
walkthrough sessions exceed 2 hours, the productivity and attention span of the
reviewers will be adversely affected.
At the conclusion of the session, ask the reviewers to make a decision about the status of
the work product as follows:
October 2014 State of Michigan Structured Walkthrough (SWT) Process Guide Page 6
Chapter 3.0 - Responsibilities During the Walkthrough
Presenter's Responsibilities
During the walkthrough the presenter is responsible for the following activities:
Step Activity
1 Provide a brief overview of the work product.
2 If necessary, review outstanding issues from previous walkthrough(s).
Present the product to be reviewed. Answer reviewers' questions. The presenter can ask
3
the author for assistance in answering questions.
At the conclusion of the meeting, if the reviewers cannot reach consensus about the
status of the work product, the presenter is responsible for making that decision.
Scribe's Responsibilities
During the walkthrough the scribe is responsible for the following activities:
Step Activity
1 Record the beginning time for the walkthrough session.
2 Record the attendance of each participant.
3 Record the amount of time each reviewer spent reviewing the work product.
Record the technical errors identified by the reviewers. Record all significant comments
4
and suggestions made by the reviewers and presenter.
5 Record suggested action items and other follow-up activities.
6 Record the end time for the walkthrough session.
October 2014 State of Michigan Structured Walkthrough (SWT) Process Guide Page 7
Chapter 3.0 - Responsibilities During the Walkthrough
Reviewers’ Responsibilities
During the walkthrough each reviewer is responsible for the following activities:
Step Activity
1 Provide the scribe with the time spent reviewing the work product.
Provide the appropriate introduction information (e.g., name and current job
2
responsibilities).
Describe technical errors found during review of the work product. Be an active
3
participant.
4 Ask questions as needed to clarify information about the work product.
5 Make constructive suggestions and comments about the work product.
Participate in the decision about the status of the work product:
If consensus cannot be reached by the reviewers, the presenter is responsible for making
the decision.
Inform the author about any non-technical errors found during the review by providing a
7 marked up copy of the review package.
October 2014 State of Michigan Structured Walkthrough (SWT) Process Guide Page 8
Section 4.0 - Responsibilities After the Walkthrough
Step Activity
Prepare the meeting record for the walkthrough session. Include any action items
1 identified by the reviewers and the person/team responsible for completing each action
item.
2 Circulate the meeting record to the participants for their review and comments.
Update the meeting record as needed. Distribute the revised meeting record to the
3 author. Copies of the meeting record should be distributed to the other participants only
if an additional walkthrough is required.
Reviewers' Responsibilities
The reviewers are responsible for the following activities after the walkthrough:
Step Activity
Review the Review the Structured Walkthrough Meeting Record (SEM-0187) and the
1
additions to the Defect Tracking Log (SEM-0186) for accuracy and completeness.
Indicate changes that are needed to add or clarify information in the meeting record.
2
Submit any changes to the scribe. If necessary, discuss discrepancies with the presenter.
If requested by the author of the work product, provide additional explanation of
3
walkthrough comments.
Presenter's Responsibilities
The presenter is responsible for the following activities after the walkthrough:
Step Activity
Review the Review the Structured Walkthrough Meeting Record (SEM-0187) and the
1
additions to the Defect Tracking Log (SEM-0186) for accuracy and completeness.
Indicate changes to the meeting record and return to scribe. If necessary, discuss
2
discrepancies with the reviewers.
Initiate follow-up activities recommended by the reviewers. Verify that all action items
3
have been assigned to the appropriate person/team.
Finalize the Structured Walkthrough Meeting Record. Include the following information:
October 2014 State of Michigan Structured Walkthrough (SWT) Process Guide Page 9
Section 4.0 - Responsibilities After the Walkthrough
Author's Responsibilities
The author is responsible for the following activities after the walkthrough:
Step Activity
1 Make all necessary changes to the work product.
Use the Defect Tracking Log as a checklist to make sure all errors are corrected,
2
reviewer's comments have been addressed, and open issues are investigated.
Check with the presenter and reviewers, as needed, to obtain additional information or
3
clarifications.
Conduct follow-up meetings with subject matter experts, as needed, to complete work
4
product.
5 Prepare work product and participate in follow-up walkthrough, if required.
Step Activity
Prepare a summary of the information contained in the Structured Walkthrough Meeting
1
Record (SEM-0187) and the Defect Tracking Log (SEM-0186).
Distribute the summary to the Project Manager. The data presented in the report is
2
included in periodic management reports.
Project Manager
The Project Manager is responsible for the following activities after the walkthrough.
Step Activity
1 Review the Structured Walkthrough Meeting Record (SEM-0187) and the Defect Tracking
October 2014 State of Michigan Structured Walkthrough (SWT) Process Guide Page 10
Section 4.0 - Responsibilities After the Walkthrough
Log (SEM-0186).
File the Structured Walkthrough Meeting Record in the project management
2
notebook/files.
Follow up on any action items that remain open. A formal plan may need to be
3
developed for action items that cannot be resolved during the current lifecycle stage.
October 2014 State of Michigan Structured Walkthrough (SWT) Process Guide Page 11
Section 5.0 - Additional Activities After the Walkthrough
Project Manager
Quality Assurance Manager
The Meeting Record and Defect Tracking Log is used by Quality Assurance to maintain statistical data on
structured walkthroughs.
The Structured Walkthrough Meeting Records generated during each stage of the software lifecycle will be
checked during the Stage Exit process. The purpose of the Stage Exit Process Guide check is to verify that
structured walkthroughs were conducted during each lifecycle stage, that the walkthrough action items were
documented, and that the action items have been properly resolved and closed.
Follow-up Walkthrough
If a follow-up walkthrough is required, the procedures used in the original walkthrough should be repeated. Use
the meeting record and defect tracking log from the previous walkthrough as a checklist to confirm that the
previously identified errors and issues were resolved.
October 2014 State of Michigan Structured Walkthrough (SWT) Process Guide Page 12
Chapter 6.0 - Structured Walkthrough for Lifecycle Stages
October 2014 State of Michigan Structured Walkthrough (SWT) Process Guide Page 13
Chapter 6.0 - Structured Walkthrough for Lifecycle Stages
The Functional Design Stage selects the design elements that determine how the software product will be
constructed to meet the functional requirements. During the Functional Design Stage, the structured
walkthroughs are used to identify flaws, weaknesses, errors, and omissions in the architecture of the design.
October 2014 State of Michigan Structured Walkthrough (SWT) Process Guide Page 14
Chapter 6.0 - Structured Walkthrough for Lifecycle Stages
The Construction Stage involves the construction of the product or solution and the testing that is an integral
part of the construction process. During this stage, walkthroughs are conducted on deliverables such as
programs, test plans, test cases, and the operating documentation.
Testing Stage
The Testing Stage is the transition from individual software components to an integrated software product.
During the Testing Stage, structured walkthroughs are used to review the integrated product, check the accuracy
of the operating documents that will be provided to the user(s) and programmer(s), and the acceptance
activities.
October 2014 State of Michigan Structured Walkthrough (SWT) Process Guide Page 15
Chapter 6.0 - Structured Walkthrough for Lifecycle Stages
Implementation Stage
The Implementation Stage is the transition from a product or solution in development to a product or system in
full production status. During the Installation Stage, structured walkthroughs are used to check the Acceptance
Test Report and inspect the plans for activities performed in preparation for full-scale production.
October 2014 State of Michigan Structured Walkthrough (SWT) Process Guide Page 16
Section 7.0 - Structured Walkthroughs for Other Documents
Types of verification
When reviewing other types of documents, structured walkthroughs are used to verify the technical and
editorial accuracy and appropriateness of the content and format
Purpose Participants
Reviews for accuracy including the following: Technical experts, technical writer, and
graphics expert.
Consistency
Completeness
Conformance to standards and
guidelines
Style
Grammar and spelling
October 2014 State of Michigan Structured Walkthrough (SWT) Process Guide Page 17