tapir facilitates the developer to write comprehensive and maintainable tests. However, additional documentation might help other developers, test managers and stakeholders to understand the purpose of a test suite, class or step. tapir provides a set of annotations which might be useful for providing an informative documentation.
|Annotation||Description||Test suite||Test class||Test class parameter||Test step||Test step parameter|
|@Title||Provides a title/headline for the annotated element. It describes the behaviour of the annotated element more abstract than @Description.|
Describes the behaviour of the annotated element more detailed than @Title.
|@Issues||Provides the possibility to link the annotated element with an issue tracker.|
|@Tags||Helps structuring your test suites and classes|
Beside documenting the source code the information can be included in reports in order to get to know what the certain test suites and classes did without looking at the source code.