KjerrChangelog-Beispiele,
die sich zu kopieren lohnen.
Gute Changelog-Beispiele haben drei Dinge gemeinsam: einen Titel, der sagt, was sich geändert hat, einen Satz darüber, was Nutzer jetzt tun können, und eine ehrliche Angabe, was als Nächstes zu tun ist. Hier stehen vier Beiträge, einer für jede Art von Änderung, danach der Unterschied zwischen Changelog und Release Notes und eine Checkliste.
Vier Changelog-Beispiele, nach Kategorie
Jedes Beispiel ist für ein erfundenes Produkt geschrieben, in den vier Kategorien, die der Bereich Neuigkeiten in Kjerr verwendet. Kopieren Sie die Form, nicht die Worte.
Neue Funktion
Die Zwei-Faktor-Anmeldung ist da
Sie können Ihr Konto jetzt mit einem zweiten Schritt bei der Anmeldung schützen. Öffnen Sie die Einstellungen, dann Sicherheit, scannen Sie den QR-Code mit einer beliebigen Authenticator-App und speichern Sie die Ersatzcodes. Der Owner eines Workspace kann den zweiten Schritt für jedes Teammitglied vorschreiben. Das war einer der häufigsten Wünsche auf unserem Board.
Warum es funktioniert: Beginnt mit dem, was Nutzer jetzt tun können, sagt, wo es zu finden ist, und würdigt den Wunsch.
Verbesserung
Berichte laden bis zu dreimal schneller
Wir haben neu gebaut, wie Berichte berechnet werden. Die Monatsübersicht, die bei großen Konten sechs Sekunden brauchte, öffnet sich jetzt in unter zwei, und Zeiträume von mehr als einem Jahr laufen nicht mehr in ein Timeout. An den Zahlen selbst hat sich nichts geändert.
Warum es funktioniert: Nennt eine Zahl, die Leser spüren, und versichert, dass die Daten dieselben sind.
Fehlerbehebung
Behoben: Im CSV-Export fehlte die letzte Zeile
Bei Exporten mit mehr als 10.000 Zeilen fehlte die letzte Zeile. Der Fehler ist behoben, und Exporte ab heute sind vollständig. Wenn Sie in der ersten Augusthälfte einen großen Bericht exportiert haben, exportieren Sie ihn bitte noch einmal.
Warum es funktioniert: Sagt, was falsch war, wen es betraf und was zu tun ist. Ohne Beschönigung.
Ankündigung
Woran wir in diesem Herbst arbeiten
Ein kurzer Blick auf die nächsten Monate, gestützt auf Ihre Stimmen. Die Benachrichtigungen in Slack sind bereits in Arbeit. Danach folgt der Dark Mode; er ist die Idee mit den meisten Stimmen auf dem Board, und das Design hat begonnen. Wir schreiben hier, sobald eines davon live ist.
Warum es funktioniert: Setzt Erwartungen ohne Termine, die sich nicht halten lassen, und verweist auf die Stimmen.
Aufbau eines Changelog-Beitrags, der funktioniert
- Titel: die Änderung, nicht die Versionsnummer. „Berichte laden bis zu dreimal schneller“ sagt Lesern, ob es sie betrifft. „v4.12.1“ sagt es nicht.
- Kategorie. Neue Funktion, Verbesserung, Fehlerbehebung oder Ankündigung. So lässt sich der Changelog überfliegen und filtern.
- Was Sie jetzt tun können. Ein oder zwei Sätze aus Sicht der Nutzer.
- Wo es zu finden ist. Der Pfad im Menü oder ein Link.
- Was zu tun ist. Oft nichts. Verlangt ein Fix einen neuen Export oder eine geänderte Einstellung, schreiben Sie es ausdrücklich dazu.
- Den Wunsch würdigen. Haben Nutzer danach gefragt, verlinken Sie den Wunsch. Das ist der günstigste Beleg dafür, dass Feedback gelesen wird.
Changelog vs. Release Notes
Ein Changelog ist das fortlaufende Protokoll aller nennenswerten Änderungen; Release Notes beschreiben ein einzelnes Release. Der Changelog ist eine Liste zum Überfliegen: kurze Beiträge, die neuesten zuerst, einer pro Änderung. Release Notes sind ein Dokument zum Lesen: Sie fassen die Änderungen einer Version zusammen, erklären die größeren mit Screenshots und enthalten Schritte für Update oder Migration.
Kleinen Teams genügt meist der Changelog allein, mit einem längeren Beitrag, wenn ein Release es verdient. Produkte mit versionierten Installationen oder einer API veröffentlichen oft zusätzlich Release Notes und verlinken sie aus jedem Changelog-Beitrag.
Checkliste vor dem Veröffentlichen
Lesen Sie den Beitrag wie ein Nutzer, der Ihre Roadmap nie gesehen hat.
- Ist der Titel ohne den Text verständlich?
- Handelt der erste Satz vom Nutzer und nicht vom Team?
- Steht dort eine Zahl, ein Pfad oder ein Screenshot, wo es helfen würde?
- Falls etwas kaputt war: Ist klar, wen es betraf und was zu tun ist?
- Sind die Wünsche verlinkt, die der Beitrag beantwortet?
- Erfahren es die, die gefragt haben, und nicht nur die, die zufällig vorbeischauen?
Solche Beiträge in Kjerr veröffentlichen
Der Bereich Neuigkeiten in Kjerr ist ein Changelog mit den vier Kategorien von oben. Beiträge unterstützen Überschriften, Listen, Links und Bilder, verweisen auf die Ideen, die sie beantworten, und können beim Veröffentlichen per E-Mail an die Abonnenten gehen.
- Kategorien, Suche nach Text und Datum, Emoji-Reaktionen und Kommentare.
- E-Mail-Abo mit bestätigter Adresse.
- Verknüpfte Ideen stehen unter dem Beitrag; der Status Shipped schickt den Abstimmenden eine E-Mail.
- Ein Widget für Ihre eigene Website zeigt dieselben Ankündigungen in einem Seitenpanel, mit der Zahl der ungelesenen Beiträge am Launcher.
Fragen, klar beantwortet.
Was ist ein Changelog?
Ein Changelog ist eine datierte Liste der Änderungen an einem Produkt, die neuesten zuerst, geschrieben für die Menschen, die es nutzen. Jeder Beitrag sagt, was sich geändert hat, wen es betrifft und was gegebenenfalls zu tun ist.
Was ist der Unterschied zwischen Changelog und Release Notes?
Ein Changelog ist das fortlaufende Protokoll aller nennenswerten Änderungen; Release Notes beschreiben ein einzelnes Release. Ein Changelog-Beitrag besteht aus ein paar Sätzen. Release Notes können eine Seite füllen, mit Screenshots und Update-Schritten. Viele Produkte veröffentlichen beides am selben Ort.
Was gehört in einen Changelog-Beitrag?
Ein Titel, der sagt, was sich geändert hat, eine Kategorie, ein oder zwei Sätze darüber, was Nutzer jetzt tun können, die Angabe, wo es zu finden ist, und gegebenenfalls, was zu tun ist. Beantwortet die Änderung einen Wunsch, schreiben Sie das dazu und verlinken Sie ihn.
Gibt es ein Beispiel für gute Release Notes?
Die vier Beispiele oben funktionieren auch als Abschnitte von Release Notes: Fassen Sie die Beiträge einer Version unter einer Überschrift zusammen und ergänzen Sie Screenshots und Update-Schritte, wo sie nötig sind. Der Aufbau des einzelnen Eintrags bleibt derselbe.
Wie oft sollte man den Changelog aktualisieren?
Immer dann, wenn Sie etwas ausliefern, das Nutzer bemerken können. Ein kurzer Beitrag alle ein bis zwei Wochen schafft mehr Vertrauen als ein langer pro Quartal.
Wo sollte der Changelog stehen?
Auf einer öffentlichen Seite mit eigener Adresse, damit er sich verlinken, durchsuchen und indexieren lässt, und in einer E-Mail an die Abonnenten. Kjerr legt ihn auf dasselbe Board wie die Feature-Requests.
Verwandte Seiten
Geben Sie Ihren Nutzern eine Antwort.
Während der Early-Access-Phase ist Kjerr kostenlos: alle Funktionen, keine Kreditkarte. Kostenpflichtige Tarife werden später pro Workspace berechnet, nie pro Admin-Seat.