So schreiben Sie (bessere) Versionsnotizen in 7 Schritten

Key Takeaways

• Verstehen Sie Ihre Zielgruppe und ihre Gründe für das Lesen der Versionshinweise. Dies führt den Ton, den Inhalt und die Präsentation der Notizen.
• Dokumentieren Sie klar die in der aktuellen Version vorgenommenen Änderungen, wenn Sie berücksichtigen, was Ihre Leser wissen müssen und wann sie Zugriff auf die Informationen benötigen.
• Entscheiden Sie, was in die Versionshinweise aufgenommen werden soll, und balancieren Sie die Tiefe der Abdeckung für jeden Artikel basierend auf seiner wahrgenommenen Bedeutung oder Komplexität.
• Verwenden Sie gut geschriebene Versionshinweise als Grundlage für andere Kommunikation, z. B. Blog-Beiträge oder E-Mails, um neue Produktfunktionen in verschiedenen Benutzersegmenten hervorzuheben.

Für einige Unternehmen sind Versionsnotizen die einzige Möglichkeit, Produktverbesserungen mit Kunden mitgeteilt zu haben. Für andere sind sie eine Seitenlinie, die vollständig getrennt von der Benutzerkommunikation entwickelt wurde.

, aber wenn Sie mehr mit weniger tun möchten - wenn Sie die Kundenbindungskommunikation verbessern möchten, ohne einen Stapel mehr Arbeit ausführen zu müssen - könnten Ihre Release -Notizen eine unerwartete, aber wertvolle Antwort sein. Vor allem, wenn sie gut gemacht sind.

Versionshinweise Dokumentieren Sie neue Funktionen, Verbesserungen der Funktionalität und Fehlerbehebungen. Sie sind normalerweise präzise und ziemlich direkt und nehmen natürlich ein Maß an Vertrautheit mit Ihrem Produkt aus. Der nachstehende Prozess, den ich unten ausgelegt habe, sollte es einfach machen, gute Qualitätsnotizen für Ihr Produkt zu erstellen, die diesen Bedarf für Ihr Unternehmen und Ihre Kunden erfüllen.

, wenn Sie möchten, bietet dieser Prozess Ihnen auch ein solides Futter für andere Release -Kommunikation - wie E -Mails oder Blog -Posts oder Funktionen, die die Kunden daran erinnern können, wie engagiert Sie sich zur Verbesserung dessen verbessern, was Sie ihnen anbieten. Und seien wir ehrlich, wir alle wollen wissen, dass wir geliebt werden, auch nachdem wir uns eine Wahl getroffen und uns mit einem Service angemeldet haben.

Mal sehen, wie dies für Sie funktionieren kann.

1. Machen Sie sich Ihrer Zielgruppe und dem Zweck der Notizen

klar

Wer liest Versionsnotizen? Bei einigen Produkten wird die Mehrheit der Benutzer jede Release -Notiz überprüfen. Für andere handelt es sich um eine sehr ausgewählte, spezifische Teilmenge der Hauptbenutzerbasis.

Wenn Sie wissen, für wen Sie die Versionshinweise erstellen, können Sie verstehen, warum sie die Notizen lesen. Und das treibt den nächsten Schritt an.

Die Versionshinweise für das Produkt, an dem ich arbeite, werden von niemandem gelesen, sondern von einem sehr kleinen Prozentsatz der Benutzer in wichtigen Kundenkonten. Und sie haben sehr spezifische Gründe für das Lesen der Versionshinweise - einige haben eine interne Dokumentation, die sie zum Beispiel auf dem Laufenden halten müssen.

Aber für einige Produkte werden die Versionshinweise von einem großen Teil von Benutzern gelesen, die den Marketing -Spin vermeiden möchten - die das Produkt ins Herz des Produkts erreichen und direkt von seinen Machern hören möchten. Solche Wissenswissenschaften informieren nicht nur, was Sie einschließen und ausschließen - es kann sich auf den Ton auswirken, in dem Sie die Notizen schreiben, und wie Sie sie präsentieren.

2. Trainieren, was sie wissen müssen

Es wird allgemein erwartet, dass

Veröffentlichungsnotizen dokumentieren, welche Änderungen in der aktuellen Version Ihres Produkts vorgenommen wurden. Natürlich haben Sie eine Vorstellung davon, was Sie Ihre Leser wissen müssen.

Aber es ist auch wichtig, darüber nachzudenken, was Ihre Leser für sie wissen müssen. Zum Beispiel dokumentieren wir Fehlerbehebungen auf eine Weise, die sicherstellt, dass jeder, der gemeldet oder bemerkt hat, dass der Fehler ihn in der Liste identifizieren kann, und wissen, dass er behoben wurde. Aber wir werden nicht in jeder Fehlerbehebung tiefe, da niemand alle diese Informationen lesen muss (oder, um ehrlich zu sein).

Zu diesem Zeitpunkt ist es auch eine gute Idee zu berücksichtigen, wenn Ihre Leser Zugriff auf die Versionshinweise benötigen. Am Tag der Veröffentlichung? Eine Woche zuvor haben sie Zeit, sie zu überprüfen? Dies hilft Ihnen dabei

3. Identifizieren Sie, was Sie in dieser Version

getan haben

Es klingt einfach genug, aber wenn Sie für diesen Schritt einen guten Prozess einrichten, wird die Produktion jeder Release -Note geglättet.

Zum Beispiel können Sie sich für ein gemeinsames Dokument entscheiden, das Ihre Entwickler und Produktbesitzer nach Abschluss der Arbeiten und nicht am Ende aktualisieren können, wodurch Sie versuchen können, die Notizen in einem Eile zu kompilieren.

Sie können das Dokument auch in Abschnitte einteilen, die die normalerweise geleisteten Arbeiten widerspiegeln - z. B. neue Funktionen, Verbesserungen der vorhandenen Funktionen und Fehlerbehebungen. Dies erleichtert es leicht zu erkennen, ob alles in der Veröffentlichung in das Dokument aufgenommen wurde.

erleichtert es auch einfacher, die Versionshinweise selbst zu strukturieren, als wenn Sie einfach eine unstrukturierte Liste neuer Dinge hatten.

4. Entscheiden Sie, was Sie benötigen, um

einzuschließen

Da sie Informationen zu Ihrem Release -Notiz -Dokument beitragen, werden Ihre Entwickler und Produktbesitzer wahrscheinlich nicht über den Endbenutzer nachdenken. Wenn es darum geht, die Versionshinweise vorzubereiten, müssen Sie herausfinden, welche Informationen enthalten sind und welche weggelassen werden können.

Ich denke besonders an Fehlerbehebungen, die ich oben erwähnt habe, aber Sie müssen möglicherweise auch die flüchtigen Beiträge einiger gegen die dünneren Beiträge anderer in die Notizen ausgleichen.

Mehr Wörter, Screenshots und Details zu einer Funktion oder Verbesserung als eine andere werden im Allgemeinen zur Reflexion der relativen Bedeutung oder Komplexität dieses Elements berücksichtigt. Denken Sie also daran, wie tief Sie sich in jedem Element in einem Element befassen werden. die Liste.

5. Arbeiten Sie eine Handlung oder Messaging aus, wenn Sie

benötigen

Es wird nicht immer benötigt, aber manchmal kann eine Handlung dazu beitragen, Ihre Verbesserungen in den Kontext zu setzen. Ich spreche nicht davon, hier Wörter hinzuzufügen oder Ihre netten, prägnanten Versionshinweise in ein Marketing -Tool zu verwandeln. Ich meine, die Reihenfolge, in der Sie Ihre Informationen präsentieren, können Benutzern helfen, die von Ihnen vorgenommenen Änderungen zu verstehen. Also denken Sie das durch.

Zum Beispiel machte eine kürzlich von mir erstellte Veröffentlichungsnotiz ein Facelifting für das Produkt sowie eine wichtige Feature -Ergänzung. Das Facelift beinhaltete lediglich kosmetische Änderungen - es hatte keine Auswirkungen auf die Funktionalität der Positionen der Elemente in der Schnittstelle. Die Feature-Addition war eine viel größere Arbeit mit größeren langfristigen Auswirkungen auf Benutzer.

Welches würdest du zuerst abdecken? Wir haben uns für das Facelift entschieden, da die Benutzer beim nächsten Mal zuerst bemerken würden, wenn sie unsere Software verwenden. Die neue Funktion wurde danach aufgeführt, enthielt jedoch mehr Screenshots und Details. Einer der Gründe, warum dies sinnvoll war, war, dass die neue Funktion deutlich anders aussah als viel von dem Rest der App. Wenn wir sie also in den Kontext einer visuellen Aktualisierung stellten, überspringen wir mehr Diskussion über diese Tatsache.

6. Entwerfen Sie Ihre Notizen

Die meisten Benutzer erwarten, dass Release direkt und präzise angegeben ist. Sie sind da, um die Fakten zu bekommen. Das heißt, es ist wahrscheinlich am besten, jede Funktion oder Fix aus Sicht Ihrer Zielgruppe zu interpretieren. Was bedeutet es für sie?

Zum Beispiel kann eine Änderung Ihrer App Ihre Support -Mitarbeiter erleichtern, zusätzliche Benutzerkonten für Unternehmens -Clients einzurichten. Für Benutzer der Versionshinweise bedeutet dies: Es ist für neue Mitarbeiter mit diesen Kunden schneller oder einfacher, Zugriff auf das Unternehmenskonto zu erhalten. Setzen Sie es also in diese Begriffe.

7. Verwenden Sie, was Sie für andere Kommunikation benötigen

Wenn sie gut geplant und geschrieben sind, können Ihre Versionshinweise als Sprungbrett für andere Mitteilungen fungieren, die möglicherweise auf andere Benutzerpublikumssegmente gerichtet sind, um hervorzuheben, was Neue in Ihrem Produkt ist.

Sobald Sie die Versionshinweise festgelegt haben, sollte es ziemlich leicht sein, zu sehen, was in In-App-Benachrichtigungen oder -touren neu formuliert werden kann, die zur Überprüfung von Hilfeinhalten verwendet werden, und in Blog-Posts, Newsletter-Elementen und zu entwickeln und entwickelt wurden. Andere Aufbewahrungsinhalte.

Wie entwickeln Sie Versionshinweise?

das ist es - nicht ein schwieriges Verfahren, obwohl, wenn Sie eine Reihe von beweglichen Teilen in Ihrem Produktionsprozess haben, die Versionshinweise dauern können.

Aber wenn Sie gute Versionshinweise erstellen, können Sie viel mehr aus der Arbeit herausholen, die Sie in sie gelegt haben. Sie können Ihnen einen echten Vorsprung geben, wenn es darum geht, über Änderungen an einem breiteren Publikum zu kommunizieren, als Ihre Versionshinweise jetzt lesen.

Haben Sie einen Prozess zum Erstellen von Versionshinweise? Und spielen sie in Ihre Kundenbindung? Ich würde gerne hören, wie Sie es in den Kommentaren machen.

häufig gestellte Fragen zum Schreiben besserer Versionshinweise

Was sind die wichtigsten Elemente, die in effektive Versionshinweise enthalten sind? Es ist auch von Vorteil, einen Abschnitt für Anerkennungen und eine Schlussfolgerung aufzunehmen. Der Titel sollte präzise und beschreibend sein, während die Einführung einen kurzen Überblick über die Veröffentlichung geben sollte. Die Liste der neuen Funktionen, Verbesserungen und Fehlerbehebungen sollte detailliert und leicht verständlich sein. In dem Abschnitt „Bekannte Probleme“ sollten Benutzer über potenzielle Probleme informiert werden und wie sie vermieden werden. Zuletzt können die Anerkennung und Schlussfolgerung verwendet werden, um dem Team und den Benutzern zu danken und Informationen zu zukünftigen Updates bereitzustellen. Notizen ansprechender, verwenden Sie einen Gesprächston und vermeiden Sie den technischen Jargon. Verwenden Sie Kugelpunkte und Unterschreitungen, um den Text aufzubrechen und das Lesen leichter zu lesen. Geben Sie Bildsbilder wie Screenshots oder GIFs ein, um neue Funktionen oder Verbesserungen zu veranschaulichen. Sie können auch Benutzer -Testimonials oder Zitate des Entwicklungsteams einbeziehen, um eine persönliche Note hinzuzufügen.

Wie oft sollte ich Versionshinweise veröffentlichen? . Wenn Sie regelmäßige Updates haben, veröffentlichen Sie die Veröffentlichung von Versionshinweise mit jeder neuen Version am besten. Wenn Updates jedoch weniger häufig sind, können Sie Viertel oder halbjährlich Versionshinweise veröffentlichen. Der Schlüssel ist, Ihre Benutzer über die Änderungen und Verbesserungen Ihres Produkts auf dem Laufenden zu halten. Vermeiden Sie Ihr Produkt, vermeiden Sie es, zu viele technische Details in Ihre Versionshinweise aufzunehmen. Konzentrieren Sie sich stattdessen auf die Erklärung der Vorteile der neuen Funktionen oder Verbesserungen der Benutzer. Bei Bedarf können Sie einen Link zu einer detaillierteren technischen Dokumentation angeben.

Wie kann ich Feedback zu meinen Versionshinweise erhalten? . Fügen Sie einen Feedback -Formular oder einen Kommentarbereich in Ihre Versionshinweise hinzu. Sie können auch Social Media- oder Benutzerforen verwenden, um Feedback zu sammeln. Dies hilft Ihnen nicht nur dabei, Ihre Versionshinweise zu verbessern, sondern auch eine stärkere Beziehung zu Ihren Benutzern aufzubauen.

Wie kann ich Versionshinweise verwenden, um mein Produkt zu bewerben? Markieren Sie die neuen Funktionen und Verbesserungen in Ihrem Produkt und erklären Sie, wie sie den Benutzern zugute kommen können. Sie können auch einen Aufruf zum Handeln aufnehmen und Benutzer ermutigen, die neue Version auszuprobieren oder Feedback zu geben. Teilen Sie Ihre Versionshinweise auf Ihrer Website, Ihren sozialen Medien und Ihrer E -Mail -Newsletter mit, um ein breiteres Publikum zu erreichen.

Was soll ich in meinen Versionshinweise vermeiden? Negative Sprache in Ihren Release -Notizen. Vermeiden Sie es außerdem, zukünftigen Updates zu versprechen, es sei denn, Sie können sicher sein. Halten Sie Ihre Release -Notizen präzise, ​​klar und konzentrieren sich auf die Bedürfnisse des Benutzers. . Brechen Sie den Text mit Aufzählungszeichen und Unterichtungen auf und verwenden Sie Visuals, um komplexe Konzepte zu veranschaulichen. Stellen Sie außerdem sicher, dass Ihre Versionshinweise auf Ihrer Website oder App leicht zu finden sind.

Sollte ich meine Versionshinweise in andere Sprachen übersetzen? Gute Idee, Ihre Versionshinweise in andere Sprachen zu übersetzen. Dies hilft Ihnen dabei, ein breiteres Publikum zu erreichen und zu zeigen, dass Sie Ihre internationalen Benutzer schätzen.

Wie kann ich meine Versionshinweise im Laufe der Zeit verbessern? Ihre Release -Notizen. Verwenden Sie diese Informationen, um Verbesserungen und Anpassungen vorzunehmen. Halten Sie auch mit Best Practices und Trends beim Schreiben von Release -Notizen Schritt. Denken Sie daran, effektive Freisetzungsnotizen sind ein Ergebnis des kontinuierlichen Lernens und der Verbesserung.

Das obige ist der detaillierte Inhalt vonSo schreiben Sie (bessere) Versionsnotizen in 7 Schritten. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!