Führen Sie schon ein Changelog?

Ein Changelog ist eine Datei, die eine von Hand gepflegte, chronologisch sortierte Liste aller erheblichen Änderungen enthält, die zwischen einzelnen Veröffentlichungen oder Versionen eines Projekts umgesetzt wurden. ProgrammiererInnen beispielsweise nutzen Changelogs, um Änderungen an ihrem Programmcode zu dokumentieren.

Aber Sie müssen keine ProgrammiererIn sein, um ein solches Änderungsprotokoll als nützliches Produktivitätstool zu nutzen. Führen Sie Changelogs für Ihre eigenen Aktivitäten und halten Sie Ihre Teammitglieder an, wichtige Projektänderungen und -erkenntnisse in einem Changelog zu dokumentieren!

Was ist der Zweck eines Changelogs?

Ein Changelog soll es BenutzerInnen und Projektverantwortlichen einfacher machen, gerade die beachtenswerten Änderungen, die zwischen Veröffentlichungen oder Versionen eines Projekts gemacht wurden, zu sehen.

• Dies hilft, die Entwicklung eines Projektes samt den Ursachen für bestimmte Veränderungen transparent zu machen.
• Es hilft bei der eigenen Rückschau.
• Es unterstützt die Einarbeitung neuer Teamkollegen.
• Und es ist ein wichtiger Wissensspeicher, um doppelte Arbeit und Sackgassen bei der Entwicklung zu reduzieren.

Changelogs bieten sich sowohl für (private) Ein-Personen-Projekte, die sich entweder über einen längeren Zeitraum ziehen oder regelmäßig anfallen, als auch für berufliche Projekte sowohl von Einzelpersonen als auch von Teams an.

Wer sollte ein Changelog nutzen?

Die Projektverantwortlichen und die Teammitglieder wie auch Außenstehende können ein Changelog nutzen, um Fortschritte und Entwicklung eines Projektes stichpunktartig und im zeitlichen Verlauf nachvollziehen.

Wie sieht so ein Changelog aus?

Im einfachsten Fall handelt es sich bei einem Changelog um eine einfache Textdatei, in der in umgekehrt chronologischer Reihenfolge (neueste Änderungen stehen oben) alle wichtigen Projektanpassungen mit Datum, Maßnahme und Ursache für diese Maßnahme aufgeführt sind. Bei Teamprojekten sollten die Einträge auch den Namen oder das Kürzel des verantwortlichen Teammitglieds umfassen.

Die Änderungen können zudem mit Schlüsselworten versehen werden, um die Ursache für die Änderung auf den ersten Blick erkennen zu können. Software-ProgrammiererInnen nutzen vor allem folgende Arten von Änderungen:

• Added für neue Features
• Changed für Änderungen an der bestehenden Funktionalität
• Deprecated für Features, die in zukünftigen Versionen entfernt werden
• Removed für Deprecated-Features, die in dieser Version entfernt wurden
• Fixed für alle Bug-Fixes
• Security,um BenutzerInnen im Fall von geschlossenen Sicherheitslücken zu einer Aktualisierung aufzufordern

Im Fall von Projekten außerhalb des IT-Bereichs können diese Kategorien zum Teil übernommen oder adaptiert werden. Zusätzlich bieten sich weitere Kategorien an wie:

• Cost für Anpassungen aus Budget-Gründen
• Custom. für Änderungen auf Kundenwunsch/-notwendigkeit
• Optimized für Features, die der Optimierung von Abläufen dienen
• usw.

Ob und in welchem Umfang Sie diese Kategorien verwenden, ist auch den eigenen Vorlieben überlassen. Die konsistente Nutzung eines festgelegten Kategoriensystems hilft allerdings dabei, die Übersicht im Changelog zu steigern und seinen langfristigen Nutzen als Projektdokumentation und Wissensspeicher zu erhöhen.

Natürlich kann das Changelog fallweise auch einfach handschriftlich im eigenen Notizbuch entstehen oder zum Beispiel als Anlage im CRM-System angelegt werden, wenn es sich um ein Projekt mit starkem Kundenbezug handelt.

Was ist beim Führen eines Changelogs als Nicht-ProgrammiererIn zu beachten?

• Entscheidend ist vor allem, dass das Changelog regelmäßig gepflegt wird, alle wichtigen Projektanpassungen umfasst, aber zugleich nicht zu sehr ins Detail geht. Das Changelog soll einen Überblick über die Projektentwicklung erlauben, nicht zu einem Stundennachweis verkommen.
• Ebenso wichtig ist es, Changelogs als Wissensspeicher zu verstehen und darauf zurückzugreifen, um sich (sei es für neue, ähnlich gelagerte Projekte wie auch bei der Fortführung des bestehenden) über frühere Fallstricke und Best Practices zu informieren.
• Das Changelog ist damit auch eine Problemlösungsdokumentation auf sehr hoher Ebene: Es ist nicht Ziel des Changelogs, die genauen Lösungsschritte zu dokumentieren, wohl aber die gefundenen Probleme und Lösungswege an sich.

Probieren Sie es aus: Um ein Changelog für Ihr nächstes Projekt zu starten, brauchen Sie keine spezielle Software und kein Training. Es entstehen keine zusätzlichen Kosten und der Aufwand für die Erstellung ist gering. Der Nutzen ist aber gerade bei regelmäßiger Pflege hoch und dient zudem als Gedächtnisstütze dafür, auf welche Projektklippen man gestoßen ist und wie man sie gemeistert hat. Sie werden sich also nie mehr am Ende der Woche fragen müssen: Was habe ich eigentlich in der vergangenen Woche geleistet? Schauen Sie einfach in Ihren Changelogs nach!