German Title: Dokumentation von Entscheidungen in der Implementierungsphase durch Codeannotationen

Preview

PDF, English - main document Download (2MB) | Lizenz: Documentation of Decisions During the Implementation Phase Through Code Annotations von Kühlwein, Arthur steht unter einer Creative Commons Attribution-NoDerivatives 3.0 Germany

Abstract

Many decisions which are made during the implemetation phase of software projects are documented either not at all or through unstructured comments within the source code. This makes the rationale, i.e. the underlying issue with its context, alternative solutions and criteria behind the decision implicit. As a consequence, reproducing the decision later on becomes very difficult. It is thus necessary to make as much of this decision knowledge as possible explicit, since decisions made during the earlier stages are frequently re-evaluated, changed or discarded during the evolution of a software project. This thesis investigates the possibilities and limitations of documenting decision knowledge through annotations in the source code within the Eclipse IDE. For this, an annotation schema is developed and implemented as an Eclipse plug-in. It is investigated, how this schema can be made flexible in the sense that project-specific adjustments to the structure of the decision knowledge should be possible with as less time and effort as possible. Also, annotated decisions are mapped to and kept consistent with an external UNICASE documentation.

Translation of abstract (German)

Viele Entscheidungen, die innerhalb der Implementierungsphase von Softwareprojekten getroffen werden, werden oft entweder gar nicht oder nur stichpunktartig in unstrukturierten Kommentaren beschrieben. Dadurch bleibt das Entscheidungswissen, d.h. der Problemkontext mit seinen Alternativen und Kriterien, implizit, was es im Nachhinein sehr schwierig macht, die Entscheidung nachzuvollziehen. Im Rahmen der Softwareevolution werden viele Entscheidungen neu bewertet, verändert oder verworfen. Deshalb ist es notwendig, so viel Entscheidungswissen wie möglich explizit zu machen. Diese Arbeit untersucht die Möglichkeiten und Einschränkungen, Entscheidungswissen über Annotationen im Quellcode der Eclipse IDE zu dokumentieren. Dafür wird ein Annotationsschema entwickelt und als Eclipse Plug-in implementiert. Es wird untersucht, inwieweit das Annotationsschema flexibel verändert werden kann, sodass projektspezifische Anpassungen an der Wissensstruktur mit so wenig Aufwand wie möglich umgesetzt werden können. Ferner werden annotierte Entscheidungen in eine externe UNICASE-Dokumentation überführt und mit dieser konsistent gehalten werden.