Changelog

Changelog – ein Protokoll der Änderungen

Ein Changelog ist ein Änderungsprotokoll, in dem Veränderungen bspw. an einer Software, einer Webseite oder innerhalb eines Projekts dokumentiert werden. Der englische Begriff “Change” steht für “Änderung” oder “Veränderung”, der Begriff “Log” bedeutet Logbuch oder Protokoll. In einem Changelog – alternativ auch als Release Note, News, What’s new etc. bezeichnet – werden also Veränderungen dokumentiert bzw. die Historie einer Entwicklung dargestellt.

Der Inhalt und Aufbau des Changelogs

Die protokollierten Informationen in einem Changelog können variieren. In einem unternehmensinternen System werden meist sämtliche Veränderungen und damit zahlreiche Kleinigkeiten dokumentiert. Dies kann sehr wichtig sein, um eine Traceability zu gewährleisten. Oftmals interessieren sich Kunden aber nicht alle Details einer Änderung, für sie steht der Nutzen einer Änderung im Vordergrund. Ein Changelog innerhalb der Softwareentwicklung ist damit auch ein Marketinginstrument. Es ist ein Beleg für die Weiterentwicklung von Funktionen und eine Möglichkeit, einzelne Aspekte der Entwicklung zu betonen. In diesem Sinne wäre es kein lückenloses Änderungsprotokoll.

Auch der Aufbau eines Changelogs variiert. Als Dokumentation von Änderungen innerhalb einer Softwareentwicklung werden oftmals folgende Informationen dargestellt:

• Eine Agenda bzw. Inhaltsangabe.
• Eine Versionsnummer, aus der sich ergibt, mit welcher Softwareversion welche Änderungen implementiert wurden.
• Neue Funktionen, idealerweise auch jeweils mit einer Nennung des Nutzens für den Anwender.
• Verbesserungen bzw. Erweiterungen vorhandener Versionen, auch hier mit Hinweisen auf den Nutzen für Anwender.
• Screenshots, ggf. mit Hinweisen zur Nutzung der Neuerungen und Verbesserungen.
• Bugfixes – in manchen Organisationen werden diese auch per Bugfixlog kommuniziert.
• Hotfixes (als besonders eilige Bugfixes).
• Hinweise zur Inbetriebnahme der Neuerungen, Verbesserungen, Fehlerbeseitigungen.
• Kontaktmöglichkeiten der Anwender mit Kundenbetreuung oder Hotline.

Die Gestaltung eines Changelogs für Anwender verursacht relativ viel Aufwand. Viele Unternehmen arbeiten daher mit einem Konfigurationsmanagement, das sämtliche Änderungen dokumentiert und dabei die Informationen kennzeichnet, die später – manuell oder automatisiert – in die Dokumentation übernommen werden.

Unterschiedliche Formate für ein Changelog

Die Form der Darstellung eines Changelogs variiert: es kann

• eine flache oder geschachtelte Liste,
• eine Tabelle oder
• ein Dokument

mit Änderungen sein. Die Form hängt von der Zielsetzung der Protokollierung ab: Handelt es sich um eine unternehmensinterne Protokollierung, werden Änderungen oftmals in Listen und/oder Tabellen verwaltet. Handelt es sich um eine Information, die Anwender über Neuerungen, Verbesserungen oder Fehlerbeseitigungen einer Software informiert, wird es meist als Dokument zur Verfügung gestellt.

Auch die Veröffentlichung von Changes auf Webseiten oder in Wikis ist weit verbreitet, denn dadurch sparen sich Organisationen den Aufwand, jedes neues Format wieder an die Anwender zu verteilen. Anstelle dieser Verteilung erfolgt eine Veröffentlichung unter einer gleichbleibenden URL.

Impuls zum Diskutieren:

Sollte ein Changelog als Werbemittel betrachtet werden?

Hinweise:

Die Inhalte auf dieser Seite dürfen Sie gerne teilen oder verlinken.

Übrigens: Wir suchen Softwareentwicklerinnen und -entwickler.

Hier finden Sie eine Changelog Vorlage zum Download.

Hier finden Sie exemplarische Changelogs von Apple und Microsoft.

Und hier finden Sie ergänzende Informationen aus unserer Rubrik Wissen kompakt: