Kostenloser Release-Notes-Generator

Was sind Release-Notes?

Release-Notes sind eine kurze Zusammenfassung der Änderungen in einer neuen Produktversion: neue Funktionen, Verbesserungen und Fehlerbehebungen, so geschrieben, dass der Leser weiß, was er jetzt tun kann. Ein Release-Notes-Generator verwandelt die Rohliste, die Ihr Team bereits hat, wie Commits oder Tickets, in diese Zusammenfassung, damit die Notizen mit dem Release erscheinen und nicht erst eine Woche später.

Gute Release-Notes erklären Kunden, warum ein Update für sie wichtig ist. Commit-Nachrichten sagen Entwicklern, welcher Code geändert wurde. Die Arbeit besteht darin, das eine in das andere zu übersetzen.

Release-Notes oder Changelog?

Die Begriffe werden oft locker verwendet. Eine nützliche Unterscheidung:

Dieses Tool funktioniert auch als Changelog-Generator: Erstellen Sie Notizen für jedes Release und fügen Sie sie oben auf Ihrer Changelog-Seite hinzu.

Was in Release-Notes enthalten sein sollte

• Titel mit Produkt und Version: „Acme Analytics 3.2 Release-Notes“.
• Eine einzeilige Zusammenfassung: die ein oder zwei Änderungen, die für die meisten Leser wichtig sind.
• Neu, Verbessert, Behoben: in dieser Reihenfolge, wobei leere Abschnitte weggelassen werden.
• Vorteilsorientierte Aufzählungspunkte: was der Nutzer jetzt tun kann, nicht was der Code tut.
• Breaking Changes: genau das, was jemand tun muss, klar hervorgehoben.
• Links: zum Hilfe-Artikel oder Video für alles, was erklärt werden muss.

Ein kurzes Beispiel für Release-Notes

Drei Commits, „feat: export reports to CSV“, „fix: dashboard timezone off by one hour“ und „chore: bump dependencies“, könnten zu Folgendem werden:

Acme Analytics 3.2
Sie können Ihre Berichte jetzt überallhin mitnehmen und Dashboards zeigen die richtigen Zeiten an.

Neu

• CSV-Export: Laden Sie jeden Bericht als CSV-Datei herunter, um ihn in Excel oder Google Sheets zu öffnen.

Behoben

• Dashboard-Zeiten: Diagramme verwenden jetzt korrekt Ihre Zeitzone.

Das Abhängigkeits-Update wird in der Kundenversion weggelassen, da die Nutzer es nicht bemerken werden. Die interne Version behält es bei.

So bereiten Sie Ihre Änderungen für den Generator vor

Sie müssen Ihre Liste nicht vorher aufräumen, aber ein paar Gewohnheiten sorgen für bessere Notizen. Fügen Sie eine Änderung pro Zeile ein, egal ob es sich um eine Commit-Nachricht, einen Ticket-Titel oder einen Satz handelt. Behalten Sie konventionelle Präfixe wie „feat:“ und „fix:“ bei, falls Sie diese verwenden; sie helfen dabei, Änderungen in neu und behoben zu sortieren. Fügen Sie kryptischen Elementen ein Wort des Kontextes hinzu, zum Beispiel „fix: export (CSV was empty for large reports)“. Geben Sie Produktname und Version ein, damit der Titel veröffentlichungsbereit ist. Führen Sie den Vorgang dann zweimal aus, wenn Sie beide Versionen benötigen: einmal für Kunden, einmal für das interne Team.

Best Practices für Release-Notes

Schreiben Sie für die Person, die das Produkt verwendet

„Berichte laden schneller“ ist besser als „Optimierter Abfrageplaner“. Benennen Sie die Funktion so, wie sie in der Benutzeroberfläche erscheint.

Beginnen Sie mit dem Wichtigsten

Stellen Sie die Änderung, die die meisten Leute bemerken werden, an den Anfang. Kleine Korrekturen können am Ende jeweils eine Zeile einnehmen.

Zeigen Sie die neue Funktion

Ein Screenshot oder ein kurzes Video einer neuen Funktion bewirkt mehr als ein Absatz. Verlinken Sie den Hilfe-Artikel, der sie erklärt.

Veröffentlichen Sie nach einem Zeitplan, den die Leute finden können

Behalten Sie jedes Release auf einer Changelog-Seite, die neuesten zuerst, damit Kunden und Ihr Support-Team immer wissen, wo sie suchen müssen.

Häufige Fehler bei Release-Notes

• Einfügen des Commit-Logs im Originalzustand, mit Ticketnummern und Fachjargon.
• Verstecken einer wichtigen Änderung (Breaking Change) mitten in einer Liste.
• Auflisten jeder internen Änderung in den Kunden-Notizen.
• Versprechen von Terminen oder Funktionen, die nicht im Release enthalten sind.

Der Generator enthält nur Änderungen aus Ihrer Liste und fügt keine Daten hinzu, die Sie nicht angegeben haben, aber überprüfen Sie jeden Punkt, bevor Sie ihn veröffentlichen.