Release Notes

Release Notes – dokumentierte Neuerungen einer Softwareversion

Die Weiterentwicklung und Bereitstellung neuer Versionen gehört zum Tagesgeschäft von Softwareherstellern. Neue Features, veränderte Funktionen oder beseitigte Fehler werden in den sogenannten Release Notes dokumentiert. Früher wurden diese Versionshinweise in gedruckter Form einer Lieferung beigelegt, in Zeiten der Digitalisierung finden sich Release Notes heutzutage meist online auf Webseiten oder direkt in der entsprechenden Software.

Tipps zur Gestaltung von Release Notes

Obwohl es keinen offiziellen Standard für das Verfassen von Versionshinweisen gibt, folgen viele Hersteller einem ähnlichen Format, das eine Zusammenfassung der Änderungen, eine Liste der neuen Features und Funktionen, Fehlerbehebungen und bekannten Probleme enthält. Einige Hersteller fügen auch Anweisungen zur Inbetriebnahme des Updates oder Datenmigration hinzu.

In der Praxis lässt sich beobachten, dass Anwender Release Notes nicht immer lesen, da sie den Nutzen nicht erkennen und sich nicht die Zeit nehmen, sie durchzusehen. Das Lesen von Versionshinweisen kann jedoch hilfreich sein, um zu verstehen, wie man neue Funktionen nutzt oder bekannte Probleme vermeidet.

Es gibt eine Reihe von Tipps, die bei der Gestaltung von Release Notes nützlich sind:

• Strukturieren Sie die Inhalte bspw. nach Neuerungen, Anpassungen und Bugfixes. Nutzen Sie ggf. ein Inhaltsverzeichnis und deklarieren Sie die konkrete Release Nummer.
• Verwenden Sie „einfache“ Sprache. Idealerweise diese einfache Sprache mit der Sprache innerhalb der Software harmonieren. User Experience ist hier das entsprechende Schlagwort. Immer wieder kommt es vor, dass Softwareentwickler bspw. Funktionsbezeichnungen verwenden, die für sie – da sie vom Fach kommen – selbsterklärend sind; auf Anwender trifft das aber nicht immer zu.
• Vermeiden Sie Abkürzungen, da nicht jeder diese kennt oder sie manchmal mehr als eine Bedeutung haben können. Beispiel: CD könnte für Corporate Design (ein Begriff aus dem Marketing) oder für Continuous Delivery (eine Sammlung von Techniken, Prozessen und Werkzeugen, die eine kontinuierliche Auslieferung von Software ermöglicht) stehen.
• Heben Sie wichtige Änderungen hervor. Nicht jede Änderung ist gleichbedeutend mit anderen Änderungen. Verwenden Sie ggf. Grafiken oder Screenshots zur Veranschaulichung.
• Bedanken Sie sich für das Interesse und entschuldigen Sie sich für Fehler. Versprechen Sie aber nicht, keine neuen Fehler zu machen, denn das wäre a) unrealistisch und b) auch unglaubwürdig.
• Und nennen sie einfache Kontaktmöglichkeiten wie Telefonnummer, E-Mail-Adresse oder Chat-Möglichkeiten.

Die Meinung variieren, ob Release Notes auch unterhaltsam sein dürfen, um mehr Aufmerksamkeit zu erhalten. Sicherlich kommt es auf den konkreten Kontext an und möglicherweise sollte es der Corporate Identity (ein weiterer Begriff aus dem Marketing) entsprechen.¹

Hinweise:

Wenn Ihnen der Beitrag gefällt, teilen Sie ihn gerne in Ihrem Netzwerk. Und falls Sie sich für Tipps aus der Praxis interessieren, dann testen Sie unseren beliebten Newsletter mit neuen Beiträgen, Downloads, Empfehlungen und aktuellem Wissen. Vielleicht wird er auch Ihr Lieblings-Newsletter.

[1] Immer wieder entscheiden sich Unternehmen dazu, beim Starten einer Software automatisch ein Update auf die aktuelle Version durchzuführen und entsprechende Versionshinweise einzublenden. Ein solches Vorgehen sorgt bei Anwendern vermutlich nicht immer für Begeisterung.

Mit dem Changelog gibt es ein weiteres Protokoll von Änderungen. Manchmal wird argumentiert, dass Changelogs Neuerungen und Anpassungen „nur“ chronologisch auflisten und „lediglich“ für den internen Gebrauch bestimmt wären. In der Realität lässt sich aber auch beobachten, dass Changelogs und Release Notes synonym verwendet werden, oder dass sich Unternehmen für eine der beiden Bezeichungen entscheiden und Neuerungen und Fehlerbeseitigungen entsprechend kommunizieren.

Hier finden Sie eine Website mit 50 Release Notes Beispielen.