„Mein Code ist selbsterklärend.“ – Einer der teuersten Sätze in der IT. Sauberer, gut strukturierter Code ist wichtig. Aber er ersetzt keine Dokumentation. Diese Lektion lernen viele Teams auf die harte Tour.
Was heute selbsterklärend wirkt, ist es in 6 Monaten nicht mehr – nicht für andere Entwickler, und oft auch nicht für sich selbst. Komplexe Businesslogik, Workarounds für Systemgrenzen, bewusste Architekturentscheidungen: All das gehört dokumentiert.
In meinen Projekten setze ich auf drei Ebenen: Inline-Kommentare für das „Warum“ (nicht das „Was“), Docstrings für Funktionen und Klassen, und ein übergreifendes technisches Dokument für Architekturentscheidungen. Das klingt nach Mehraufwand – spart aber langfristig erheblich Zeit und Geld.