Was sind Release Notes?
Release Notes sind nutzerorientierte Zusammenfassungen der Aenderungen in einer neuen Version deines Produkts. Sie sind polierter und erzaehlerischer als ein Changelog — mit Fokus auf Vorteile statt technische Details.
Aufbau guter Release Notes
Jede Release Note sollte vier Teile haben:
- Klarer Titel — Versionsnummer und eine kurze, beschreibende Ueberschrift.
- Zusammenfassung — Ein bis zwei Saetze, die die wichtigste Aenderung erklaeren.
- Detaillierte Aenderungen — Eine kategorisierte Liste aller wichtigen Aenderungen.
- Auswirkungshinweis — Alles, was der Nutzer tun muss (Migrationsschritte, Breaking Changes).
Gute vs. schlechte Release Notes
Schlechtes Beispiel
Bugs behoben und Performance verbessert.
Gutes Beispiel
Dashboard laed 40% schneller. Wir haben die Query-Schicht umgeschrieben, um N+1-Queries auf der Projektliste zu eliminieren. Du wirst den Unterschied sofort bei Accounts mit 10+ Projekten bemerken.
Fuer verschiedene Zielgruppen schreiben
Passe deine Sprache an die Leser deiner Release Notes an:
- Entwickler — API-Aenderungen, Code-Beispiele, Migrationsanleitungen einbeziehen.
- Product Manager — Fokus auf Features, Business-Impact und Metriken.
- Endnutzer — Einfache Sprache, Fokus auf Vorteile, Screenshots einbeziehen.
5 Tipps fuer bessere Release Notes
- Schreibe menschlich, nicht roboterhaft. Vermeide Corporate-Jargon.
- Fuehre mit dem Nutzen, nicht mit dem Implementierungsdetail.
- Fuege einen Screenshot oder GIF fuer visuelle Aenderungen ein.
- Verlinke zur Dokumentation fuer Details.
- Veroeffentliche konsistent — deine Nutzer werden lernen, nach Updates zu schauen.