Dokumentation von Software im Wiki System | Konzeption und Entwicklung eines PlugIns für das Enterprise Wiki System Confluence der Firma Atlassian zum dynamischen Laden von JavaDoc-Informationen

Jede Phase des Softwareentwicklungsprozesses basiert auf einer Form von Dokumentation, gleichzeitig kann innerhalb der Phasen neuer Dokumentationsbedarf entstehen. Zu Beginn eines Entwicklungsprozesses werden grundsätzlich der Aufbau und die von der Software künftig zu erbringende Leistung dokumentiert. Das geschieht oft in Form eines Fachkonzepts, auch Lastenheft genannt. Aus diesem Dokument wächst eine Technische Spezifikation (das Pflichtenheft), welches die Sachverhalte des Fachkonzeptes aus technischer Sicht beschreibt. Auf dieser Basis wird die Software entwickelt. Der Softwareentwickler beschreibt den von ihm entwickelten Code mit Hilfe von Kommentaren direkt im Quellcode und lässt daraus mit geeigneten Tools ein Entwicklerhandbuch erzeugen. Dieser Prozess wird oft streng sequentiell durchlaufen. Auch wenn Änderungen und neue Erkenntnisse inkrementell gepflegt werden, gehen Zusammenhänge zwischen den Dokumenten, also Sachverhalte innerhalb der Dokumente, die sich auf Sachverhalte anderer Dokumente beziehen, schnell verloren. Es ist daher wünschenswert, bessere Bezüge zwischen den einzelnen Dokumentationsstufen herzustellen.