Release Notes: Mehr als Bugfixes und kleine Verbesserungen

So schreiben Sie Release Notes, die gelesen und verstanden werden

Melanie Feldmann

© Shutterstock / Brian A Jackson

„Bugfixes und kleine Verbesserungen“: Viel zu oft bestehen Release Notes nur aus diesem Satz. Das hilft nicht wirklich weiter, wenn Anwender auf einen bestimmten Fix oder ein Feature hoffen. Außerdem können Release Notes so viel mehr sein als ein Jira- oder Basecamp-Export.

Mach es offensichtlich

Release Notes sollten nicht in der hintersten Ecke einer Webseite versteckt sein – schlimmsten Falls als PDF. Nutzer sollten Release Notes einfach finden und durchsuchen können. Also ist Plain Text oder HTML eine gute Lösung. Auch zurückliegende Release Notes sollten einfach aufzuspüren sein. Und auf gut lesbare und verständliche Release Notes kann man immer stolz in Social Media verweisen.

Mach es übersichtlich

Features und Bugfixes sollten klar voneinander getrennt und nicht bunt gemischt sein. Features sind alle neue Funktionen, Bugfixes alle Lösungen für bestehende Fehler. Die beiden darf man nicht durcheinander bringen. Features sollten dabei in der Reihenfolge der Wichtigkeit sortiert sein: also das spannendste zuerst, das kleine, praktische Feature zuletzt. Hier immer an die Zielgruppe denken. Bei einer Android-App interessieren sich Nutzer nicht für einen Logik-Fehler in Zeile 572. Bugs und Features thematisch zu bündeln hilft ebenfalls, es übersichtlich zu machen.

Schreib es verständlich und nachvollziehbar

Mit einem „Bug 123462 gefixt“ kann niemand etwas anfangen. Ein Satz macht oft schon klar worum es geht: „Performanceprobleme in Firefox 45.0.x behoben (Bug 123462)“. Und schon freut sich der Firefox-Nutzer, dass es bei ihm jetzt schneller funktioniert.

Kontrolliere zweimal

Egal ob ein Entwickler, ein Tester oder sonst wer für das Schreiben der Release Notes zuständig ist: Es sollte immer noch einmal jemand gegenlesen. Nur weil es Kopf des Schreibers Sinn ergibt, heißt das noch lange nicht, dass dem auch so beim Leser ist. Idealerweise sollte auch ein Nicht-Techie einen Blick auf die Release Notes werfen. Erst dann zeigt sich, ob sie wirklich verständlich sind. Dies ist vor allem bei Software wichtig, die nicht nur Spezialisten verwenden.

Entschuldige dich

Manche Bugs rauben Nutzer schier den Schlaf. Fehler zuzugeben und zu versprechen daran zu arbeiten so etwas in Zukunft nie wieder vorkommen zu lassen, sorgt für deutliche Sympathiepunkte. Auch ein Dankeschön für die Geduld und das Vertrauen der Nutzer bringt gutes Karma.

Sei unterhaltsam

Die absolute Königsklasse der Release Notes besteht darin, sie unterhaltsam oder sogar witzig zu machen. Das ist sicherlich nicht jedermanns Sache und auch nicht bei jeder Software angebracht. Aber wenn man seine Nutzer nicht nur informiert, sondern auch unterhält, belohnt man sie dafür die – jetzt nicht mehr drögen – Release Notes gelesen zu haben. Hier darf man natürlich auch nicht übertreiben. Wenn die Release Notes aus mehr Witzen und geekigen Anspielungen besteht als Informationen, kippt die Leserzufriedenheit wieder ins Negative.

Ein gutes Beispiel für unterhaltsame Release Notes ist Slack. Was Übersichtlichkeit anbelangt zeigt Firefox wie es geht. Etwas ausführlicher macht es GIMP. Und es gibt natürlich einen Twitter-Account, der spannenden Release Notes gewidmet ist. Wer Inspiration sucht, findet sie dort:


Aufmacherbild: Writing with quill pen von Shutterstock / Urheberrecht: Brian A Jackson

Verwandte Themen:

Geschrieben von
Melanie Feldmann
Melanie Feldmann
Melanie Feldmann ist seit 2015 Redakteurin beim Java Magazin und JAXenter. Sie hat Technikjournalismus an der Hochschule Bonn-Rhein-Sieg studiert. Ihre Themenschwerpunkte sind IoT und Industrie 4.0.
Kommentare

Hinterlasse einen Kommentar

Hinterlasse den ersten Kommentar!

avatar
400
  Subscribe  
Benachrichtige mich zu: