Test Documentation: What do you mean by Test Documentation?

Great job on starting a new lesson! After reading this lesson, click Next button at bottom right to continue to the next lesson.

What do you mean by Test Documentation?

Test documentation is the documentation or creation of artifacts before or during the software testing. Documentation helps you to estimate testing effort, compute test coverage, do resource tracking, find test execution progress, etc. Also, it provides a systematic approach to software testing and acts as training material for new testers. Test documentation includes a variety of documents such as test policy, test strategy, test plan, test case, test data, defect report, test summary report, etc.

What are the types of Test Documentation: examples

• Test policy: It describes the testing goals, principles, methods of an organization. It defines the scope and standards of testing activities and the roles and responsibilities of the testing team.
• Test strategy: It identifies the test levels (types) to be executed for a project. It outlines the test objectives, test approach, test techniques, test tools, test environment, test deliverables, etc.
• Test plan: It is a detailed document that has the scope, approach, resources, schedule, etc. of software testing activities. It also specifies the entry and exit criteria, risk analysis, contingency plan, etc.
• Test case: It has a group of input values, execution preconditions, test steps, expected results, output values and post-conditions.
• Defect report/ Bug report/ Issue report: It is a report of any flaw in the software, such that the system fails to perform its expected function. Defect report contains the defect description, defect severity, defect priority, defect status, defect resolution, etc.
• Test summary report: It is a high-level document that summarizes the testing activities done and the test results. It also contains the test metrics, test coverage, test issues, test recommendations, etc.

Tips for test documentation

• You should start test documentation in the initial phase of the project, in parallel with the development process.
• Document what is needed for you to understand your work and what you need to produce to your stakeholders. Avoid unnecessary or redundant information, to reduce documentation effort or inconsistency.
• Use version control to manage and track your test documents and avoid duplication.
• Update the test documentation whenever there are significant changes in the requirements or design of the software system
• Follow the standards and guidelines of your organization and project for creating and maintaining test documentation.

FAQ (interview questions and answers)

1. What is the difference between a test scenario and a test case?
   A test scenario is a situation that could be verified by one or more test cases. A test case is a group of input values, execution preconditions, test steps, expected results, output values and post-conditions that validates a test scenario.
2. What is the purpose of a requirement traceability matrix (RTM)?
   It is a document that connects the requirements to the test cases. It helps to ensure that all the requirements are covered by at least one test case and helps to track the changes in requirements or test cases.
3. What are some common types of test documents?
   Test policy, Test strategy, Test plan, Test case, Test data, Defect report and Test summary report.

Remember to just comment if you have any doubts or queries.