Appendix C IEEE Templates

"Innovate! Follow the standard and do it intelligently. That means including what you know needs to be included regardless of what the standard says. It means adding additional levels or organization that make sense."

— IEEE Computer Society,
Software Engineering Standards Collection

IEEE Templates

For your convenience, we've included in this section all of the IEEE templates (and variations) used in this book. Some templates have been modified based on the experiences of the authors and as described in the text of this book. These changes (additions) are presented in italics. If you delete all of the italicized words in each template, the original IEEE template would remain.

For a complete description of each template, please refer to the corresponding section of the book indicated in the right margin. The complete IEEE guidelines can be purchased from the IEEE Web site at www.ieee.org.

Test Documents

IEEE Std. 829-1998 Standard for Software Test Documentation Template for Test Documents

Contents

1.	Test Plan Used for the master test plan and level-specific test plans.
2.	Test Design Specification Used at each test level to specify the test set architecture and coverage traces.
3.	Test Case Specification Used as needed to describe test cases or automated scripts.
4.	Test Procedure Specification Used to specify the steps for executing a set of test cases.
5.	Test Log Used as needed to record the execution of test procedures.
6.	Test Incident Report Used to describe anomalies that occur during testing or in production. These anomalies may be in the requirements, design, code, documentation, or the test cases themselves. Incidents may later be classified as defects or enhancements.
7.	Test Summary Report Used to report completion of testing at a level or a major test objective within a level.

Figure C-1: Template for Test Documents from IEEE Std. 829-1998 Refer to Chapter 1 for more information.

Test Plan

IEEE Std. 829-1998 Standard for Software Test Documentation Template for Test Planning

Contents

1. Test Plan Identifier
2. Table of Contents
3. References
4. Glossary
5. Introduction
6. Test Items
7. Software Risk Issues
8. Features to Be Tested
9. Features Not to Be Tested
10. Approach
11. Item Pass/Fail Criteria
12. Suspension Criteria and Resumption Requirements
13. Test Deliverables
14. Testing Tasks
15. Environmental Needs
16. Responsibilities
17. Staffing and Training Needs
18. Schedule
19. Planning Risks and Contingencies
20. Approvals

Figure C-2: Template for Test Planning from IEEE Std. 829-1998 Refer to Chapter 3 for more information.

Unit Testing

IEEE Std. 1008–1987 for Software Unit Testing

Contents

1.	Scope and References
	1.1	Inside the Scope
	1.2	Outside the Scope
	1.3	References
2.	Definitions
3.	Unit Testing Activities
	3.1	Plan the General Approach, Resources, and Schedule
	3.2	Determine Features to Be Tested
	3.3	Refine the General Plan
	3.4	Design the Set of Tests
	3.5	Implement the Refined Plan and Design
	3.6	Execute the Test Procedures
	3.7	Check for Termination
	3.8	Evaluate the Test Effort and Unit

Figure C-3: Rick's copy of the Unit Testing Standard Refer to Chapter 4 for more information.

Test Design Specification

IEEE Std. 829-1998 for Software Test Documentation Template for Test Design Specification

Contents

1. Test Design Specification Identifier
2. Features to Be Tested
3. Approach Refinement
4. Test Identification
5. Feature Pass/Fail Criteria

Figure C-4: Test Design Specification Template from IEEE Std. 829-1998 Refer to Chapter 5 for more information.

Test Case Specification

IEEE Std. 829-1998 for Software Test Documentation Template for Test Case Specification

Contents

1. Test Case Specification Identifier
2. Test Items
3. Input Specifications
4. Output Specifications
5. Environmental Needs
6. Special Procedural Requirements
7. Inter-Case Dependencies

Figure C-5: Test Case Specification Template from IEEE Std. 829-1998 Refer to Chapter 5 for more information.

Test Procedure

IEEE Std. 829-1998 for Software Test Documentation Template for Test Procedure

Contents

1.0	Test Procedure Specification Identifier Specify the unique identifier assigned to this test procedure. Supply a reference to the associated test design specification.
2.0	Purpose Describe the purpose(s) of the procedure and refer to the test cases being executed.
3.0	Special Requirements Describe any special requirements such as environmental needs, skill level, training, etc.
4.0	Procedure Steps This is the heart of the test procedure. The IEEE describes several steps listed below:
	4.1	Log Describe any special methods or formats for logging the results of test execution, the incidents observed, and any other events pertinent to the test.
	4.2	Set up Describe the sequence of actions necessary to prepare for execution of the procedure.
	4.3	Start Describe the actions necessary to begin execution of the procedure.
	4.4	Proceed Describe any actions necessary during execution of the procedure.
		4.4.1	Step 1
		4.4.2	Step 2
		4.4.3	Step 3
		4.4.4	Step Z
	4.5	Measure Describe how the test measurements will be made.
	4.6	Shut Down Describe the action necessary to suspend testing when unscheduled events dictate.
	4.7	Restart Identify any procedural restart points and describe the action necessary to restart the procedure at each of these points.
	4.8	Stop Describe the actions necessary to bring execution to an orderly halt.
	4.9	Wrap Up Describe the action necessary to restore the environment.
	4.10	Contingencies Describe the actions necessary to deal with anomalies and other events that may occur during execution.

Figure C-6: Test Procedure Template from IEEE Std. 829-1998 Refer to Chapter 5 for more information.

Test Log

IEEE Std. 829-1998 for Software Test Documentation Template for Test Log

Contents

1. Test Log Identifier
2. Description
3. Activity and Event Entries

Figure C-7: Test Log Template from IEEE Std. 829-1998 Refer to Chapter 7 for more information.

Test Incident Report

IEEE Std. 829-1998 for Software Test Documentation Template for Test Incident Report

Contents

1.	Incident Summary Report Identifier
2.	Incident Summary
3.	Incident Description
	3.1	Inputs
	3.2	Expected Results
	3.3	Actual Results
	3.4	Anomalies
	3.5	Date and Time
	3.6	Procedure Step
	3.7	Environment
	3.8	Attempts to Repeat
	3.9	Testers
	3.10	Observers
4.	Impact
5.	Investigation
6	Metrics
7.	Disposition

Figure C-8: Template for Test Incident Report from IEEE Std. 829-1998 Refer to Chapter 7 for more information.

Test Summary Report

IEEE Std. 829-1998 for Software Test Documentation Template for Test Summary Report

Contents

1.	Test Summary Report Identifier
2.	Summary
3.	Variances
4.	Comprehensive Assessment
5.	Summary of Results
	5.1	Resolved Incidents
	5.2	Unresolved Incidents
6.	Evaluation
7.	Recommendations
8.	Summary of Activities
9.	Approvals

Figure C-9: Template for Test Summary Report from IEEE-829-1998 Refer to Chapter 7 for more information.

Test Plan for Process Improvement

Template for Process Improvement

Contents

1.	Test Plan Identifier
2.	Introduction
	2.1	Genesis of Process Improvement Initiative
	2.2	Scope of Initiative
3.	Planning Risks
	3.1	Schedule
	3.2	Budget
	3.3	Staffing
	3.4	Buy-In
4.	Approach
	4.1	Major Strategy Decisions
5.	Pass/Fail Criteria
	5.1	What constitutes success? How are progress and results measured?
6.	Suspension Criteria
	6.1	What should cause us to temporarily suspend our efforts?
7.	Deliverables
	7.1	Project Status
	7.2	Reports
	7.3	Metrics
	7.4	Post-Project Review
8.	Environmental Needs
	8.1	Hardware and Software
	8.2	Tools
	8.3	Office Space
9.	Staffing and Training Needs
	9.1	In-House
	9.2	Contracted
10.	Responsibilities
	10.1	Team Members
	10.2	Sponsor
	10.3	Champion
	10.4	Training Department
	10.5	Test Environment Group
	10.6	Process Group
11.	Schedule
	11.1	Project Initiative
	11.2	Incremental Milestones
	11.3	Post-Project Review
12.	Approvals
	12.1	Person(s) Approving the Plan

Figure C-10: Test Plan Template MODIFIED for Process Improvement Refer to Chapter 11 for more information.

---

---