Best Practices für Versionshinweise: 7 großartige Beispiele und Vorlagen

Lassen Sie mich Ihnen ein Bild zeigen, das Sie wahrscheinlich kennen:

Siehe die „What's New“-Teile?

Dies sind wahrscheinlich die häufigsten Versionshinweise, von denen sogar Kinder wissen, dass sie existieren, und von denen sie Produktaktualisierungsinformationen erhalten.

Aber wussten Sie, dass die Art und Weise, wie Sie diese Versionshinweise entwerfen und schreiben, einen großen Einfluss darauf hat, wie die Leute Ihr Produkt wahrnehmen?

Ich wusste es selbst nicht.

Gott sei Dank bin ich nicht der Produktdesigner.

Aber ich weiß ein oder zwei Dinge darüber, warum das Format der Release-Notes wichtig ist und wie man passende Release-Notes schreibt.

Lassen Sie uns also ohne weiteres eintauchen:

Software Release Notes – warum sind sie notwendig?

Versionshinweise sind sehr wichtig, da sie ein konkreter Ort für die Kunden sind, um Informationen über die Produktaktualisierungen zu finden. Wenn Sie jedoch möchten, dass Ihre Kunden die Versionshinweise tatsächlich lesen , müssen sie ansprechend für das Auge sein.

Wenn nicht alle Ihre Kunden mit dem Customer Success Manager bestens vertraut sind oder nicht mit dem Account Manager in denselben Bingo-Club gehen, wissen sie wahrscheinlich nicht, was an Ihrem Produkt aktualisiert wurde oder was sich am ändern wird kommende Version.

Ich kenne nicht viele Leute, die die zukünftigen Versionshinweise als Priorität betrachten. Aber lassen Sie mich Ihnen sagen, ich werde Ihnen ein paar Unternehmen zeigen, die sich wirklich um die Struktur des Textes und das Design kümmern. Diese Jungs führen das Internet an.

Sie lassen Ihre Benutzer Erwartungen setzen.

Es fungiert als Wissensdatenbank darüber, was sich seit der vorherigen Version geändert hat, was in der aktuellen Version auf dem neuesten Stand ist und was in zukünftigen Versionen kommen wird.

Die Leute wollen wissen, ob die Abstürze behandelt wurden oder die Fehlerbehebungen behandelt wurden.

Ich höre Sie sagen „Aye, niemand liest jemals die Produktveröffentlichungshinweise“, und Sie haben recht. Aber das liegt nicht daran, dass sie unwichtig sind, sondern daran, dass sie schrecklich geschrieben sind.

Ich persönlich bin ziemlich aufgeregt, wenn ich die E-Mail „ClikcUpdates“ von ClickUp erhalte.

PS: Ich werde unten weitere Beispiele geben, gleich nachdem ich zwei weitere wichtige Dinge klargestellt habe:

Wer sollte Versionshinweise erstellen?

Die Versionshinweise sind das Ergebnis einer gemeinsamen Anstrengung.

Bevor Marketing und Support sie erstellen können, benötigen sie möglicherweise eine Übergabe oder eine Demo des Updates.

Um sicherzustellen, dass sie rechtzeitig geschrieben werden, benötigen Produktmanager möglicherweise einen Anstoß von den Support- oder Marketingteams .

Ein technischer Redakteur oder ein anderes Mitglied des Produkt-, Entwicklungs- oder Testteams kann Produktversionshinweise erstellen. Im Rahmen des Produkteinführungsprozesses wird häufig eine kollaborative Methode eingesetzt.

Was Sie in Ihre Versionshinweise aufnehmen sollten

Lassen Sie uns eine Liste aller notwendigen Elemente einer guten Vorlage für Versionshinweise erstellen:

1. Offensichtlich ein Header.
   Aber nicht nur ein langweiliger Titel. Sie können gerne etwas mehr Spaß und Kreativität in Ihren Kopfzeilen haben. Schreiben Sie nicht einfach „App Update Notes – Version 2.14“ oder „Performance Improvements“, sondern versuchen Sie „In Erinnerung an unsere alte Version …“ ( nur eine Idee)
2. Ein kurzer Überblick über die Neuheiten.
   Was hat sich verändert? Nur Bugfixes oder haben Sie die Funktionen komplett geändert? Vertrauen Sie mir, die Leute suchen nach dieser Art von Informationen und sie kümmern sich darum.
3. Angabe des gelösten Problems.
   Geben Sie die vorherigen Probleme mit Funktionen an und wie Sie sie gelöst haben – auch bekannt als Erwartungen setzen. Aber vergessen Sie nicht sicherzustellen, dass die Leute aus der Perspektive einer Person lesen, nicht aus einer Roboterschrift.
4. Auswirkungen und notwendige Maßnahmen.
   In den vorherigen Versionen war etwas anders, aber jetzt, da Änderungen an der Rückforderungsrichtlinie oder der Sicherheitsrichtlinie vorgenommen wurden, müssen Benutzer möglicherweise einige Konfigurationen bestätigen. Informieren Sie die Benutzer oder Kunden über alle notwendigen Schritte.

Release-Note-Verteilung – 5 Methoden

Ja, In-App-Benachrichtigungen zählen. Ja, die Leute öffnen die Freigabe-E-Mails, solange sie sich engagieren. Und ja, soziale Medien sind ein guter Ort, um solche Ankündigungen zu machen.

Hier ist wie:

1- E-Mail-Verteilung

Versionshinweise können Benutzern über eine E-Mail-Adresse oder eine Gruppe von Adressen gesendet werden. Ich kann dieser Überschrift nicht viel hinzufügen. Aber ich kann Ihnen ein gutes Beispiel zeigen:

2- Social Media & Community-Verteilung

Sie können auch einen Versionshinweis auf Twitter, Facebook, Google+ und LinkedIn veröffentlichen. Mit Social-Media-Beiträgen können Sie mehr Menschen erreichen. Es ist auch eine großartige Möglichkeit, Ihre Versionshinweise bei Nichtbenutzern zu bewerben.

3- Verbreitung als Website-Inhalt

Ihre Unternehmenswebsite kann einen Link zu Ihren Versionshinweisen enthalten. Oder Sie möchten vielleicht einen Blog-Eintrag über Ihre Version erstellen und einen Link zurück zu Ihren Versionshinweisen einfügen.

4- In-App-Verteilung

Eine Benachrichtigung wird angezeigt, wenn der Benutzer die App öffnet.

Wenn Sie eine Release Note nur per E-Mail versenden, erreicht sie nicht alle Ihre Kunden, bis sie ihre App erneut öffnen.

Eine In-App-Benachrichtigung ermöglicht es Ihnen, Ihre Nachricht in die Hände jedes neuen Kunden zu bringen, der die App öffnet.

5- Ankündigung des Anwendungsspeichers

Und schließlich die gängigsten Source-Software-Releases, die App-Store-Ankündigungen wie Google Play oder App Store. Wenn Sie sich am Anfang nicht an die entsprechenden Beispiele erinnern, finden Sie sie hier.

6 Beispiele für Software-Versionshinweise als Vorlagen

Jetzt ist es also an der Zeit, alles zu zeigen, worüber ich bisher gesprochen habe. Hier sind die 6 besten Beispiele für Feature-Update-Ankündigungen, darunter E-Mails, In-App, Social Media und alle anderen Beispiele.

1- Klicken Sie auf Updates

ClickUpdates ist der Name der Feature-Updates von ClickUp. Für mich macht sogar der Name Spaß genug, um die Website zu öffnen und zu lesen, was darin steht. Sieht es nicht aus wie ein Blog?

Dann kommt die Gestaltung. Dieses Design hat mehrere gute Seiten:

• Es ist bunt
• Obwohl es bunt ist, hat es viel Leerraum
• Die Schriftarten sind lesbar
• Die Textgröße erregte die Aufmerksamkeit
• Sie haben eine Liste ihrer Autoren. Wir wissen, dass es menschlich ist.

Der einzige Nachteil dieses Designs ist, dass die Updates keine Header haben. Für Menschen, die ihnen nicht regelmäßig folgen, kann es schwierig sein, das zu finden, was sie brauchen. Aber das Innere der Versionshinweise ist noch besser:

2- Slack-Versionshinweise

Ich persönlich lese die Versionshinweise nicht regelmäßig, aber wenn ich etwas über ein Produkt herausfinden muss, beginne ich dort zu suchen.

Slack hat mich nie im Stich gelassen, wenn es darum geht, mich finden zu lassen, was ich brauche.

Das liegt vor allem daran, dass das Kategorisierungssystem und die Übersichtlichkeit der Texte einfach auf den Punkt kommen.

Sie können sogar nach bestimmten Softwareversionen suchen.

Slack hatte nicht das Bedürfnis, jedes einzelne Detail der Fehler und ihrer Lösung anzugeben, vermied es daher, komplizierte Wörter zu verwenden, und schaffte es, die Notizen kurz und interessant zu halten.

Außerdem hat Slack beide ihre Inhalte für die Angelegenheit, und Sie können die Neuigkeiten in der App finden.

3- Für Sie gebaute Gegensprechanlage

Das Design hat mich mitten ins Herz getroffen.

Wenn etwas „für mich“ dabei ist, nehme ich es bitte.

Genau wie die Versionshinweise von Intercom.

Obwohl der weiße Raum weniger als gewünscht ist, kann ich die zukünftigen Versionen und die Funktionen, die ich suche, klar erkennen.

Das Design oben, die Kategorisierungsoptionen, die Art und Weise, wie sie den Raum verkürzt haben, den der Text bedeckt … Alles auf den Punkt gebracht.

Und sie haben auch nicht vergessen, die relevanten Links zu den erforderlichen Profilen hinzuzufügen.

Es gibt 2 weitere Dinge auf der Seite von Intercom, die sie hervorheben:

Die Verwendung von Etiketten, um relevante Informationen zusammenzuhalten

Die Art und Weise, wie sie eine kleine Zufriedenheitsumfrage unten anbringen, damit die Kunden die Funktionen bewerten können.

4- Unsplash

Unsplash ist eine kollaborative Fotografie-Website, die ihre Dienste nicht jede Woche aktualisieren muss.

