Description

TDOC (Testing DOCumentation) is a tool that simplifies the generation of testing documentation.
TDOC generates test case documentation automatically in a javadoc-like style. Developers just surround each test case by doc comments and keywords in a way similar to the way comments and block taglets surround methods and functionalities in Java source code. TDOC automatically parses and processes these elements to generate HTML testing documents.
TDOC may support developers and users during the documentation task.
TDOC is simple to install, simple to use and simple to customize.

Download factsheet about trustworthiness in FLOSS products for deeper understading

Download the T-DOC factsheet for further information

Pre-conditions and requirements

There are no special requirements for using T-DOC. A basic understanding of FLOSS, testing methodologies and the Java programming language is a definite advantage.

Associated documentation

• For T-DOC Summary: Definition of standard test approaches, test suites, and benchmarks of Open Source Software
• For T-DOC details and Experimentation Results: Test suite and benchmarks for the chosen set of Open Source projects and artifacts. Methodology for creating test suites and benchmarks for arbitrary systems

Download

The T-DOC tool can be downloaded here.

Learned lessons

The lessons learned, coming from the application of the tool to generate the testing documentation of MacXim, show that it is possible to automatically generate testing documentation with a small effort. FLOSS developers can exploit the T-DOC tool to support their daily testing activities.

Maturity Level (1-5)

About the architecture: 4

Adjustments in the architecture may be necessary. T-DOC will be tuned over-time following the evolving needs of FLOSS stakeholders.

About the tool: 2
Currently, the core engine of the T-DOC architecture is implemented and available. Other components of the architecture can be implemented. We hope that a FLOSS community around T-DOC can arise to support us in implementing new components of T-DOC.

Contact

Davide Tosi – University of Insubria 

Email: