Documentation of modules of a production line software

Abstract

This thesis investigates the documentation of a Production Line Software for type, quality and structure. A documentation scheme for the Production Line Software is created with the documentation scheme of the software documentation tool UniMoDoc. The created documentation scheme is used for a post documentation for a selected part of the Production Line Software. A case study is processed with the post documented UniMoDoc document which is verified for the utility of the documentation scheme. Additional interviews to the case study allow an evaluation of the documentation scheme, which lead to the result of this thesis. This thesis aims an abstract documentation scheme to understand the overlapping functionalities of software modules. An abstract documentation procedure is used in this thesis instead of a pure source code documentation procedure.

Die Bachelorarbeit untersucht Dokumentationen einer Produktionslinien-Software auf Art, Qualität und Struktur. Gemeinsam mit dem Dokumentationsschema des Dokumentationswerkzeuges UniMoDoc wird ein Dokumentationschema für diese Produktionslinien-Software ausgearbeitet und für einen ausgewählten Teil der Software in Form einer Nachdokumentation angewendet. Mit der erstellten Dokumentation wird eine Fallstudie durchgeführt, welche die Nützlichkeit des Dokumentationsschemas überprüft. Zusätzliche Interviews zur Fallstudie ermöglichen eine Evaluation des Dokumentationsschemas, die zum Ergebnis der Bachelorarbeit führen. Diese Bachelorarbeit zielt auf eine abstraktere Form der Dokumentation ab, um die übergreifenden Funktionsweisen von Software Modulen zu verstehen. Es wird kein reines Quellcode Dokumentationsverfahren behandelt.