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. …
USE CASES
Dokumentation für Anwendungsentwicklung und -betrieb
Anwendungsentwicklung und Anwendungsbetrieb greifen über den gesamten Lebenszyklus einer Anwendung ineinander. Damit Anwendungen zuverlässig bereitgestellt, betrieben und weiterentwickelt werden können, müssen fachliche Anforderungen, Architekturentscheidungen, technische Konfigurationen und Betriebsinformationen nachvollziehbar miteinander verbunden sein.
In der Praxis liegen diese Informationen häufig verteilt in Backlogs, Entwicklungswerkzeugen, Wikis, Repositories, ITSM-Systemen oder klassischen Dokumenten. Eine wirksame Anwendungsdokumentation verbindet diese Quellen als gemeinsame Informationsbasis für Entwicklung, Betrieb, Informationssicherheit und Fachbereiche.
Dokumentation über den gesamten Anwendungslebenszyklus
Application Lifecycle Management (ALM) betrachtet eine Anwendung von den ersten Anforderungen über Entwicklung und Bereitstellung bis zum laufenden Betrieb und zur Weiterentwicklung. Die Dokumentation begleitet diesen Lebenszyklus und verändert sich mit der Anwendung.
Dokumentation in der Anwendungsentwicklung
In der Anwendungsentwicklung entstehen Informationen, die fachliche und technische Entscheidungen nachvollziehbar machen. Dazu gehören insbesondere:
- fachliche und nicht-funktionale Anforderungen,
- Architektur- und Designentscheidungen,
- Quellcode und technische Spezifikationen,
- Datenmodelle, Datenflüsse und Schnittstellen,
- Testfälle, Testergebnisse und Abnahmen,
- Sicherheitsanforderungen und Berechtigungskonzepte,
- Release- und Deployment-Informationen.
Diese Informationen müssen nicht in einem einzigen Dokument zusammengeführt werden. Anforderungen können beispielsweise im Backlog, Quellcode im Repository und Tests im Testmanagement-Werkzeug geführt werden. Entscheidend ist, dass Zusammenhänge erkennbar und relevante Informationen auffindbar sind.
Dokumentation für den Anwendungsbetrieb
Mit der Bereitstellung einer Anwendung verschiebt sich der Schwerpunkt auf die sichere und verlässliche Betriebsführung. Der Anwendungsbetrieb benötigt unter anderem Informationen über:
- Betriebsbedingungen und technische Abhängigkeiten,
- Umgebungen, Komponenten und Konfigurationen,
- Verantwortlichkeiten und Supportstrukturen,
- Monitoring, Protokollierung und Alarmierung,
- Backup, Wiederherstellung und Notbetrieb,
- Wartung, Patch- und Releaseverfahren,
- bekannte Fehler, Workarounds und Eskalationswege,
- Servicevereinbarungen und betriebliche Kontrollen.
Ein Betriebshandbuch beziehungsweise Betriebskonzept kann diese Informationen strukturieren und als zentraler Einstiegspunkt dienen. Es sollte vorhandene Informationen aus Entwicklungs-, ITSM- und Betriebswerkzeugen nicht wiederholen, sondern auf die jeweils führenden Quellen verweisen.
Wie sich die Verantwortlichkeiten von Entwicklung, IT-Betrieb und Fachbereich voneinander abgrenzen und verbinden lassen, erläutert der Wissensbeitrag Anwendungsbetrieb – Schnittstelle zwischen Systembetrieb, Entwicklung und Fachbereich.
Dokumentation in phasenorientierten und agilen Vorgehensmodellen
Das Vorgehensmodell beeinflusst, wann Dokumentation entsteht, wie sie strukturiert wird und wer sie pflegt. Sowohl phasenorientierte als auch agile Entwicklungsmodelle benötigen verbindliche Dokumentationsanforderungen.
| Aspekt | Phasenorientiertes Vorgehen | Agiles Vorgehen und DevOps |
|---|---|---|
| Erstellung | Dokumentation entsteht entlang definierter Projektphasen und wird für die Übergänge zwischen den Phasen bereitgestellt. | Dokumentation wird fortlaufend mit der Anwendung weiterentwickelt. |
| Struktur | Häufig werden festgelegte Dokumenttypen und Ergebnisse für die einzelnen Projektphasen vorgegeben. | Informationen werden stärker nach Themen und Aufgaben strukturiert und in die eingesetzten Werkzeuge integriert. |
| Betriebsübergang | Die Anwendung wird zu einem definierten Zeitpunkt an die Betriebsorganisation übergeben. | Entwicklung und Betrieb tragen häufig gemeinsam Verantwortung über den gesamten Lebenszyklus. |
| Qualitätssicherung | Meilensteine, Quality Gates, Abnahmen und Freigaben sichern die Ergebnisse ab. | Definition-of-Done-Kriterien, Reviews sowie automatisierte Tests und Kontrollen begleiten die Entwicklung. |
| Informationsquellen | Konzepte, Spezifikationen, Test- und Freigabedokumente stehen im Vordergrund. | Backlogs, Repositories, CI/CD-Pipelines, Wikis und Testwerkzeuge dienen als führende Quellen. |
| Pflege | Änderungen werden über geregelte Änderungs- und Freigabeverfahren eingearbeitet. | Die Dokumentation wird möglichst unmittelbar mit jeder relevanten Änderung aktualisiert. |
Die folgende Grafik stellt typische Unterschiede vereinfacht gegenüber: Im phasenbasierten Vorgehen entstehen definierte Dokumentationsergebnisse entlang der Projektphasen und werden für die Betriebsübernahme zusammengeführt. In DevOps wird die Dokumentation dagegen kontinuierlich in die Entwicklungs-, Test-, Bereitstellungs- und Betriebsprozesse integriert.
In beiden Vorgehensmodellen müssen die für den Betrieb erforderlichen Informationen vollständig, geprüft und zugänglich sein. Bei einer klassischen Betriebsübernahme steht die geregelte Übergabe im Mittelpunkt. In DevOps-Umgebungen ist dagegen die kontinuierliche Pflege durch das verantwortliche Team entscheidend.
In der Praxis können beide Vorgehensmodelle innerhalb einer Organisation nebeneinander bestehen. Das Dokumentationskonzept sollte deshalb nicht ein bestimmtes Modell voraussetzen, sondern passende Anforderungen, Verantwortlichkeiten und Qualitätssicherungsverfahren für beide Varianten festlegen.
Vernetzte Informationsbasis statt Dokumentensammlung
Moderne Anwendungsdokumentation besteht aus Dokumenten, strukturierten Daten und dynamischen Informationen aus operativen Systemen. Die Aufgabe eines Dokumentationskonzepts besteht darin, diese Bestandteile sinnvoll zu ordnen und miteinander zu verknüpfen.
Typische führende Informationsquellen sind beispielsweise:
- Backlog- und Requirements-Management-Systeme,
- Quellcode- und Konfigurations-Repositories,
- Architektur- und Modellierungswerkzeuge,
- CI/CD- und Testmanagement-Plattformen,
- Wiki- oder Dokumentationssysteme,
- CMDB und ITSM-Systeme,
- Monitoring- und Protokollierungssysteme,
- Unterlagen von Herstellern und IT-Dienstleistern.
Eine zentrale Übersichtsseite oder ein Betriebshandbuch kann als Informations-Hub dienen. Sie beschreibt die grundlegenden Zusammenhänge, nennt Verantwortlichkeiten und verweist auf die jeweils aktuelle Quelle. Dadurch lassen sich redundante Inhalte und unnötiger Pflegeaufwand vermeiden.
Die grundsätzliche Verbindung von technischer Dokumentation und betrieblichen Verfahren wird im Use Case IT-Systemdokumentation und Betriebshandbücher ausführlicher behandelt.
Sicherheit und Nachvollziehbarkeit
Sicherheitsanforderungen müssen bereits in der Anwendungsentwicklung berücksichtigt und bis in den laufenden Betrieb nachvollziehbar umgesetzt werden. Dazu gehören unter anderem Anforderungen an sichere Architekturen, Programmierung, Tests, Berechtigungen, Entwicklungsumgebungen und die Steuerung von Änderungen.
Die Dokumentation stellt dabei die Verbindung zwischen Vorgaben, Umsetzung und Nachweisen her. Sie zeigt beispielsweise, welche Sicherheitsanforderungen gelten, wie diese technisch umgesetzt wurden und mit welchen Tests oder Kontrollen ihre Wirksamkeit überprüft wird.
Welche Anforderungen tatsächlich relevant sind, hängt von Schutzbedarf, Kritikalität, Verarbeitungszweck und geltenden rechtlichen oder regulatorischen Vorgaben ab. Nicht jede Anwendung benötigt daher dieselben Dokumentationsinhalte oder denselben Detailgrad.
Mögliche KI-Nutzung in der Anwendungsdokumentation
KI kann Informationen aus verschiedenen Phasen des Anwendungslebenszyklus zusammenführen und für die Dokumentation aufbereiten. Abhängig von Schnittstellen, Berechtigungen und Datenqualität können dabei beispielsweise Backlogs, Repositories, CI/CD-Pipelines, Testmanagement-, ITSM- und Monitoring-Systeme einbezogen werden.
Mögliche Einsatzbereiche sind:
- Anforderungen, Architekturentscheidungen, Tests und Releases miteinander verbinden,
- Informationen aus Repositories, CI/CD-Pipelines und ITSM-Systemen durchsuchen und zusammenfassen,
- Auswirkungen von Änderungen auf Betriebsverfahren und Dokumentation erkennen,
- Widersprüche und mögliche Dokumentationslücken identifizieren,
- Entwürfe für Release Notes, Schnittstellenbeschreibungen und Betriebsanleitungen erstellen.
KI ersetzt weder eine geeignete Informationsarchitektur noch die fachliche Prüfung und Verantwortung.
So unterstützt dokuit Sie bei Ihrer Anwendungsdokumentation
In vielen Organisationen sind umfangreiche Entwicklungs- und Betriebsinformationen vorhanden, aber nicht konsistent strukturiert oder ausreichend miteinander verknüpft. Gemeinsam mit Ihnen entwickeln wir daraus eine pflegefähige Dokumentationsstruktur, die zu Ihrem Vorgehensmodell, Ihrer Anwendungslandschaft und den eingesetzten Werkzeugen passt.
Im Einzelnen geht es darum,
- die vorhandene Anwendungsdokumentation aufzunehmen und zu bewerten,
- die Anforderungen von Entwicklung, Betrieb, Informationssicherheit und Fachbereichen zu ermitteln,
- eine Dokumentationsstruktur für den Anwendungslebenszyklus zu konzipieren,
- Dokumentationsanforderungen und Übergabekriterien zu definieren,
- Betriebshandbücher beziehungsweise Betriebskonzepte zu strukturieren,
- führende Informationsquellen zuzuordnen und redundante Pflege zu vermeiden,
- anwendungsspezifische Vorlagen und Checklisten zu entwickeln,
- die Dokumentationspflege in Entwicklungs-, Change- und Betriebsprozesse zu integrieren,
- Verantwortlichkeiten und Qualitätssicherungsverfahren festzulegen.
Das Ergebnis ist keine zusätzliche Dokumentensammlung, sondern eine vernetzte Informationsbasis, die Entwicklung, Betriebsübernahme und den laufenden Anwendungsbetrieb wirksam unterstützt.
Gerne stellen wir Ihnen unsere praxiserprobten Ansätze in einem kurzen Video-Call vor.
Anwendungsdokumentation verbindet Entwicklung und Betrieb
Eine zeitgemäße Anwendungsdokumentation begleitet die Anwendung über ihren gesamten Lebenszyklus. Sie verbindet Anforderungen und Entwicklungsentscheidungen mit technischen Informationen, Betriebsverfahren und aktuellen Daten aus den eingesetzten Werkzeugen.
So bleiben Informationen auch bei häufigen Änderungen nachvollziehbar, für die jeweiligen Zielgruppen nutzbar und mit vertretbarem Aufwand pflegbar.
FAQ zur Dokumentation für Anwendungsentwicklung und -betrieb
Was gehört zur Anwendungsdokumentation?
Zur Anwendungsdokumentation gehören fachliche, technische und betriebliche Informationen über eine Anwendung. Dazu zählen beispielsweise Anforderungen, Architektur, Schnittstellen, Tests, Konfigurationen, Sicherheitsmaßnahmen und Betriebsverfahren.
Was ist der Unterschied zwischen Entwicklungs- und Betriebsdokumentation?
Die Entwicklungsdokumentation beschreibt Anforderungen, Entwurfsentscheidungen, Implementierung und Tests. Die Betriebsdokumentation enthält die Informationen und Verfahren, die für Bereitstellung, Überwachung, Wartung, Support und Störungsbehebung benötigt werden.
Welche Dokumentation wird für die Betriebsübernahme benötigt?
Benötigt werden alle Informationen, mit denen der Betrieb die Anwendung sicher bereitstellen, überwachen, warten und bei Störungen wiederherstellen kann. Der konkrete Umfang richtet sich nach Kritikalität, Komplexität, Schutzbedarf und Betriebsmodell.
Kann KI die Anwendungsdokumentation automatisch erstellen?
KI kann vorhandene Informationen analysieren, zusammenfassen und für Entwürfe nutzen. Ohne klare Informationsstrukturen, geeignete Zugriffsrechte und fachliche Prüfung entsteht daraus jedoch keine verlässliche Anwendungsdokumentation.
Aus unserem Blog
Der IT-Betrieb ist kein Selbstzweck. Zu den wesentlichen Aufgaben einer IT-Organisation gehört daher der Anwendungsbetrieb, d. h. die Bereitstellung von Anwendungen für die …