ziffer-05

Agile IT-Dokumentation: Integration in DevOps & ALM

Anwendungs- und Softwaredokumentation

Die Anwendungsentwicklung befasst sich mit der Erstellung neuer Softwareanwendungen und der Weiterentwicklung bestehender Anwendungen. Der Anwendungsbetrieb hingegen übernimmt die Aufgabe, diese Anwendungen bereitzustellen und ihren laufenden Betrieb zu gewährleisten. Das Hauptziel des Anwendungsbetriebs ist es, einen reibungslosen Funktionsablauf der Anwendungen zu garantieren, konstante Systemverfügbarkeit sicherzustellen und die Einhaltung der definierten Funktionalitäten zu überwachen.

Während jedoch die Dokumentation in der Anwendungsentwicklung oft klaren Prozessen folgt, wird die Bedeutung der Dokumentation für den Anwendungsbetrieb im Rahmen des Application Lifecycle Managements vielfach unterschätzt. Es kommt nicht selten vor, dass Anwendungen ohne adäquate Dokumentation an den Betrieb übergeben werden.

Fehlende Dokumentationsvorgaben für den Anwendungsbetrieb

Die Hauptursachen für diese Problematik liegen häufig in unzureichenden Vorgaben für die Betriebsdokumentation (siehe auch Use Case Systemdokumentation und Betriebshandbücher) sowie im Fehlen klarer Regelungen für die Übergabe der Dokumentation bei der Betriebsübernahme. Zusätzlich wird in der täglichen Anwendungspraxis oft ein notwendiger Informationsaustausch vernachlässigt.

Der Mangel unzureichender Dokumentation wird noch die zunehmende Komplexität und Kritikalität von Anwendungen, die Häufigkeit von Änderungen sowie schneller technologischer Fortschritte verschärft.

Unsere Leistungen für agile Dokumentation & DevOps-Betrieb

 Dokumentation und agile Softwareentwicklung sind kein Widerspruch. Wir zeigen Ihnen, wie sich Dokumentationsprozesse in Ihre DevOps-Pipeline integrieren lassen und damit den Entwicklungszyklus aktiv unterstützen.

  • Anforderungsanalyse für die Betriebsdokumentation im Rahmen des Application Lifecycle Managements
  • Optimierung bestehender Dokumentationsprozesse 
  • Konzeption und Aufbau der Dokumentation für den Anwendungsbetrieb
  • Bereitstellung unternehmensspezifischer Vorlagen für die Anwendungsdokumentation

Gerne stellen wir Ihnen unsere praxiserprobten Ansätze in einem kurzen Video-Call vor.

DevOps erfordern neue Dokumentationskonzepte

Im Rahmen digitaler Transformationsprozesse findet zunehmend eine Aufhebung der traditionellen Trennung von Entwicklung und Betrieb statt. Dies hat zur Entstehung und Verbreitung von DevOps geführt, einer Methode, die das Zusammenwirken von Entwicklung und Betrieb betont.

DevOps ist eine Kombination der Begriffe Development (Entwicklung) und Operation (Betrieb). Hierbei werden mehrere bislang getrennte Bereiche als zusammenhängend betrachtet, mit dem Ziel, die Entwicklung und Bereitstellung agiler, effizienter und zuverlässiger zu gestalten. Dabei setzt DevOps auf die Automatisierung und die Integration von Entwicklungs- und Betriebsprozessen, um die Geschwindigkeit der Softwarebereitstellung zu erhöhen und die Zusammenarbeit zwischen den Teams zu verbessern. Ebenso dominieren agile Methoden, die zudem Offenheit für Veränderungen während des Projekts erfordern. 

Für die Dokumentation resultieren hieraus sowohl zusätzliche Herausforderungen als auch Chancen, die sich durch die Optimierung der Dokumentationsprozesse bieten.

FAQs zu agiler Dokumentation & DevOps-Integration

DevOps setzt auf kurze Feedback-Schleifen und hohe Automatisierung, damit Änderungen schnell, sicher und nachvollziehbar umgesetzt werden. Dokumentation ist dabei ein kontinuierlicher, integraler Bestandteil, schafft gemeinsames Verständnis und ermöglicht es, Abläufe reproduzierbar zu machen. Die Dokumentation beschreibt hierbei die verschiedenen Schritte der DevOps-Pipeline, von der Quellcodeverwaltung und kontinuierlichen Integration (Continuous Integration) bis zur kontinuierlichen Bereitstellung (Continuous Delivery). Die Dokumentation wird also nicht erst zum Ende der Entwicklung erstellt, sondern fortlaufend während der DevOps-Pipeline.

Durch die Trennung  von lösungsorientierten Handlungsanweisungen und vertiefenden Informationen. Der First-Level-Support hat vor allem folgende Anforderungen an die Dokumentation: Zielgruppengerecht und knapp, lösungsorientiert, Steckbriefe für Systeme/Services, Standardprozeduren und Workarounds, klare Eskalationsregeln und gute Auffindbarkeit. 

Aus unserem Blog

Jedes Unternehmen muss sich heute mit Digitalisierung und digitalem Wandel beschäftigen. Diese Entwicklungen haben zwangsläufig auch Einfluss auf die Ausgestaltung der IT-Dokumentation. …

Nach oben scrollen