Was ist ein Changelog?

Ein Changelog listet die Veränderungen eines Produktes auf, zum Beispiel einer App. Aber ein gut geführtes Changelog verrät noch viel mehr über das Produkt, als bloß dessen vergangene Entwicklung.

Fast jedes Software-Produkt kommt mit einem Changelog daher. Manchmal heißt dieses Changelog auch „Release Notes“. Es taucht oftmals direkt in den Update-Benachrichtigungen auf und liefert so einen Überblick über die Änderungen, die das Update mit sich bringt.

Was enthält ein Changelog?

Ein Changelog dokumentiert die Änderungen des Produkts. Es zeigt, welche neuen Funktionen es gibt, ob sich Dinge verändert haben und der Benutzer eventuell darauf reagieren muss. Es zeigt welche Fehler beseitigt wurde und ob Funktionen entfernt oder eingeschränkt wurden.

Bei OpenSource-Projekten kann man meist auch nachlesen, wer die entsprechenden Änderungen vorgenommen hat und warum.

Ein Changelog verrät uns noch viel mehr

Im besten Fall wird das Changelog bereits seit der ersten Version geführt und es ist dir damit möglich, bis zu den Anfängen des Produkts zurück zu schauen. Die chronologische Auflistung erfolgt dabei meist über Versionsnummern oder dem Veröffentlichungsdatum.

Gerade Changelogs, die weit zurück reichen, gewähren dir einen guten Einblick in die Ausrichtung des Entwicklerteams. Zunächst einmal siehst du deutlich, wie aktiv die Entwickler sind. Du kannst auch den Schwerpunkt der Entwicklung sehen. Arbeitet man gerade eher an neuen Funktionen oder beseitigt man hauptsächlich Fehler?

Ein Blick zurück in die letzten Änderungen lässt auch oftmals erkennen, in welche Richtung sich das Produkt bewegt. Anhand neuer Features lässt sich erahnen, was die Entwickler noch so geplant haben.

Wie wird ein Changelog erzeugt?

Grundsätzlich gibt es zwei Möglichkeiten, ein Changelog zu erstellen. Sämtliche Änderungen werden gesammelt und dann von einem Teammitglied in die Changelog-Datei übertragen. Oder das Changelog wird automatisch erstellt. Das ist zum Beispiel möglich, wenn man ein Versionsverwaltungssystem wie Git benutzt, in dem man jede Änderung, die man vornimmt, kurz kommentieren muss.

Es gibt Einwände gegen das automatische Erstellen eines Changelogs, da dies meist nicht so gut lesbar ist, wie ein selbstgeschriebener Text.

Welches Format hat ein Changelog?

Damit jeder das Changelog ohne Zusatzprogramme lesen kann, wird es grundsätzlich als einfache Textdatei ausgeliefert. Damit es ein wenig übersichtlicher ist, greifen viele Entwickler auf Markdown zurück, einem einfachen Formatierungssyntax.

Detaillierte Informationen zum Thema Changelog, Formatierung, Automatisierung und Best Practice findest du bei keepachangelog.com