Entwicklung
Release-Notes-Vorlage für Softwareversionen
Sag Nutzer:innen, was sich geändert hat und was sie tun müssen. Diese Vorlage hat eine Zeile mit Version und Veröffentlichungsdatum, eine Highlights-Zusammenfassung, Listen für Neu, Verbessert und Behoben, nummerierte Upgrade-Hinweise, bekannte Probleme mit Workarounds und einen Feedback-Abschnitt mit deiner Kontakt-E-Mail.
Diese Vorlage im Editor öffnen- Kategorie
- Entwicklung
- Standardstil
- Technisch
Wann du sie brauchst
Veröffentliche Release Notes zu jeder Version, die du ausliefert, ob großes Release oder kleiner Patch. Nutzer:innen und Administrator:innen lesen sie, um zu entscheiden, wann sie aktualisieren, und der Support liest sie, um danach Fragen zu beantworten. Eine PDF-Fassung ist nützlich für Kund:innen, die Release-Dokumentation für Audits, Änderungsfreigaben oder ein offline verfügbares Archiv brauchen.
Was enthalten ist
- Einen Titel mit einem Ausfüllfeld für dein Projekt, gefolgt von Versionsnummer und Veröffentlichungsdatum.
- Highlights, dann separate Listen für Neu, Verbessert und Behoben in der vertrauten Changelog-Reihenfolge.
- Nummerierte Upgrade-Hinweise, einen Abschnitt zu bekannten Problemen und eine Feedback-Zeile mit einem Ausfüllfeld für deine E-Mail.
Tipps für ein besseres Dokument
- Beschreibe Korrekturen anhand des Verhaltens, das Nutzer:innen jetzt sehen, nicht anhand der internen Ursache. Ihnen ist wichtig, dass Exporte nicht mehr fehlschlagen, nicht welche Funktion geändert wurde.
- Setze alles, was Handeln erfordert, etwa eine Sicherung oder eine Konfigurationsänderung, in die Upgrade-Hinweise und erwähne es auch in den Highlights. Der Stil Technisch hält Versionsnummern und Befehle gut lesbar.
Vorlagenvorschau
Projekt oder Thema · Release Notes
Version: 1.0.0 · Veröffentlicht: Datum
Highlights
Eine kurze Zusammenfassung des Mehrwerts dieser Version.
Neu
- Neue Funktion und die Aufgabe, die sie ermöglicht.
- Neue Option und wo man sie findet.
Verbessert
- Ein bestehender Ablauf, der jetzt schneller oder klarer ist.
Behoben
- Ein konkretes Problem und das Verhalten, das Nutzer:innen jetzt sehen.
Hinweise zum Upgrade
- Sichere deine Konfiguration.
- Folge der Installationsanleitung für diese Version.
- Prüfe die Abläufe, auf die sich dein Team verlässt.
Bekannte Probleme
Beschreibe verbleibende Einschränkungen und einen verfügbaren Workaround.
Feedback
Kontaktiere E-Mail mit Version, Schritten zur Reproduktion und erwartetem Verhalten.
Ausfüllfelder wie dein Name und das Datum werden ersetzt, sobald du die Vorlage im Editor öffnest.