Software test documentation: Difference between revisions

Revision as of 10:11, 22 March 2013

Revision as of 09:33, 3 July 2013

Line 3:

{{Portal|Software Testing}}

'''IEEE 829-2008''', also known as the '''829 Standard for Software and System Test Documentation''', is an [[IEEE]] standard that specifies the form of a set of documents for use in eight defined stages of software testing, each stage potentially producing its own separate type of document. The standard specifies the format of these documents but does not stipulate whether they all must be produced, nor does it include any criteria regarding adequate content for these documents. These are a matter of judgment outside the purview of the standard. The documents are:

:*'''[[Test Plan]]''': '''a management planning document''' that shows:

::*How the testing will be done (including SUT (system under test) configurations).

::*Who will do it

::*What will be tested

::*How long it will take (although this may vary, depending upon resource availability).

::*What the test coverage will be, i.e. what quality level is required

:*'''Test Design Specification''': detailing test conditions and the expected results as well as test pass criteria.

:*'''Test Case Specification''': specifying the test data for use in running the test conditions identified in the Test Design Specification

:*'''[[TPS report|Test Procedure Specification]]''': detailing how to run each test, including any set-up preconditions and the steps that need to be followed

:*'''Test Item Transmittal Report''': reporting on when tested software components have progressed from one stage of testing to the next

:*'''Test Log''': recording which tests cases were run, who ran them, in what order, and whether each test passed or failed

:*'''Test Incident Report''': detailing, for any test that failed, the actual versus expected result, and other information intended to throw light on why a test has failed. This document is deliberately named as an incident report, and not a fault report. The reason is that a discrepancy between expected and actual results can occur for a number of reasons other than a fault in the system. These include the expected results being wrong, the test being run incorrectly, or inconsistency in the requirements meaning that more than one interpretation could be made. The report consists of all details of the incident such as actual and expected results, when it failed, and any supporting evidence that will help in its resolution. The report will also include, if possible, an assessment of the impact of an incident upon testing.

:*'''Test Summary Report''': A management report providing any important information uncovered by the tests accomplished, and including assessments of the quality of the testing effort, the quality of the software system under test, and statistics derived from Incident Reports. The report also records what testing was done and how long it took, in order to improve any future test planning. This final document is used to indicate whether the software system under test is fit for purpose according to whether or not it has met acceptance criteria defined by project stakeholders.

The documents are:

*'''Master Test Plan''' (MTP): The purpose of the Master Test Plan (MTP) is to provide an overall test planning and test management document for multiple levels of test (either within one project or across multiple projects).

*'''Level Test Plan''' (LTP): For each LTP the scope, approach, resources, and schedule of the testing activities for its specified level of testing need to be described. The items being tested, the features to be tested, the testing tasks to be performed, the personnel responsible for each task, and the associated risk(s) need to be identified.

:*'''TestLevel DesignTest SpecificationDesig'''n (LTD): detailingDetailing test conditionscases and the expected results as well as test pass criteria. .

:*'''Level Test Case Specification''' (LTC): specifyingSpecifying the test data for use in running the test conditionscases identified in the Level Test Design Specification .

:*'''[[TPSLevel report|Test Procedure Specification]]''' (LTPr): detailingDetailing how to run each test, including any set-up preconditions and the steps that need to be followed.

:*'''Level Test Log''' (LTL): To provide a chronological record of relevant details about the execution of tests, e.g. recording which tests cases were run, who ran them, in what order, and whether each test passed or failed.

:*'''Test IncidentAnomaly Report''' (AR): detailing,To fordocument any testevent that failed,occurs during the actualtesting versusprocess expectedthat result,requires andinvestigation. otherThis informationmay intendedbe tocalled throwa lightproblem, ontest whyincident, adefect, testtrouble, issue, anomaly, or haserror failedreport. This document is deliberately named as an incidentanomaly report, and not a fault report. The reason is that a discrepancy between expected and actual results can occur for a number of reasons other than a fault in the system. These include the expected results being wrong, the test being run incorrectly, or inconsistency in the requirements meaning that more than one interpretation could be made. The report consists of all details of the incident such as actual and expected results, when it failed, and any supporting evidence that will help in its resolution. The report will also include, if possible, an assessment of the impact of an incident upon testing.

*'''Level Interim Test Status Report''' (LITSR): To summarize the interim results of the designated testing activities and optionally to provide evaluations and recommendations based on the results for the specific test level.

*'''Level Test Report''' (LTR): To summarize the results of the designated testing activities and to provide evaluations and recommendations based on the results after test execution has finished for the specific test level.

:*'''Master Test Summary Report''' (MTR): To summarize the results of the levels of the designated testing activities and to provide evaluations based on these results. This report may be used by any organization using the MTP. A management report providing any important information uncovered by the tests accomplished, and including assessments of the quality of the testing effort, the quality of the software system under test, and statistics derived from IncidentAnomaly Reports. The report also records what testing was done and how long it took, in order to improve any future test planning. This final document is used to indicate whether the software system under test is fit for purpose according to whether or not it has met acceptance criteria defined by project stakeholders.

==Relationship with other standards==

Other standards that may be referred to when documenting according to IEEE 829 include: