Versionshinweise

Was sind Release Notes?

Release Notes sind schriftliche technische Dokumente mit Details zu neuen Softwareprodukten oder Updates. Sie ermöglichen es Entwicklungsteams, neue Produktänderungen oder -funktionen an Endbenutzer und interne Mitarbeiter zu kommunizieren.

Release Notes enthalten eine kurze Übersicht über alle Änderungen, die das Entwicklungsteam vorgenommen hat, zusammen mit hilfreichen Hinweisen zur Navigation durch neue Funktionen oder Verbesserungen. Typischerweise werden sie vom Produktmanager oder einem technischen Redakteur verfasst und zeigen, dass das Unternehmen kontinuierliche Verbesserung und Transparenz anstrebt.

Unternehmen wenden sich an Software für das Management von Release Notes, um Release Notes zu entwerfen, zu veröffentlichen und zu verteilen. Diese Software benachrichtigt Kunden auch automatisch, wenn neue Release Notes verfügbar sind.

Versionshinweise Software

Software, die versionshinweise als Funktion oder Begriff erwähnt.

Confluence

Pendo

Jira

MadCap Flare

Gainsight Product Experience

AnnounceKit

Grundlegende Elemente von Release Notes

Unternehmen variieren in ihrem Ansatz zur Erstellung von Release Notes, aber sie streben im Allgemeinen nach Organisation und Klarheit. Release Notes enthalten typischerweise die folgenden Informationen:

• Kopfzeile. Das Team fügt den Produktnamen, die Versionsnummer und das Veröffentlichungsdatum hinzu, damit Benutzer die Release Notes nachverfolgen und in der Kommunikation mit dem Unternehmen darauf verweisen können.
• Übersicht. Release Notes bieten eine Zusammenfassung der wichtigsten Änderungen in der Veröffentlichung, um den Benutzern ein grundlegendes Verständnis davon zu geben, was sie erwartet.
• Neue Funktionen und Fehlerbehebungen. In diesem Abschnitt beschreiben Release Notes alle neuen Funktionalitäten, Verbesserungen und Fehler- oder Problembehebungen. Oft wird erwähnt, ob das Team eine Funktion basierend auf Benutzeranfragen hinzugefügt hat.
• Auswirkungen. Release Notes heben hervor, wie sie den Benutzern zugutekommen oder ihre Erfahrung verbessern. Sie erklären auch, warum das Team Änderungen vorgenommen hat.
• Bekannte Probleme. Ein Release Note erwähnt oft Einschränkungen oder Probleme, die das Produkt noch hat. Dies lässt die Benutzer wissen, dass das Entwicklungsteam sie erkennt und plant, sie zu beheben.
• Zusätzliche Ressourcen. Manchmal fügt das Entwicklungsteam Links zu relevanten Ressourcen wie Tutorials oder Handbüchern hinzu, die Benutzer hilfreich finden könnten.

Vorteile von Release Notes

Obwohl ein kurzes Dokument, bieten Release Notes mehrere Vorteile für Entwickler und Benutzer. Einige davon sind:

• Produktbegeisterung aufbauen. Release Notes wecken Begeisterung für ein Produkt. Das Hören von neuen Funktionen oder Funktionalitäten könnte inaktive Benutzer dazu bringen, sich wieder mit dem Produkt zu beschäftigen.
• Transparenz bieten. Software- und App-Benutzer möchten auf dem Laufenden gehalten werden. Release Notes geben ihnen klare Einblicke in Produktänderungen und helfen, ein Gefühl von Vertrauen und Offenheit zwischen den Entwicklern und Benutzern zu fördern.
• Verbesserung der Benutzererfahrung. Benutzer über neue Updates zu informieren, hilft ihnen, die Funktionen des Produkts voll auszunutzen und verbessert ihre Gesamterfahrung. Dies kann helfen, die Bindung zu erhöhen, da voll engagierte Kunden mehr Gründe haben, zu bleiben.
• Teamabstimmung erhöhen. Wenn das Entwicklungsteam Release Notes intern teilt, verstehen andere Abteilungen, wie Marketing oder Vertrieb, die neuesten Verbesserungen des Produkts. Dann können sie Blog-Inhalte rund um die neue Veröffentlichung planen oder auf neue Funktionen als Verkaufsargument verweisen.

Wege zur Verteilung von Release Notes

Organisationen benötigen einen Plan, um Release Notes mit Kunden zu teilen. Eine gut geschriebene Release Note hat keinen Wert, wenn sie niemand sieht. Einige gängige Methoden zur Verteilung von Release Notes an eine breite Kundenbasis sind:

• E-Mail. Viele Benutzer geben eine E-Mail-Adresse an, wenn sie ein Produkt kaufen. E-Mail ist ein schneller Weg für Unternehmen, ihre Benutzer zu erreichen, wenn sie normalerweise eine gute Öffnungsrate haben.
• Webseite. Unternehmen können eine „Was gibt's Neues?“-Seite zu ihrer Website hinzufügen. Auf diese Weise haben Kunden einen festen Ort, um nach den neuesten Produktupdates und Release Notes zu suchen.
• Blog. Organisationen mit einem aktiven Blog auf ihrer Website können die Release Notes dort veröffentlichen. Ein Blogbeitrag kann jedoch manchmal untergehen, wenn das Unternehmen neue Inhalte veröffentlicht, daher sollten sie auch andere Kanäle nutzen.
• SMS oder Text. Für einige Organisationen bietet SMS eine weitere Möglichkeit, Kunden zu erreichen. Während ein ganzes Release Notes-Dokument zu lang ist, um in eine einzelne Nachricht zu passen, können sie auf eine Webseite oder einen Blogbeitrag verlinken.
• Soziale Netzwerke. Regelmäßige Inhalte auf sozialen Medien zu posten, baut Gemeinschaft und Beziehung zu Kunden auf und bietet einen weiteren Kanal zur Kommunikation wichtiger Informationen. Außerdem könnten Nicht-Nutzer auf die Nachricht stoßen und feststellen, dass das Produkt genau das bietet, was sie brauchen.

Best Practices für das Schreiben von Release Notes

Wenn sie gut gemacht sind, können Release Notes einen großen Einfluss auf die Benutzer haben. Organisationen sollten diese Best Practices befolgen:

• Halten Sie es klar und prägnant. Benutzer haben unterschiedliche Grade an technischem Wissen. Während einige branchenspezifische Begriffe unvermeidlich sein können, sollten Organisationen deren Verwendung einschränken. Stattdessen sollten sie sich um einfache Sprache bemühen.
• Formatierung anwenden. Durch das Hervorheben bestimmter Zeilen oder die Verwendung von Aufzählungspunkten macht das Team die Release Notes leicht zu überfliegen und zu verstehen.
• Persönlichkeit zeigen. Einige Menschen betrachten Release Notes als „trocken“, weil sie sich mit technischen Themen befassen. Wenn Unternehmen ihre Markenstimme oder Persönlichkeit verwenden, werden diese Dokumente für die Leser ansprechender. Das Hinzufügen von Fotos oder GIFs, wenn es angebracht ist, hilft ebenfalls.

Stellen Sie sicher, dass Ihre Markenidentität in Ihren Release Notes mit diesen Tipps durchscheint.