Test Documentation (IEEE 829)
IEEE 829-2008 provides the standard structure for software test documentation. This page covers the Master Test Plan structure, tailoring guidelines, and the “addressed” principle.
Master Test Plan Structure
The Master Test Plan (MTP) provides the overarching test management structure [1]:
Part 1: Introduction
| Section | Content |
|---|---|
| Identifier | Unique document identifier |
| Scope | What is and isn’t covered |
| References | Related documents |
| System Overview | High-level description of system under test |
| Test Overview | Schedule, resources, responsibilities, tools/methods |
Part 2: Details
| Section | Content |
|---|---|
| Test Processes | How testing will be conducted |
| Test Levels | Component, integration, system, acceptance |
| Documentation Requirements | What documents will be produced |
| Administration | How testing will be managed |
| Reporting | How results will be communicated |
Part 3: General
| Section | Content |
|---|---|
| Glossary | Definitions of terms |
| Change Procedures | How plan changes are handled |
| Version History | Document revision history |
Level Test Plans
Each test level (component, integration, system, acceptance) has its own Level Test Plan (LTP) containing:
- Test Items — What will be tested
- Features to Test — Specific features covered
- Features Not to Test — Excluded features with rationale
- Approach — Testing techniques and methods
- Pass/Fail Criteria — How success is determined
- Suspension/Resumption Criteria — When to pause/restart
- Environmental Needs — Hardware, software, tools required
The “Addressed” Principle
All topics must be formally decided: include, record in tool, or exclude with rationale. [1]
For each required topic, you must:
| Option | Meaning |
|---|---|
| Include | Document the information in the plan |
| Record in Tool | Reference where information is stored (e.g., in test management tool) |
| Exclude with Rationale | Explicitly state why not applicable |
Never leave topics unaddressed.
Integrity-Level Mapping
Documentation depth should be commensurate with criticality [1]:
| Integrity Level | Documentation Depth |
|---|---|
| High (safety-critical) | Full documentation, formal reviews |
| Medium | Standard documentation |
| Low | Abbreviated documentation allowed |
Tailoring Guidelines
Combine documents when:
- Project is small
- Single test level
- Resources limited
Separate documents when:
- Project is complex
- Multiple teams involved
- Regulatory requirements
Reference existing data:
- Avoid duplication by referencing PM plans, QA plans
- Use hyperlinks to related documents
IEEE 829 Outline
Standard test plan sections:
- Test Plan Identifier
- Table of Contents
- References
- Glossary
- Introduction
- Test Items
- Software Risk Issues
- Features to Be Tested
- Features Not to Be Tested
- Approach
- Item Pass/Fail Criteria
- Suspension Criteria and Resumption Requirements
- Test Deliverables
- Testing Tasks
- Environmental Needs
- Responsibilities
- Staffing and Training Needs
- Schedule
- Planning Risks and Contingencies
- Approvals
Iterative Updates
Update plans when requirements change. [1]
Test documentation is living documentation:
- Review at each milestone
- Update when scope changes
- Re-baseline after major changes
- Track version history
References
- IEEE, IEEE Std 829-2008: IEEE Standard for Software and System Test Documentation, New York, NY., 2008.
Disclaimer: AI is used for text summarization, polishing and explaining. Authors have verified all facts and claims. In case of an error, feel free to file an issue.