リリースノートのベストプラクティス：7つの優れた例とテンプレート

公開: 2021-12-24

あなたがおそらくよく知っている写真をお見せしましょう：

「新機能」の部分を参照してください。

これらはおそらく、子供でさえ存在し、製品の更新情報を入手することを知っている最も一般的なリリースノートです。

しかし、これらのリリースノートをどのように設計および作成するかが、人々があなたの製品をどのように認識するかに大きな影響を与えることをご存知ですか？

自分では知りませんでした。

ええと、私はプロダクトデザイナーではありません。

しかし、リリースノートの形式が重要である理由と、適切なリリースノートの書き方については1つか2つ知っています。

それで、それ以上の苦労なしに、それに飛び込みましょう：

ソフトウェアリリースノート–なぜそれらが必要なのですか？

リリースノートは、顧客が製品の更新に関する情報を見つけるための具体的な場所であるため、非常に重要です。それでも、顧客に実際にリリースノートを読んでもらいたいのであれば、彼らは目に魅力的でなければなりません。

すべての顧客がカスタマーサクセスマネージャーに最適ではない場合、またはアカウントマネージャーと同じビンゴクラブに行かない場合、製品で何が更新されたか、または何が変更されるかを知らない可能性があります。今後のバージョン。

将来のリリースノートを優先する人はあまりいません。しかし、私はあなたに言わせてください、私はあなたにテキストの構造とデザインに本当に気を配っているいくつかの会社をあなたに示すつもりです。 それらの人はインターネットをリードしています。

彼らはあなたのユーザーに期待を設定させます。

これは、前のリリースから何が変更されたか、現在のリリースで何が最新であるか、および将来のリリースで何が来るかについての知識ベースとして機能します。

クラッシュが処理されたか、バグ修正が処理されたかを知りたがっています。

「はい、製品のリリースノートを読む人は誰もいません」とおっしゃっていますが、その通りです。 しかし、それは重要ではないからではなく、ひどく書かれているからです。

ClickUpから「ClikcUpdates」メールを受け取ったとき、私は個人的にかなり興奮しています。

PS：2つの重要なことを明確にした直後に、以下にさらに例を示します。

誰がリリースノートを作成する必要がありますか？

リリースノートは、共同作業の結果です。

マーケティングとサポートがそれらを作成する前に、更新のハンドオフまたはデモが必要になる場合があります。

それらが時間通りに書かれることを確実にするために、製品マネージャーはサポートまたはマーケティングチームからのプッシュを必要とするかもしれません。

テクニカルライターまたは製品、開発、またはテストチームの他のメンバーは、製品のリリースノートを作成できます。共同手法は、製品の発売プロセスの一部として頻繁に使用されます。

リリースノートに含めるもの

優れたリリースノートテンプレートに必要なすべての要素のリストを作成しましょう。

明らかに、ヘッダー。
しかし、退屈な古いタイトルだけではありません。ヘッダーでもう少し楽しくクリエイティブになることを歓迎します。「AppUpdateNotes– Version 2.14」や「PerformanceImprovements」と書くだけでなく、「In memory of our old version…」（単なるアイデア）を試してみてください。
新機能の概要。
変化したこと？バグ修正のみですか、それとも機能を完全に変更しましたか？私を信じてください、人々はこの種の情報を検索し、彼らは気にします。
解決された問題のステートメント。
機能とそれをどのように解決したかについての以前の問題を述べてください-別名、期待を設定します。ただし、ロボットの台本ではなく、人の視点から読むようにすることを忘れないでください。
影響と必要なアクション。
以前のバージョンでは何かが異なっていましたが、再利用ポリシーまたはセキュリティポリシーに変更が加えられた可能性があるため、一部の構成を確認する必要がある場合があります。実行する必要のあるすべての手順について、ユーザーまたはクライアントに知らせます。

リリースノートの配布–5つの方法

