Documentation as Code (DaC) gewinnt als Trend in der Softwareentwicklung immer mehr an Bedeutung. Dabei geht es um die Harmonisierung der Behandlung von Software-Dokumentation mit der von Code. Wie macht sich diese Entwicklung bei DevOps bemerkbar?
Experten live erleben und aus der Praxis lernen:
Diese Webinare sollten Sie nicht verpassen!
DaC setzt auf eine Gleichbehandlung von Dokumentation und Softwarecode. Für einige Experten ist dieser Ansatz eine wertvolle Ergänzung der DevOps-Methodik. Einer von ihnen ist Gilad David Maayan, der sich mit dem Thema zuletzt tiefergehend auseinandersetzt hat. Er kommt zu dem Schluss, dass DaC ein wertvolles Werkzeug für DevOps darstellt.
So profitiert DevOps
Maayan nennt explizit drei Vorteile:
1. Zusammenarbeit wird besser
In vielen Fällen wird die Dokumentation als zweitrangig wahrgenommen. Sie wird im Anschluss an das Codieren durchgeführt. Wenn Entwickler und Betriebsteam in Silos arbeiten, entstehen dadurch Engpässe und Missverständnisse. DaC integriert die Dokumentation mit dem Code, sie wird quasi Teil davon. So fördert Documentation as Code eine teamübergreifende kollaborative Kultur.
2. Konsistenz und Genauigkeit steigen
DaC trägt zur Konsistenz und Genauigkeit bei. Das gelingt, indem Tools und Praktiken zum Überprüfen sowie Testen von Code auf die Dokumentation angewendet werden. Automatisierte Validierung stellt sicher, dass die Dokumente den vorab definierten Standards entsprechen und fehlerfrei sind. In Konsequenz können die Teams Zeit für manuelle Überprüfungen sparen und menschliche Fehler minimieren. Darüber hinaus erleichtert die Platzierung der Dokumentation neben dem Code ihre Synchronisation mit dem aktuellen Systemzustand.
3. Aktualisierungs- und Wartungsprozesse sind einfacher
DaC vereinfacht die Prozesse zur Aktualisierung sowie Wartung der Dokumentation. Im Gegensatz zur traditionellen Dokumentation, die schnell veraltet, integriert DaC Aktualisierungen in den Entwicklungsprozess. Sie stellt dadurch sicher, dass die Dokumentation mit den Code-Änderungen gemeinsam vorangetrieben wird. Diese Integration beseitigt die Aufwände durch getrennte Dokumentationsaktualisierungen. Gleichzeitig stellt sie so sicher, dass sie aktuell bleibt.
In Summe sieht Mayann in DaC weitreichende Vorteile für DevOps. Sein Rat: Möglichst früh mit Documentation as Code parallel zu Softwareentwicklung zu beginnen.
DevOps&ALM-Beratung@Windhoff Group
Warum sollten Unternehmen DevOps- oder ALM-Projekte gemeinsam mit der Windhoff Group angehen? Ganz einfach, weil Windhoff vollumfängliche Lösungen mit Kopf anbietet. Und das ist wortwörtlich gemeint. Windhoff verfügt über das gewünschte Know-how UND den passenden Windhoffler dazu. Dabei kommt die Erfahrung aus über 20 Jahren in der Softwareentwicklung bei der Gestaltung und dem Betrieb von Entwicklungsumgebungen zur Geltung. Dementsprechend wissen unsere Experten um die Komplexität von Konzeption, Einführung, Betrieb und Support von DevOps und ALM-Lösungen.
Mehr Informationen und unseren Check-Up „Tool-Chain“ gibt es hier .