Читать книгу Handbuch Infrastructure as Code - Kief Morris - Страница 75

Es kann zu viel Arbeit sein, Dokumentation zu schreiben und sie aktuell zu halten. Für manche Zwecke ist der Infrastruktur-Code nützlicher als »richtige« Dokumentation. Es handelt sich bei ihm um eine immer akkurate und aktuelle Beschreibung Ihres Systems:

 Neue Teammitglieder können den Code durchgehen, um etwas über das System zu lernen.

 Teammitglieder können den Code lesen und Commits begutachten, um zu erfahren, was andere getan haben.

 Technische Reviewer können den Code verwenden, um herauszufinden, was sich verbessern lässt.

 Auditorinnen und Auditoren können den Code und die Versionshistorie begutachten, um ein genaues Bild des Systems zu erhalten.

Infrastruktur-Code ist selten die einzig erforderliche Dokumentation. Eine High-Level-Dokumentation ist für den Kontext und eine Strategiebeschreibung nützlich. Vielleicht haben Sie Stakeholder, die Aspekte Ihres Systems verstehen müssen, Ihren Technologie-Stack aber nicht kennen.

Sie können auch diese anderen Dokumentationstypen als Code managen. Viele Teams schreiben Architecture Decision Records (ADRs, https://oreil.ly/cxP4c) in einer Markup-Sprache und halten sie unter Versionskontrolle.

Sie können nützliche Unterlagen wie Architekturdiagramme oder Parameter-Referenzen automatisch aus Code generieren. Diesen können Sie in eine Change Management Pipeline stecken, um die Dokumentation immer dann zu aktualisieren, wenn jemand eine Änderung am Code vornimmt.