t2informatik » Wissen kompakt » Changelog

Changelog

Ein Protokoll der Änderungen

Der englische Begriff „Change“ bedeutet ins Deutsche übersetzt „Änderung“ oder „Veränderung“, der Begriff „Log“ bedeutet Logbuch oder Protokoll. Ein Changelog ist somit ein Änderungsprotokoll, in dem Veränderungen bspw. an einer Software, einer Webseite oder innerhalb eines Projekts dokumentiert werden. In einem Changelog wird die Historie einer Entwicklung dargestellt.

Die Form der Darstellung eines Changelogs variiert: es kann eine flache Liste mit Änderungen, eine Tabelle oder ein Dokument 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 neue Changelog wieder an die Anwender zu verteilen. Anstelle dieser Verteilung erfolgt eine Veröffentlichung unter einer gleichbleibenden URL.

Viele Unternehmen verwenden für ein Changelog alternative Bezeichnungen wie Release Notes, News, What’s new, History etc. Auch der Aufbau der protokollierten Informationen variiert. 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 ein Changelog kein lückenloses Änderungsprotokoll.

Auch der Aufbau einer Changelog-Datei variiert. Als Dokumentation von Änderungen innerhalb einer Softwareentwicklung werden oftmals folgende Informationen zur Verfügung gestellt:

  • 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. 
  • Hinweise zur Inbetriebnahme der Neuerungen, Verbesserungen, Fehlerbeseitigungen.
  • Kontaktmöglichkeiten der Anwender mit Kundenbetreuung oder Hotline.

Die Gestaltung eines Changelogs für Anwender verursacht einigen 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 das Changelog übernommen werden. 

Hinweis:

Eine Vorlage für ein Changelog finden Sie hier  »

“Das Fachwissen zu Softwarearchitekturen, die Expertise in der Softwareentwicklung und die sehr flexible Arbeitsweise waren ideal für uns.“

„Ich brauche Freiheit und Vertrauen. Und ich möchte Verantwortung übernehmen und dabei Spaß haben!“

Share This