Release Notes sind die Liste der Änderungen, die mit einer Fassung an die Nutzer geht. Sie sind für Menschen geschrieben, die mit der Software arbeiten, und nicht für die, die sie gebaut haben.
- Release Notes
Die Liste der Änderungen, die mit einer Fassung an die Nutzer geht.
Beispiel: „In den Release Notes zu 2.4 standen drei neue Funktionen und der Hinweis auf die geschlossene Lücke.“Auf Deutsch Versionshinweise. Üblich sind vier Abschnitte: neu, geändert, behoben und Sicherheit.
Abgrenzung zum Changelog: Dieser führt alle Änderungen technisch und vollständig. Release Notes wählen aus und erklären die Folgen.
Was in Release Notes gehört
Was jemand merkt, der die Software benutzt: neue Funktionen mit einem Satz dazu, Änderungen an Abläufen, behobene Fehler und alles, was nach dem Update anders bedient wird.
Dazu gehören die Schritte, die der Nutzer selbst tun muss. Eine Fassung, die eine Einstellung umbenennt oder eine Erweiterung verlangt, sagt das in den Hinweisen und nicht im Forum.
Wie Release Notes sich vom Changelog unterscheiden
Durch den Adressaten. Im Changelog steht, dass eine Methode entfernt wurde; in den Release Notes steht, dass Formulare mit Dateianhang eine neue Einstellung brauchen. Dieselbe Änderung, zwei Darstellungen.
Deshalb entstehen sie auch getrennt: Der Changelog wächst mit den Commits, die Release Notes schreibt jemand vor der Veröffentlichung.
Warum Release Notes zur Sicherheit gehören
Weil sie der Anlass sind, ein Update einzuspielen. Steht dort, dass eine Lücke geschlossen wurde, über die Angreifer Code ausführen konnten, wird aus einem Update eine Aufgabe für diese Woche.
Wer ein CMS betreut, liest sie deshalb vor jedem Update. Sie sagen in zwei Minuten, ob der Sprung klein ist oder Arbeit bedeutet, siehe CMS-Update.