projectdoc Toolbox

Documents the results of a test session for the sponsoring stakeholders.

ID
test-report
Suite
Parent
Documentation Type
Categories
Tags
Since
4.3

A test report summarizes the discoveries of an exploratory test. The test charter defined the context of the journey and the test session collected the information in form of a journal. The test report uses the information in these documents to create a view for the sponsors of the test.

On creation of the test report document you typically do not need to add any information to the wizard. Just click 'Create'! If you change your mind, you may rename the document or edit the short description later.

Note that this document delegates per default to the parent document, which should be a test charter.

Properties

The document type test report provides the following properties:

 

Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.

Sponsors

Specify a list of stakeholders that are interested in the outcome of the exploratory test and therefore sponsor it.

This information is typically synchronized with that of the associated test charter.

Experts

List the names of stakeholders who may provide additional information on the area being examined.

This information is typically synchronized with that of the associated test charter.

Sections

Note that the sections Test Report#Summary, Test Report#Target, Test Report#Reason, Test Report#Discoveries, Test Report#Open Issues, and Test Report#Recommendations are tagged with the keyword 'report'. This makes it easy to transclude these sections in other documents with the help of the Transclusion Macro or the Transclude Documents Macro.

Description

Document the purpose of the test.

Summary

Give a brief executive summary on the result of the test.

Charter

Simply transclude the content from the associated test charter. Per default the transclusion is defined by the delegate document of the Document Properties Marker Macro that is set the parent document this report document has been created for.

Target

Define what has been tested.

Reason

Define why the test has been conducted.

Discoveries

Document what you have discovered that is relevant to the stakeholders concerns.

Open Issues

Point out what is outside of this exploration tour and may have to be covered in additional expeditions.

You may want to use the doctype Open Issue for this information. It is part of the project management add-on, available as open source on Bitbucket.

Recommendations

Give an interpretation of the test result from the testers point of view. Give recommendation how to deal with the result and how to continue from here.

Notes

These are internal notes that are usually not exported and only visible to team members with write access.

But this is not a safe place to store sensible information. It is just a convenience for the reader to not be bothered with notes stored here for the authors for later use. The security level is about suppressing the representation by a CSS style. Therefore consider this as a convenience for the reader, not as a security tool.

 

The text of notes sections is also indexed.

References

For a document the references section contains pointers to resources that prove the statements of the document.

Often these proofs are not easily distinguishable from further information. In this case you may want to skip the reference section in favour for the resource list.

 

For further information please refer to References and Resources.

Resources

The resources section provides references to further information to the topic of the document.

This may be information on the internet provided by the resource or information in the team's information systems. Anything the reader of the resource might want to know, may be listed here.

 

For further information please refer to References and Resources.

Related Doctypes

Quality Scenario
Quality Scenarios document required qualities.
Quality Scenario Type
Quality scenario types categorize quality scenarios.
Test Case
Document a test case of your project.
Test Case Type
Test case types categorize test cases.
Test Charter
Defines a charter to run an exploratory test session.
Test Charter Type
Test charter types categorize test charters.
Test Data
Document data used for test cases.
Test Data Type
Test data types categorize test data.
Test Report Type
Test report types categorize test reports.
Test Session
Defines a document to collect information during a test session.
Test Session Type
Test session types categorize test sessions.