Development

Dokumentation ist für Entwickler oft eine Herausforderung, doch durch strukturiertes ,Documentation as Code" kann sie effizienter und nützlicher gestaltet werden. Eine klare Ablage und Gliederung von Informationen ist entscheidend für den Erfolg.

Mit .gitattributes und .gitignore steuerst du, was ins Repository kommt und wie Dateien behandelt werden. Für große Dateien lohnt sich Git LFS, aber nur mit sauberer Konfiguration und klarer Kommunikation im Team.

Eine Software Bill of Materials (SBOM) listet alle Abhängigkeiten und deren Versionen in einem Projekt auf. Sie hilft, Lizenzen und Sicherheitslücken zu verwalten und wird zunehmend gesetzlich vorgeschrieben. Standardisierte Formate wie SPDX und CycloneDX erleichtern die Erstellung und Nutzung von SBOMs.

Die Wiederverwendbarkeit von Code durch gut strukturierte Klassenbibliotheken ist entscheidend für den Software-Entwicklungsprozess. Eine klare Dokumentation und durchdachte Architektur helfen, Spaghetti-Abhängigkeiten zu vermeiden und die Nutzung in Projekten zu vereinfachen

Eine klare Namenskonvention für Azure-Ressourcen erleichtert die Zuordnung und Orientierung in der Cloud-Infrastruktur und hilft sowohl bestehenden als auch neuen Mitarbeitenden, benötigte Ressourcen schnell zu finden.

Bei Änderungen an einer API, die nicht rückwärtskompatibel sind, ist die Versionierung entscheidend, um eine reibungslose Kommunikation mit unterschiedlichen Client-Versionen zu gewährleisten. Eine durchdachte Implementierung hilft, Downtimes zu vermeiden und die Migration schrittweise zu gestalten.

Eine gut durchdachte Ordnerstruktur im Source Control erleichtert die Orientierung und Zusammenarbeit im Team. Unsere empfohlene minimale Struktur bietet eine solide Basis für die meisten Projekte und kann bei Bedarf erweitert werden.

Veröffentlichung zum Einsatz von Generative AI für Product Owner, Scrum Master und Entwicklungsteams in der IT Spektrum 02/2025.

Die Nutzung von OpenAPI-Spezifikationen zur automatisierten Client-Generierung reduziert den Aufwand und sorgt für Konsistenz bei API-Änderungen. Dies ermöglicht eine effiziente Entwicklung von Frontend-Anwendungen sowie die Bereitstellung von SDKs für Dritte.