News & Blog

XITASO Tech Talk: „sprintDoc: Agile Dokumentation“

06.04.2017 | Entwicklerblog

Dokumentation kommt in agilen Softwareprojekten oftmals zu kurz. Mit dieser Problematik beschäftigt sich Stefan Voigt von der Otto-von-Guericke-Universität Magdeburg im Forschungsprojekt sprintDoc. In seinem Tech Talk hat Voigt den Entwicklern von XITASO das Projekt vorgestellt.

STEFAN VOIGT

Diplom-Wirtschafts-Informatiker Stefan Voigt von der Otto-von-Guericke-Universität Magdeburg setzt sich seit 2015 im sprintDoc-Forschungsprojekt mit dem Problem geeigneter Dokumentation in agilen Projekten auseinander.

Auf Einladung von XITASO hat Stefan Voigt das sprintDoc-Forschungsprojekt vorgestellt. Ziel des Projekts ist es, eine Methode mit dazugehörigen Werkzeugen schaffen, um die Dokumentation in der agilen Entwicklung v.a. in kleinen und mittleren Softwareunternehmen handhabbar zu machen. Besonders in kleineren Unternehmen besteht nämlich die Gefahr, dass wegen unzureichender Dokumentation Wissen und Erfahrungen aus vergangenen Projekten verloren gehen bzw. ungenutzt bleiben.

Da es aktuell nur wenige spezielle Dokumentationstools für die agile Entwicklung gibt, haben die Projektbeteiligten von sprintDoc zunächst eine Bedarfsanalyse durchgeführt, um auf dieser Basis eine Dokumentationsmethode und Werkzeuge zu entwickeln. Ihre agile Dokumentationsmethodik wurde dann bei zwei kleineren Softwareunternehmen getestet und evaluiert. Schwerpunkte bei dieser Methode sind dabei die Integration in die Werkzeuglandschaft, flexible Strukturen, intelligente Verknüpfung und synchronisierbare Wiki-Instanzen. Als Werkzeuge nutzen die Forscher von sprintDoc ein strukturiertes Wiki, Git, IDE und JIRA. Softwareentwickler und Projektverantwortliche haben somit ein flexibles Dokumentationsstruktursystem zur Verfügung, mit dessen Hilfe jedes Projekt angemessen dokumentiert werden kann. Dabei sind Art und Umfang der Dokumentation nicht im Vorhinein festgelegt, sondern werden von Projekt zu Projekt angepasst, da sich die jeweiligen Dokumentationsziele unterscheiden können. Bevor die Methode zur Anwendung kommt, müssen die Entwickler oder Projektverantwortlichen also definieren, was und in welchem Umfang dokumentiert werden soll.

Take home message:

Obwohl Dokumentation in agilen Projekten keinen Vorrang hat, kann sie dazu dienen, Wissen und Erfahrungen so festzuhalten, dass es zu keinem Wissensverlust kommt. Dabei muss zu Beginn jedes Projekts intern und in Abstimmung mit dem Kunden festgehalten werden, was genau in welcher Art und in welchem Umfang dokumentiert werden soll. Als funktionierende Werkzeuge haben sich im sprintDoc-Projekt ein strukturiertes Wiki, Git und JIRA erwiesen. Bei XITASO greifen wir deshalb neben Git auf die Atlassian Toolchain mit Confluence und JIRA, die wir bereits seit 2012 nutzen, zurück.