Verwaltung von Testinformationen in der Moduldokumentation

Abstract

Softwaresysteme werden typischerweise in Module unterteilt. Alle relevanten Daten eines Moduls werden in dessen Moduldokumentation, welche ein Teil der Softwarearchitekturdokumentation darstellt, festgehalten. Zu den Daten zählen unter anderem die Testinformationen des Moduls. Softwarearchitekturdokumentationen werden ihrerseits üblicherweise über Textverarbeitungswerkzeuge oder Wikis erstellt. Beide Werkzeugklassen sind für diese Aufgabe jedoch nicht uneingeschränkt geeignet. Daher wird in dieser Diplomarbeit ein Werkzeug entwickelt, das auf die Softwarearchitekturdokumentation – insbesondere der Moduldokumentation – zugeschnitten ist. Im Werkzeug können Dokumente und Dokumentteile über Vorlagen erstellt werden. Für die Dokumentteile, in denen die Testinformationen eines Moduls verwaltet werden sollen, wird in dieser Arbeit eine spezielle Vorlage vorgeschlagen und für das Werkzeug umgesetzt. Die Vorlage enthält Abschnitte, in denen alle relevanten Testinformationen entweder direkt angegeben oder referenziert werden können. Des Weiteren wird ein Konzept entworfen und durch das Werkzeug umgesetzt, mit welchem die Beziehungen, die in der Softwarearchitekturdokumentationen existieren, explizit definiert und visualisiert werden können. Ein Beispiel für solche Beziehungen sind die zwischen den referenzierten Testinformationen: Z. B. Testfallprotokoll P protokolliert einen Testlauf von Testfall F. Das Werkzeug wird abschließend evaluiert.

Software systems are typically divided into modules. All relevant data of a module are documented in its module documentation. Among other things, these data include the test information of the module. The module documentation itself is part of the overall software architecture documentation. Software architectures are usually documented with word processors or wikis. However, both kinds of those tools are not fully sufficient for this task. Therefore, this diploma thesis develops a tool, which is specialized for documenting software architectures and modules. The tool provides functionality to create documents and their parts based on templates. This thesis provides a special template for those parts of the document, which concern the test of modules. The template contains sections for all relevant test information. The test information may be named directly or may be reffered to. Furthermore, the thesis provides a concept to explicitly define and visualize the relations, which exist in the software architecture documentation. An example for such relations are those between the test information which were reffered to, e.g., test protocol P protocols a test run of test case C. The concept is realized within the tool. Finally, the tool is evaluated.