はい、アプリ内通知は重要です。はい、人々は彼らが従事している限り、リリースメールを開きます。そしてそうです、ソーシャルメディアはそのような発表をするための有効な場所です。

方法は次のとおりです。

1-メール配信

リリースノートは、電子メールアドレスまたはアドレスのグループを介してユーザーに送信できます。このヘッダーに追加できるものは何もありません。しかし、私はあなたに良い例を示すことができます：

2-ソーシャルメディアとコミュニティの配布

Twitter、Facebook、Google +、LinkedInにリリースノートを投稿することもできます。ソーシャルメディアの投稿により、より多くの人々にリーチできます。また、リリースノートを非ユーザーに宣伝するための優れた方法でもあります。

3-ウェブサイトコンテンツとしての配布

会社のWebサイトに、リリースノートへのリンクが含まれている場合があります。または、リリースに関するブログエントリを作成し、リリースノートへのリンクを含めることもできます。

4-アプリ内配信

ユーザーがアプリを開くと、通知が表示されます。

メールのみでリリースノートを送信した場合、顧客がアプリを再度開くまで、すべての顧客に届くことはありません。

アプリ内通知を使用すると、アプリを開いたすべての新規顧客にメッセージを届けることができます。

5-アプリケーションストアのお知らせ

そして最後に、最も一般的なソースソフトウェアのリリースである、GooglePlayやAppStoreなどのアプリケーションストアの発表です。最初に関連する例を覚えていない場合は、ここでそれらを見つけることができます。

テンプレートとして機能する6つのソフトウェアリリースノートの例

さて、今が私がこれまで話してきたことすべてを示す時です。これは、メール、アプリ内、ソーシャルメディア、その他すべての例を含む、6つの最高の機能更新アナウンスの例です。

1-ClickUpdates

ClickUpdatesは、ClickUpの機能更新の名前です。私にとって、名前でさえ、ウェブサイトを開いてその中身を読み始めるのに十分楽しいです。 ブログみたいじゃないですか？

次に、デザインが登場します。この設計には複数の良い面があります。

カラフルです
カラフルなのに余白が多い
フォントは読み取り可能です
テキストサイズが注目されました
彼らは彼らの作家のリストを持っています。私たちはそれが人間であることを知っています。

この設計の唯一の欠点は、更新にヘッダーがないことです。定期的にフォローしていない人は、必要なものを見つけるのが難しい場合があります。しかし、リリースノートの内部はさらに優れています。

2-Slackリリースノート

個人的にはリリースノートを定期的に読むことはありませんが、製品について何かを理解する必要があるときは、そこから探し始めます。

Slackは、私が必要なものを見つけられるようにすることについて、私をがっかりさせたことはありません。

これは主に、分類システムとテキストの明確さが適切であるためです。

特定のソフトウェアリリースを検索することもできます。

Slackは、バグが何であるか、どのように解決されたかを詳細に説明する必要性を感じていなかったため、複雑な単語の使用を避け、メモを短く興味深いものに保つことができました。

また、Slackには両方ともその問題に関するコンテンツがあり、アプリ内で最新情報を見つけることができます。

3-あなたのために構築されたインターホン

デザインは心から私を襲った。

「私のために」何かあったら、持っていきます。

インターコムのリリースノートと同じように。

余白は少ないですが、今後のリリースや探している機能がはっきりとわかります。

上部のデザイン、分類オプション、テキストがカバーするスペースを短縮する方法…すべてが適切です。

また、必要なプロファイルへの関連リンクも含めることを忘れませんでした。

インターコムのページには、他に2つの点があります。

関連情報をまとめるためのラベルの使用

クライアントが機能を評価するために、彼らが一番下に少し満足度調査を置く方法。

4-スプラッシュを解除

Unsplashは、毎週サービスを更新する必要のない共同写真のWebサイトです。

したがって、彼らは単にブログに記事を公開して、新しいバージョンについて定期的な読者に知らせます。

