Write effective product release notes (+real examples & templates)

Jeder, der sich mit dem Verfassen von Release Notes befasst, findet sie mühsam, langweilig und zeitraubend. Oft sieht man Leute, die buchstäblich vor ihnen weglaufen. Aber denken Sie daran, dass es für das Wachstum Ihres Unternehmens wichtig ist, Produktversionshinweise zu veröffentlichen und Ihr Changelog auf dem neuesten Stand zu halten. In diesem Artikel werden wir uns auch Vorlagen für Versionshinweise ansehen.

Neben dem Betrieb eines Changelog-Dienstes haben wir auch sehr oft mit Versionshinweisen zu tun. Wir aktualisieren unsere Benutzer ständig über die neuesten Änderungen und Verbesserungen, die wir an unserem Produkt vorgenommen haben. Deshalb haben wir Techniken entwickelt, um den gesamten Prozess erträglicher und effektiver zu gestalten.

Was sind Versionshinweise?

Versionshinweise sind ein Dokument in Form von Aufzählungen, das einer Softwareversion beigefügt wird, um die Benutzer über die Änderungen zu informieren. Es gibt zwar kein allgemeingültiges Format, aber typische Versionshinweise enthalten Informationen über Fehlerbehebungen, neue Funktionen und manchmal auch bekannte Probleme. Versionshinweise können ein langweiliges technisches Dokument sein, das niemand gerne liest und schreibt. Aber unsere Aufgabe als Produktmanager ist es, diese Notizen ansprechender, interessanter und informativer zu gestalten.

Was ist das Problem mit ihnen?

Die drei Hauptprobleme, die mit Versionshinweisen verbunden sind, sind
– das Management,
– die gestörte Kommunikation und
– der Vertriebskanal.

Das größte Problem ist die mangelnde Kommunikation innerhalb des Teams. Selbst in kleinen Unternehmen ist es für das technische Team schwierig zu erklären, was geändert wurde. Oft beheben sie etwas und vergessen ein paar Wochen später, was in diesem Monat gemacht wurde.
Nun, und die Aufgabe der Versionshinweise dem Entwicklungsteam zu überlassen, ist auch ein Fehler. Sie neigen dazu, sehr technische Versionshinweise für Leute mit einem Doktortitel in Informatik zu schreiben.
Den Lesern ist es egal, wie etwas behoben wurde; sie interessieren sich nur für das Endergebnis. Wie können sie von der Aktualisierung profitieren?

Tipps zum Schreiben von Versionshinweisen (mit Vorlagen)

Wenn man das Thema Humor in Versionshinweisen für später beiseite lässt, können die meisten Informationen in Versionshinweisen in eine verständliche Form gebracht werden. Wenn Ihnen also das nächste Mal ein Entwickler Notizen über einen behobenen Fehler oder eine neue Funktion schickt, werden Sie beide Zeit sparen.
Anstatt also einen Kommentar von einem Entwickler zu erhalten, der keinen Sinn ergibt. Sie werden ein tieferes Verständnis dafür haben, was sich geändert hat und wie Sie es den Endbenutzern besser vermitteln können.
So, hier kommen wir zu meiner persönlichen Liste von Tipps und Tricks, die ich verwende, um großartige Versionshinweise zu erstellen! Lassen Sie sich inspirieren und schreiben Sie Ihre eigenen Vorlagen für Produktfreigabenotizen! Vorlagen für Software-Produktfreigabemitteilungen sind eine gute Möglichkeit, Zeit zu sparen.

1. Sie > Wir

Beginnen Sie nicht mit „Wir haben das gemacht“. Den Nutzern ist es egal, was SIE getan haben, sie interessiert nur, was SIE von dem bekommen, was Sie getan haben.

Sie können jetzt .
Neu veröffentlicht ist für Ihre Nutzung verfügbar. Jetzt können Sie

2. Konzentrieren Sie sich auf den Benutzer

Verwenden Sie häufiger „SIE“. Das ist ein Copywriting-Trick, der die Art und Weise, wie die Textinformationen wahrgenommen werden, sofort verändert. Sie werden unbewusst eher bereit sein, den Text zu lesen, wenn sie das „Du“ sehen.

Gute Nachrichten für dich! lässt dich Feedback von deinen Nutzern sammeln.
Glücklich zu verkünden, was dir hilft, Datenverlust zu vermeiden.
Spare deine Zeit mit

3. Befolge einfache Vorlagen für Versionshinweise

Erstelle diese Vorlagen und bitte dich, Entwickler, deine Notizen nur in diesem Format zu schreiben. Auf diese Weise werden Missverständnisse vermieden und Sie wissen genau, was geändert wurde, wie es funktioniert und welche Ziele es zu erreichen versucht. Allein diese 4 Vorlagen decken 90% aller Versionshinweise ab.

• Vormals X ist jetzt Y
• Sie können jetzt X statt Y machen
• X macht nicht mehr X, Y wenn Z, Q, W
• X macht nicht mehr Y. Das bedeutet, dass Sie Z nicht mehr tun müssen

4. Vermeiden Sie es, zu förmlich zu sein

Natürlich hängt das vom Branding Ihres Unternehmens ab. Förmliche Texte sind jedoch in der Regel lang und kommen nicht direkt auf den Punkt. Dadurch wird es für die Leser schwieriger, den Text zu lesen. Versuchen Sie, eine einheitliche Sprache zu verwenden und vermeiden Sie es, in Ihren Vorlagen für Versionshinweise zu formal zu sein.

5. Erweitern und dann vereinfachen

Gute Versionshinweise sind kurz und prägnant. Um dies zu erreichen, sollten Sie den Text jedoch erweitern und sicherstellen, dass er alles widerspiegelt, was eine neue Funktion oder eine Fehlerbehebung ausmacht. Außerdem besteht ein Großteil der Versionshinweise darin, eine große Menge an Informationen in kurze Absätze zu pressen. Stellen Sie sicher, dass die einzelnen Versionshinweise nicht aus dem Zusammenhang gerissen werden.

Lassen Sie uns einen Blick auf die besten Beispiele für Versionshinweise werfen. 3 Unternehmen mit großartigen Release Notes Seiten und wie Sie von ihnen lernen können?

👉Verbundener Artikel: Alles, was Sie über die wichtigsten Kennzahlen in SaaS wissen müssen

Beispiele für Release Notes

Beispiele für Salesforce Release Notes

Salesforce ist eine CRM-Plattform mit vielen Produkten unter ihrem Dach. Kunden über neue Funktionen und Produktänderungen auf dem Laufenden zu halten, ist also die Hölle für technische Redakteure, Produktmanager und Entwickler.
Ich gehe davon aus, dass das Unternehmen vierteljährlich Release Notes erstellt, und zwar unter dem Namen „Salesforce Summer ’19 Release Notes“, einer sehr umfassenden Release Notes-Seite mit ihren Kategorien und Unterkategorien.
Salesforce Release Notes ist eine Mischung aus regulären Release Notes sowie einer Produktkarte. Es handelt sich um eine detaillierte Erklärung, wie jede Funktion funktionieren wird und für welche Benutzer sie verfügbar sein wird.

Der offensichtliche Vorteil solch umfassender Versionshinweise ist die Entlastung der Supportabteilungen. Zum Beispiel, wenn sie eine Kundenfrage zu einem bestimmten Thema erhalten. Sie können sie einfach auf die Seite weiterleiten, auf der die Benutzer die Antwort finden.

Wichtige Profi-Tipps zum Herausnehmen:

1. Wie man den Abschnitt Versionshinweise verwendet

2. Detaillierte, visuell verständliche Tabellen mit einem Produktfahrplan

3. Abschnitt Filter

4. Allgemeine Erklärung, allgemeine Erklärung und dann eine detaillierte Beschreibung, wie eine neue Funktion funktioniert.

Salesforce folgt auch Release Notes-Vorlagen.

Schritt 1: Erklären Sie, worum es bei der neuen Funktion geht.
Sie müssen nicht mehr zu Salesforce Classic wechseln, um Gebietszuweisungen auf der Seite Account zu verwalten. Sie können jetzt die Liste der zugewiesenen Gebiete in Lightning Experience bearbeiten. Zuvor war die zugehörige Liste in Lightning Experience schreibgeschützt.

Sie müssen nicht mehr zu . Sie können jetzt auch . Zuvor konnten Sie nur .

Schritt 2: Erläutern Sie, wie Sie die Funktion aktivieren oder darauf zugreifen können
Wo: Diese Änderung gilt für Lightning Experience in den Editionen „Performance“ und „Developer“ sowie in den Editionen „Enterprise“ und „Unlimited“ mit der Sales Cloud.

Schritt 3: Erläutern Sie, wie Sie die Funktion verwenden
Wie: Wenn das Layout Ihrer Kontoseite die Liste „Zugewiesene Gebiete“ enthält, ist keine Einrichtung erforderlich. Klicken Sie auf „Zugewiesene Gebiete“ und „Zuweisen“, um die Zuweisungen zu verwalten.

Beispiele für Sketch Release Notes

Wenn Ihr Produkt nicht so kompliziert ist und keine Plattform mit einem großen Dach von Unterwerkzeugen ist, sollten Sie sich das Unternehmen Sketch ansehen.
Das Layout ist interessant. Auf der rechten Seite haben Sie eine detaillierte Beschreibung aller neuen Funktionen und Fehlerbehebungen und auf der linken Seite gibt es Beschreibungen der wichtigsten großen Funktionen. Und CTA.

Smart Distribute Upgrades

Sie können jetzt Smart Distribute verwenden, um die Abstände in Rastern zu kontrollieren. Sie können den vertikalen Abstand zwischen Reihen von Ebenen sowie den horizontalen Abstand zwischen den einzelnen Ebenen in einer Reihe ganz einfach anpassen. Wir haben außerdem eine neue Schaltfläche „Aufräumen“ in den Inspektor aufgenommen. Sie richtet eine Auswahl mehrerer Ebenen schnell in einem übersichtlichen Raster aus und macht es so noch einfacher, komplexe Layouts zu erstellen und zu verwalten.

Wieder sehen wir eine einfache Vorlage:
Sie können jetzt . Sie können ganz einfach . Wir haben auch eine neue .

Verbesserungen:
Wir haben dem Menü „Bearbeiten“ einen neuen Befehl „Alles in Zeichenfläche auswählen“ hinzugefügt, mit dem Sie schnell alle Ebenen auf einer ausgewählten Zeichenfläche auswählen können. Außerdem haben wir den verschiedenen „Alles auswählen“-Befehlen ein eigenes Untermenü zugewiesen.

• Wir haben den Befehl „Alles auswählen“ hinzugefügt, so dass Sie jetzt Folgendes tun können:
• Ein Absturz wurde behoben, der auftreten konnte, wenn Sie versuchten, mit dem Zauberstab-Werkzeug eine Auswahl zu treffen.
• Ein Fehler wurde behoben, bei dem für Schriftarten mit demselben Namen nicht das richtige Schriftgewicht angezeigt wurde.

– Es wurde ein Fehler in den Seiten- und Ebenenlisten behoben, bei dem Auswahlen nicht korrekt hervorgehoben wurden, wenn sie mit einem externen Bildschirm verbunden waren.

Wenn wir also auf die benutzerorientierten Versionshinweise zurückkommen, müssen wir verstehen, dass wir unsere Versionshinweise für unsere Zielgruppe schreiben. Salesforce schreibt seine Releases für Menschen ohne technischen Hintergrund, für Vertriebsabteilungen und Marketer, Unternehmer, Gründer usw.

Die Skizze wird von Grafikdesignern und Künstlern verwendet. Daher verwenden sowohl Salesforce als auch Sketch einen generischen Ton, der sehr benutzerfreundlich ist und sich an echte Menschen richtet.

Getpostman Release Notes Examples

Wenn Ihr Produkt technisch ist und Ihre Benutzer Entwickler sind, dann ist das Gegenteil eine Faustregel. Je kürzer, technischer und nicht optisch ansprechender, desto besser.

Zum Beispiel ist Getpostman ein technisches Produkt für Entwickler.

Die Versionshinweise können schnell durchgeblättert werden, um eine allgemeine Vorstellung davon zu bekommen, was neu ist. Und sie folgen einem sehr einfachen Format.

Aktualisierungsnummer, Datum und Informationen in einem Satz über jede Aktualisierung ohne Details darüber, was es für einen Benutzer bedeutet, wie man es benutzt oder wie man darauf zugreift.

Je einfacher, desto besser. Sie werden es verstehen.

Humor in Versionshinweisen

Wir haben bereits über Beispiele für In-App-Versionshinweise gesprochen, die lustig und unterhaltsam zu lesen sind. Der Tonfall ist jedoch für die meisten Tech-Unternehmen nicht geeignet. Und die brauchen einen Styleguide für Release Notes. Außerdem hat nicht jedes Softwareprodukt eine mobile Version, und die meisten Unternehmen veröffentlichen ihre Versionshinweise auf einer separaten Seite irgendwo im Support- oder Hilfebereich. (Unternehmen vergraben ihre Versionshinweise strategisch und beschweren sich dann darüber, dass sie niemand liest.)

Es gibt viele intelligente Möglichkeiten, Produktaktualisierungen anzukündigen. Schreiben Sie zum Beispiel eine großartige E-Mail, um Produktaktualisierungen vorzustellen, oder erstellen Sie einen separaten Blogbeitrag.

👉 Verwandte Artikel: Die besten und die schlechtesten App Release Notes, die Sie inspirieren werden

Wie bei allem im Leben, schaffen wir durch Struktur und Organisation sowie moderne Technologien eine einfachere Lösung, die nicht so langweilig und unnötig ist.

Hoffentlich haben Ihnen unsere Muster-Vorlagen
und Beispiele für Software Release Notes geholfen.