Beginne mit einer nutzerorientierten Vorlage
Ersetze jedes Feld in eckigen Klammern durch überprüfte Angaben. Entferne irrelevante Abschnitte, statt Funktionen zu erfinden. Wenn keine Maßnahme für die Aktualisierung nötig ist, sage dies ausdrücklich, nachdem du den unterstützten Aktualisierungspfad geprüft hast.
# [Version] — [Veröffentlichungsdatum]
## Höhepunkte
- [Für Nutzer sichtbare Verbesserung und wer davon profitiert]
## Aktualisierung
- Von: [unterstützte Vorgängerversion]
- Maßnahme: [erforderliche Migration oder keine Maßnahme nötig]
- Prüfung: [wie eine erfolgreiche Aktualisierung bestätigt wird]
## Inkompatible Änderungen
- [Geändertes Verhalten, betroffene Nutzer und Migrationslink]
## Fehlerbehebungen
- [Behobenes Problem und Link zum Issue oder Pull Request]
## Bekannte Probleme
- [Verbleibende Einschränkung und Übergangslösung]
## Mitwirkende
[Mitwirkende würdigen und vollständiges Änderungsprotokoll verlinken]Mache aus generierten Hinweisen eine verständliche Erklärung
GitHub kann Versionshinweise mit zusammengeführten Pull Requests, Mitwirkenden und einem Link zum vollständigen Änderungsprotokoll erstellen. Betrachte dieses Ergebnis als Entwurf. Prüfe die Versionsabgrenzung, entferne irrelevante Einträge und gruppiere Änderungen nach den Aufgaben deiner Nutzer.
Zum Beispiel bietet „Parser-Sonderfall beheben“ wenig Orientierung. Erkläre, sofern zutreffend, dass CSV-Dateien mit einer leeren letzten Spalte jetzt korrekt importiert werden, und verlinke die Korrektur für technische Details. Behaupte nicht, alle Parsing-Probleme seien gelöst, wenn nur ein Fall geändert wurde.
Prüfe den Aktualisierungspfad vor der Ankündigung
Probiere die dokumentierte Aktualisierung von einer unterstützten Vorgängerversion aus. Prüfe Downloadlinks und stelle sicher, dass die Dokumentation zur Version passt. Unterscheide eine Vorabversion von einer stabilen Version und mache verbleibende Einschränkungen leicht auffindbar.
Veröffentliche die Versionsinformationen, bevor du sie in einem Community-Beitrag verlinkst. Hebe in der Ankündigung eine bedeutende Verbesserung hervor, während die Versionshinweise als ausführliche Referenz dienen. Sammle Rückfragen und präzisiere bei Bedarf die Anleitungen.
Häufige Fragen
Sind Versionshinweise dasselbe wie ein Änderungsprotokoll?
Sie überschneiden sich. Ein Änderungsprotokoll hält Änderungen über die Zeit fest; Versionshinweise erklären eine bestimmte Version und ihre Auswirkungen auf Nutzer. Verlinke beide, damit Leser zwischen Überblick und Details wechseln können.
Kann ich automatisch generierte Versionshinweise unverändert veröffentlichen?
Prüfe sie zuerst. Generierte Pull-Request-Titel können Migrationsschritte, Auswirkungen für Nutzer oder bekannte Probleme auslassen.
Sollte jede kleine Codeänderung unter den Höhepunkten erscheinen?
Nein. Nutze die Höhepunkte für nutzerrelevante Änderungen und belasse die ausführliche technische Historie im verlinkten Änderungsprotokoll.