6.5    Fazit

Dokumentation ist ein wichtiger Bestandteil der Softwareentwicklung, macht jedoch nicht so viel Spaß wie das Schreiben von produktivem Code für neue Features. Deshalb wird Dokumentation oft entweder nicht verfasst oder nur in ungenügendem Ausmaß. Noch schlimmer wird die Situation, wenn bei einer Änderung am Code die Dokumentation nicht aktualisiert wurde, da dies zu einem Vertrauensverlust bei den beteiligten Entwicklern führen kann. In diesen Situationen können Sie KI-Werkzeuge nutzen, die Ihnen helfen, die Dokumentation zu erzeugen und auf einem aktuellen Stand zu halten. Bei den verschiedenen Arten von Dokumentationen müssen Sie Ihre Prompts bei Bedarf etwas anpassen und der KI ausreichend Kontext zur Verfügung stellen.

Fangen Sie gerade erst damit an, Dokumentation generieren zu lassen, testen Sie verschiedene Werkzeuge. Die verschiedenen Hilfsmittel unterscheiden sich in der Art der Anwendung und auch in der Qualität der Ergebnisse. Wählen Sie das Werkzeug aus, das am besten zu Ihnen, Ihrer Applikation und Ihrem Workflow passt.

Dokumentation automatisiert ändern

Im Kapitel 10, »Code automatisiert verarbeiten«, beschäftigen wir uns mit der Frage, wie weit es möglich ist, eine ganze Sammlung von Dateien eines Projekts automatisiert mit Kommentaren auszustatten oder die Dokumentation von Deutsch auf Englisch umzustellen. So viel vorweg: Je kleiner die Code-Dateien, desto besser sind unsere Resultate ausgefallen.