Daher veröffentlichen sie einfach Artikel auf ihrem Blog, um regelmäßige Leser über die neue Version zu informieren.

Da sie nicht regelmäßig Aktualisierungen von Rückforderungsrichtlinien oder Sicherheitsrichtlinien veröffentlichen, ist ihre Methode wahrscheinlich die beste, die für sie funktioniert.

So sieht einer ihrer gut gestalteten Blog-Posts aus:

5- Moodle

Aus dem Bild unten weiß ich, dass Sie vielleicht denken: „Wie um alles in der Welt ist das ein gutes Beispiel?“

Aber wenn Sie genau hinsehen, können Sie sehen, dass das Diagramm, das jede einzelne Version des Produkts visualisiert, eine erstaunliche Idee ist.

Ich wünschte wirklich, sie könnten etwas mehr Mühe in ihre Seite stecken. Es hat wirklich das Potenzial, noch besser zu werden als die Seite mit den Softwareversionen von ClickUp.

Wenn wir schon dabei sind, lassen Sie uns diskutieren, warum diese Seite nicht mein Favorit werden konnte:

Die Schriftarten sind zu klein zum Lesen

Es gibt viel Fachjargon

Die Farben sind überhaupt nicht ansprechend

6-Microsoft

Es liegt hauptsächlich am Design und den Richtlinien von Microsoft, aber schauen Sie sich nur diese weiße und schöne Seite an.

Ich habe wirklich das Bedürfnis zu betonen, wie wichtig die Menge an Weißraum auf einer Seite ist. Ja, auch für die Software-Release-Seite.

Aber was meine Aufmerksamkeit erregte, war die kleine Notiz.

Es wird kurz darüber gesprochen, was die Kunden von den neuen Versionen erwarten sollten, oder genauer gesagt, wann sie damit rechnen sollten.

Obwohl es nicht das umfassendste ist und keine Suchschaltfläche hat, hat Microsoft es geschafft, eine Art Kategorisierung anzubieten, um es einfacher zu machen, das zu finden, was Sie brauchen.  

Fazit

Das Schreiben und Entwerfen von Versionshinweisen ist eines der Dinge, die unnötig erscheinen, aber tatsächlich eine große Wirkung haben.

Auch die Vorbereitung mag sich wie eine Last anfühlen, sie sind eigentlich ziemlich einfach.

Ich hoffe, ich konnte Ihnen dabei helfen, ein besseres Verständnis der Best Practices für die Erstellung von Softwareversionen und deren Ankündigung zu erlangen.

Häufig gestellte Fragen

Was sind die 5 Hauptpunkte, die Teil der Vorlage für Versionshinweise sein müssen?

Erstens sollten Sie eine einfache Sprache haben, die leicht verständlich ist. Zweitens sollten die Versionshinweise kurz sein. Drittens sollten sie logisch und nicht zufällig gruppiert werden. Außerdem sollten relevante Links enthalten sein. Und schließlich sollten die Leute in der Lage sein, den Ton Ihres Unternehmens aus den Versionshinweisen herauszulesen.

Wie sieht eine gute Release Note aus?

Eine gute Release Note hat eine fette Überschrift, die nicht nur „Update Nr. 10“ sagt, einen einfachen, aber erklärenden Körper, der menschlich klingt, und eine einfache Beschreibung der notwendigen Bestätigung.

Wie erstelle ich eine Release Note in Jira?

Das Erstellen einer Release-Note-Release in Jira ist kein schwieriger Prozess, obwohl es einige Details enthält. Hier erfahren Sie, wie Sie die besten Versionshinweise in Jira erstellen.

{“@context”:”https://schema.org”,”@type”:”FAQPage”,”mainEntity”:[{“@type”:”Question”,”name”:”Was sind die 5 wichtigsten Punkte, die Teil der Vorlage für Versionshinweise sein müssen?”,”acceptedAnswer”:{“@type”:”Answer”,”text”:” Zunächst sollten Sie eine einfache Sprache haben, die leicht verständlich ist. Zweitens sollten die Versionshinweise kurz sein. Drittens sollten sie logisch und nicht zufällig gruppiert werden. Außerdem sollten relevante Links enthalten sein. Und schließlich sollten die Leute in der Lage sein, den Ton Ihres Unternehmens aus den Versionshinweisen herauszulesen.“}},{„@type“:“Question““,name“:“Wie sieht ein guter Versionshinweis aus?“,“acceptedAnswer ”:{“@type”:”Answer”,”text”:” Eine gute Release Note hat eine fettgedruckte Überschrift, die nicht nur „Update Nr. 10“ sagt, einen einfachen, aber erklärenden Körper, der menschlich klingt, und eine einfache Beschreibung der erforderlichen Bestätigung.“}},{“@type“:“Question““,“name“:“Wie erstelle ich eine Release Note in Jira?“, „acceptedAnswer“:{“@type“:“Answer“, „text“: „Das Erstellen einer Release-Note-Version in Jira ist kein schwieriger Prozess, obwohl es einige Details enthält. Hier erfährst du, wie du die besten Versionshinweise in Jira erstellst.“}}]}