Test Documentation

What is mean by the test documentation?

It is the documented artifacts, which are prepared and evolved, before and during the testing phase. These documented objects, generally works as the manual, for the guidance purpose and carrying out the testing process for a particular software product, in the specific direction.

Test documentation, is all about clearly and specifically defining the whole testing process along with the resources required, to perform testing on a particular software product, in a written format.

Why documentation for testing is necessary?

Documentation of the process ensures the proper and systematic execution of the activities involved in that process. Everything needs to be documented, as it is not impossible, to memorize, each and everything, over a longer period of time. It is pertinent, to mention that, documentation is a broad term, which not only guides the testing process, but also directs the whole development process, from starting to end.

Moreover, it ensures the coverage of each functionality and aspect of the software product. Documentation acts as the one stop solution to the various queries, related to the testing of the software product such as

  • What are the requirements, such as business or functional requirements?
  • How to carry out testing?
  • Which approach or strategy will work best for a particular software product?
  • What needs to be tested?
  • Which scenario, and accordingly test cases, should be considered?
  • Types of testing techniques, required.

Further, logging and reporting of the bugs, found after the successful execution of the test cases, are also being documented, so as to preserve them, for the future(if required) and providing explanation of the whole testing process and defects found, along with the possible solutions, to the client and other teams.

What is covered under the test documentation?

Generally, the documentation part of the testing, may comprise of following artifacts:

  1. Test Plan:

    It is the most important part of the test documentation, as it involves gathering of the requirements, such as business requirements and functional requirements, along with its complete study and analysis. Objectives are defined, and resources, such as tools, manpower, etc. along with the risks associated with the software, are being identified. Responsibilities are being assigned.

  2. Test Cases

    It involves the preparation of the test cases, specific for one or more than one functionality or features, based on the requirements. Test cases may be considered as the set of specific conditions, environment and inputs, for each functionality and aspect of the software product.

  3. Test Log and Report

    The observations and results of each test case execution, are recorded in the document form, and thereafter, it is being used to generate the reports in a simple and readable format, such as pdf, word, etc.

  4. Traceability Matrix

    Also known by the name of Requirement Traceability Matrix (RTM), this documentation is required to cover and capture all the requirements, with respect to the test cases, in the document form, usually in the table format, so as to ensure the 100% coverage of the requirements, under the test.