So nutzen DevOps-Teams ein CMS für die Dokumentation und Collaboration

von Mathias Diwo  // 30 Oktober, 2022

DevOps-Teams generieren viele Inhalte für die CI/CD-Code-Produktion: Kundendokumentationen, Meeting-Notizen, Architekturdokumente und andere Projekt-Artefakte. Die Teams sollten auch in der Lage sein, schnell auf diese Wissensdatenbank zuzugreifen, um Probleme zu beheben und die Geschwindigkeit des Bereitstellungszyklus zu halten.

Um all diese Informationen in eine CI/CD-Toolchain zu integrieren, wählen Sie ein Content-Management-System (CMS), das eine API für die Anbindung an andere Tools anbietet.

Die Mitarbeiter von DevOps sollten die Anforderungen an kundenorientierte und interne Inhalte berücksichtigen, anstatt einfach die Standard-CMS-Auswahl des Unternehmens zu akzeptieren.

Optionen für die externe Inhaltsverwaltung mit CMS

CI/CD-Tools machen herkömmliche datenbankgestützte CMS-Modelle zu langsam und redundant für die Veröffentlichung von Inhalten, die von GitHub, Chef, Selenium und anderen dokumentationsgenerierenden Pipeline-Komponenten benötigt werden.

Ein Git-basiertes CMS zur Dokumentation entspricht den Anforderungen von kundenorientierten Inhalten in einer DevOps-Umgebung. Git-basierte Angebote sind leistungsfähiger und skalierbarer als SQL-basierte CMS.

Sie basieren auf einer entkoppelten Architektur mit mehreren Mikroservices für die Erstellung und Bereitstellung von Inhalten, die in unterschiedlichen Subsystemen laufen. Für Sicherheits- und Skalierbarkeitsvorteile installieren Sie das CMS in der gleichen Cloud, in der auch die anderen CI/CD-Tools des DevOps-Teams untergebracht sind.

Die von DevOps entwickelten CMS-Optionen für Projektmanagement und Dokumentation basieren auf verschiedenen Betriebsmodellen.

Crafter, ein Open-Source-Git-basiertes CMS, trennt Inhalts- und Code-Updates, was, so der Werkzeugmacher, die Code-Liefergeschwindigkeit ermöglicht. Content-Ersteller können über Git kontinuierlich Updates vornehmen und Informationen aktualisieren, unabhängig von Software-Pushes, die durch die CI/CD-Pipeline gehen.

Ein Git-Push treibt die Entwicklung von einem isolierten Codezweig über das Testen bis hin zur automatischen Produktion voran. Ein Git Pull bootet neue Umgebungen mit jeder geeigneten Version des entsprechenden Inhalts.

Suchen Sie CMS-Technologien für extern ausgerichtete Dokumentationen, die Inhalte über mehrere digitale Kanäle veröffentlichen, wie z.B. Unternehmensseiten, mobile Apps, Microsites und jeden anderen Ort, an dem Ihre Kunden auf Informationen zugreifen. Bewerten Sie Tools, die mehr oder weniger Erfahrung mit Git erfordern, je nach den Fähigkeiten der Inhaltsautoren.

CMS-Anforderungen für interne Inhalte

Für interne Inhalte, die vom DevOps-Team verwendet werden, halten Sie das Content Management einfach, durchsuchbar und auditierbar. Ein Ansatz ist die Zentralisierung von Inhalten in einem Wiki oder Cloud-Repository mit Versionierung, Benachrichtigung, Tagging und Suche.

Während einige Unternehmen von DevOps-Teams erwarten, dass sie ein bereits etabliertes CMS für die Dokumentation und den Wissensaustausch verwenden, stellen Sie sicher, dass die Technologie alles integriert hat, und weisen diese zurück, wenn dies nicht der Fall ist.

Investieren Sie Zeit, um die Suchmaschine der Plattform zu optimieren, Tags einzurichten und Benachrichtigungen auf Dokumenten oder Seiten zu erstellen, damit die entsprechenden Teammitglieder wissen, wann sie aktualisiert werden. Betrachten Sie einen anderen Content Management-Ansatz für die interne Dokumentation, bei dem die Zusammenarbeit im Vordergrund steht und nicht die Veröffentlichung.

Authoring-Prozesse, Integration und Verwaltung

Atlassian Confluence bietet einen einfachen Authoring-Prozess und Integrationsmöglichkeiten zur Verwaltung der internen Teamdokumentation. Benutzer können auch auf eine Bibliothek von Add-Ins zugreifen, um Arbeitsbereiche mit Berichten, externen Inhalten und Navigation anzupassen.

Sie können auch wiederverwendbare Vorlagen für Arbeitsbereiche in der Entwicklungsorganisation erstellen, die beim Start neuer Projekte verwendet werden können. Eine andere Methode verwendet ein Cloud-Repository für das Content Management, wie die Angebote von Dropbox und Box zeigen.

Zum Beispiel bietet Dropbox – und damit auch das Dokumentdesign von Dropbox Paper – eine leichte Inhaltserstellung und Dateispeicherung als CMS für die Dokumentation. Es lässt sich über eine API mit anderen Tools in der DevOps-Toolchain integrieren. Diese Art von Produkten beinhaltet typischerweise Suchfunktionen und die Möglichkeit, Mitarbeiter zu Dokumenten einzuladen.

Erstellen Sie die Sicherheit für diese Klasse von Collaboration-Tools über das Setup des Identity Access Management des Unternehmens oder Single Sign-On. Die Content-Management-Optionen für DevOps-Teams vervielfachen sich, da APIs zu Standardfunktionen für die Werkzeugintegration werden.

Ein erfolgreiches Dokumentenmanagement hängt jedoch von der Planung ab: Machen Sie das Content-Management zu einem Teil der CI/CD-Toolchain und zu einem Posten im Rahmen der DevOps-Tools im Voraus und geben Sie sich nicht mit der etablierten Corporate CMS-Plattform zufrieden, wenn sie nicht den Anforderungen des Softwareteams entspricht.

Digitalisiere dein Business und werde zum digitalen Pionier

Über den Autor

Mathias Diwo

Mathias schreibt über transformative Digital- und Technologietrends, der Digitalisierung und der digitalen Transformation. Die Entwicklungen der Megatrends: von Cloud bis KI, von AR/VR bis 5G, den digitalen Arbeitsplatz, Management, Leadership und die Zukunft der Arbeit. Lade ihn ein, bei deiner nächsten Veranstaltung zu sprechen.

Bewährte Digitalisierungs-Tipps direkt in deinen Posteingang

Erhalte Zugang zu exklusiven Tipps, Strategien und Fallstudien, die ich sonst nirgendwo teile.

TOP Content

Exclusive inhalte

Exclusive Aktionen

Tipps und Learnings