彼らは定期的に再利用ポリシーやセキュリティポリシーの更新を公開していないので、彼らの方法はおそらく彼らのために働く最良のものです。

うまく設計されたブログ投稿の1つは次のようになります。

5-Moodle

下の画像から、「これは一体どうやって良い例なのか」と思われるかもしれません。

しかし、よく見ると、製品のすべてのバージョンを視覚化したチャートが素晴らしいアイデアであることがわかります。

私は彼らが彼らのページにもう少し努力を払うことができることを本当に望んでいます。 ClickUpのソフトウェアリリースページよりもさらに良くなる可能性があります。

その間、このページが私のお気に入りにならない理由について説明しましょう。

フォントが小さすぎて読めません

専門用語がたくさんあります

色はまったく魅力的ではありません

6-マイクロソフト

これは主にMicrosoftの設計とポリシーによるものですが、この白くて美しいページを見てください。

ページ上の空白の量がいかに重要であるかを強調する必要性を本当に感じています。はい、ソフトウェアリリースページについても同様です。

しかし、実際に私の注意を引いたのは小さなメモでした。

クライアントが新しいバージョンに何を期待すべきか、より具体的には、いつ期待すべきかについて簡単に説明します。

また、これは最も包括的ではなく、検索ボタンもありませんが、Microsoftは、必要なものを簡単に見つけられるように、なんらかの分類を提供することができました。

結論

リリースノートの作成と設計は、不要に思えますが、実際には大きな影響を与えるものの1つです。

また、それらを準備することは負担のように感じるかもしれません、それらは実際にはかなり単純です。

ソフトウェアリリースを作成するためのベストプラクティスとそれらを発表する方法をよりよく理解するために、私があなたの助けになったと思います。

よくある質問

リリースノートテンプレートの一部である必要がある5つの主要なポイントは何ですか？

まず、理解しやすいシンプルな言語が必要です。次に、リリースノートは短くする必要があります。第三に、それらはランダムではなく論理的にグループ化する必要があります。また、関連するリンクを含める必要があります。そして最後に、人々はリリースノートからあなたの会社のトーンを読むことができるはずです。

良いリリースノートはどのように見えますか？

優れたリリースノートには、「update no 10」とだけでなく、人間らしいシンプルで説明的な本文と、必要な確認の簡単な説明が記載された太字のヘッダーがあります。

Jiraでリリースノートを作成するにはどうすればよいですか？

Jiraでリリースノートリリースを作成するのは難しいプロセスではありませんが、詳細は含まれています。ここでは、Jiraで最高のリリースノートを作成する方法を学ぶことができます。

{“ @context”：” https://schema.org”、” @ type”：” FAQPage”、” mainEntity”：[{“ @ type”：” Question”、” name”：”5つのメジャーは何ですかリリースノートテンプレートの一部である必要があるポイント？」、「acceptedAnswer」：{「@ type」：「Answer」、「text」：」まず、理解しやすいシンプルな言語が必要です。次に、リリースノートは短くする必要があります。第三に、それらはランダムではなく論理的にグループ化する必要があります。また、関連するリンクを含める必要があります。そして最後に、リリースノートから会社のトーンを読み取れるようにする必要があります。”}}、{“ @ type”：” Question”、” name”：”優れたリリースノートはどのように見えますか？”、” acceptedAnswer ”：{“ @ type”：” Answer”、” text”：”優れたリリースノートには、「update no 10」とだけでなく、人間らしいシンプルで説明的な本文と簡単な説明が記載された太字のヘッダーがあります。必要な確認の。”}}、{“ @ type”：” Question”、” name”：” Jiraでリリースノートを作成するにはどうすればよいですか？”、” acceptedAnswer”：{“ @ type”：” Answer”、 ” text”：” Jiraでリリースノートリリースを作成することは難しいプロセスではありませんが、詳細は含まれています。ここでは、Jiraで最高のリリースノートを作成する方法を学ぶことができます。」}}]}