Einleitung:
In unzähligen Gesprächen mit unseren Kunden haben wir die größten Herausforderungen in der internen Dokumentation von Software Projekten und dem Quellcode analysiert. Die wichtigsten Informationen und Erkenntnisse haben wir für Sie zusammengefasst.

IST-Zustand:
Die meisten kleinen und mittleren Unternehmen kombinieren vier verschiedene Typen von Dokumentationen:

• Eine manuell erstellte textbasierte Dokumentation in einem Online-Wiki
• Eine automatisch erstellte Doku, z.B. die Klassenstruktur mithilfe von Doxygen
• Die dritten Dokumentationen sind Readme.txt Dateien im Git Repository
• Die vierten Doku’s sind Kommentare direkt im Quellcode.

Der Vorteil dieser Kombination ist, dass jede einzelne davon Ihre Stärken hat und dass die meisten dieser Tools kostenlos erhältlich sind.

Die Nachteile dieser Kombination sind:

• Die Dokumentationen sind verstreut an vielen verschiedenen Orten
• Die Doku‘s sind untereinander nicht verlinkt
• Deswegen müssen Entwickler oft & längere Zeit verschiedene Quellen durchsuchen, um die Informationen zu finden
• Die visuelle Dokumentation der Software Architektur nach dem C4-Modell fehlt meist komplett

Die anderen Kapitel im eBook:

• Warum ist die Dokumentation von Softwareprojekten wichtig?
• Was macht eine wirklich gute Dokumentation aus?
• Warum Softwareentwickler nur ungern Dokumentationen schreiben:
• Wie man die Probleme jetzt löst – einfache und klare Handlungsempfehlungen:
• Visuelle Dokumentation der Architektur: Was ist das C4-Modell?
• Softwarearchitekturprogramme im Vergleich: