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

製品のリリース ノートを作成する人は皆、面倒で退屈、そして時間がかかると感じるでしょう。 文字通り、リリース ノートから逃げ出す人をよく見かけます。 しかし、ビジネスの成長のためには、製品リリース ノートを発行し、変更履歴を更新し続けることが重要であることを覚えておいてください。 この記事では、リリースノートのテンプレートについても見ていきます。

変更履歴サービスを運営する傍ら、私たちもリリースノートを頻繁に扱っています。 私たちは、製品で行った最近の変更改善について、ユーザーに常に更新しています。 そこで、このプロセス全体をより耐えやすく効果的にするためのテクニックを開発しました。

リリース ノートとは？ 普遍的な形式はありませんが、典型的なリリース ノートには、バグ修正、新機能、そして時には既知の問題についての情報が含まれています。 リリースノートは、誰も好き好んで読んだり書いたりしない退屈な技術文書になりかねません。 しかし、プロダクト マネージャーとしての私たちの使命は、これらのノートをより魅力的で、面白く、有益なものにすることです。

リリース ノートの問題点は何でしょうか。 小さな会社でも、技術チームは、何が変わったのかを説明するのが難しいのです。 多くの場合、彼らは何かを修正し、数週間後には、今月何をしたのか忘れてしまいます。 彼らは、コンピュータサイエンスの博士号を持つ人々のために非常に技術的なリリースノートを書く傾向があります。
読者は、何かがどのように修正されたかに関心がなく、最終結果にしか関心がありません。 5669>

Tips on writing release notes (with templates)

リリース ノートにおけるユーモアの話題は後回しにして、リリース ノート情報の大部分は理解しやすい形にテンプレート化することが可能です。 そのため、次回、開発者が修正されたバグや新機能に関するノートを送ってきたとき、あなたたちはともに時間を節約できます。
そのため、開発者から意味のわからないコメントを受け取るのではなく、「これは何ですか？ 何が変わったのか、それをエンドユーザーにどう伝えるのが良いのか、より深く理解できるようになります。
そこで、優れたリリースノートを作るために私が使っているヒントやトリックの個人的なリストを紹介します! インスピレーションを得て、あなた自身の製品リリースノートのテンプレートを書いてみてください。 ソフトウェア製品のリリースノートのテンプレートは、時間を節約するのに最適な方法です

1. They > We

We’ve done this（私たちはこれをやりました）で始めないでください。 ユーザーは、あなたが何をしたかに関心はなく、あなたがしたことから何を受け取るかにのみ関心があるのです。
New Releaseは、あなたが使うことができるようになりました。

2.Focus on user

「YOU」をもっと頻繁に使いましょう。 文字情報の受け止め方を瞬時に変えるコピーライティングのコツです。 彼らは「あなた」を見たときに、無意識にテキストを読む可能性が高くなります。

あなたにとって素晴らしいニュースです！ユーザーからのフィードバックを収集できます。
データ損失を避けるのに役立つ嬉しいお知らせです。

3 簡単なリリースノート テンプレートに従う

これらのテンプレートを作成して、開発者に、このフォーマットだけでノートを書くように頼みます。 こうすることで、誤解を避け、何が変更され、どのように動作し、どのような目標を達成しようとしているのかを正確に知ることができるのです。 これら 4 つのテンプレートだけで、すべてのリリース ノートの 90% をカバーします。

• Previously X is now Y
• Y の代わりに X を行うことができます
• X no longer does X, Y when Z, Q, W

X no longer does Y.です。 つまり、Z

4.フォーマルすぎるのは避ける

もちろん、企業のブランディングにもよりますが、「XはもはやYをする必要はない。 しかし、フォーマルな文章はたいてい長く、要点がストレートに書かれていません。 ですから、読み手が文章をスキャンするのが難しくなります。 リリース ノート ドキュメント テンプレートでは、一貫した言語を使用し、フォーマルすぎることは避けるようにしてください。 拡大してから簡略化する

優れたリリース ノートは短く、簡潔です。 しかし、そこに到達するためには、テキストを拡張し、新しい機能、バグ修正がすべて反映されていることを確認します。 また、多くのリリース ノートの作成は、大量の情報を取り、それを短い段落に押し込んでいます。 各リリース ノートが文脈から外れないように注意しましょう。

最高のリリース ノートの例を見てみましょう。 素晴らしいリリースノート ページを持つ 3 社と、そこからどのように学ぶことができるでしょうか。

👉関連する記事。 SaaSにおける重要な指標について知っておくべきこと

リリースノート例

Salesforceリリースノート例

SalesforceはCRMプラットフォームとして、傘下に多くのプロダクトを持っている。 そのため、新機能や製品の変更について顧客に最新情報を提供することは、テクニカル ライター、プロダクト マネージャー、および開発者にとって地獄です。
私は、同社が四半期ごとにリリース ノートを作成し、そのカテゴリとサブカテゴリで非常にわかりやすいリリース ノート ページである “Salesforce Summer ’19 Release Notes” と呼ばれているものと推測しています。 このような包括的なリリース ノート ページの明らかな利点は、サポート部門の肩の仕事を軽減することです。 たとえば、特定のトピックに関連する顧客からの質問を受け取った場合です。

Key pro tips to take out:

1. リリース ノート セクションの使用方法

2. 詳細で視覚的に理解しやすい表と製品ロードマップ

3. フィルターセクション

4. 一般的な説明、一般的な説明の後に、新機能がどのように機能するかを詳細に説明

Salesforce もリリースノート テンプレートに従っています。

ステップ1：新機能の内容を説明する
アカウントページで領域割り当てを管理するためにSalesforce Classicに切り替える必要はもうありません。 Lightning Experience で [割り当て済みテリトリー] 関連リストを編集できるようになりました。 以前は、関連リストは Lightning Experience では読み取り専用でした。

もう、.NET を実行する必要はありません。 .NET Framework を実行できるようになりました。

ステップ 3: 機能の使用方法を説明する
方法: アカウント ページ レイアウトに [割り当て済み地域] 関連リストが含まれている場合、セットアップは必要ありません。 Assign Territories] をクリックして割り当てを管理します。

Sketch Release Notes Examples

もしあなたの製品がそれほど複雑ではなく、サブツールの大きな傘を持つプラットフォームではない場合は、Sketch companyをチェックしてください。
レイアウトは興味深いものです。 右側には、すべての新機能とバグフィックスの詳細な説明があり、左側には、主な大きな機能の説明があります。 そして CTA。

Smart Distribute Upgrades

Grid の間隔を制御するために Smart Distribute を使用できるようになりました。 レイヤーの行の垂直方向の間隔と、行の各レイヤー間の水平方向の間隔を簡単に調整できます。 また、インスペクタに新しい「整頓」ボタンが導入されました。 これは、複数のレイヤーの選択をすばやく整然としたグリッドに整列させ、複雑なレイアウトの作成と管理をさらに容易にします。

再び、シンプルなテンプレート:
You can do now . 簡単に .NET を行うことができます。 また、新しい .NET Framework を導入しました。

改善点:
[編集] メニューに新しい [アートボードですべてを選択] コマンドを追加し、選択したアートボード上のすべてのレイヤーをすばやく取得できるようになりました。 また、異なる [すべて選択] コマンドにサブメニューを追加しました。

• Magic Wand ツールでドラッグして選択するとクラッシュすることがあるバグを修正しました。

– ページおよびレイヤー リストで、外部ディスプレイに接続している場合、選択範囲が正しくハイライト表示されないバグを修正しました。 Salesforce は、技術的なバックグラウンドを持たない人々、営業部門やマーケティング担当者、起業家、創業者などのためにリリースを書きます。

スケッチは、グラフィック デザイナーやアーティストが使用します。 このように、SalesforceもSketchも一般的なトーンで、非常にユーザーフレンドリーで、実際の人々に向けられています。

Getpostman Release Notes Examples

もしあなたの製品が技術者でユーザーが開発者なら、逆のことが経験則として言えるでしょう。 例えば、Getpostman は開発者向けの技術的な製品です。

リリース ノートは、何が新しくなったかについての一般的な考えを持つために、すばやく目を通すことができます。 そして、非常に単純化された形式に従っています。

更新番号、更新日、および各更新についての情報を 1 文で示し、ユーザーにとっての意味、使用方法、またはアクセス方法についての詳細は記載していません。 5436>

Humor in Release Notes

私たちはすでに、読んでいて陽気で楽しいアプリ内リリース ノートの例について話してきました。 しかし、この口調は、大多数の技術系企業には適していません。 そして、リリース ノートのためのスタイル ガイドが必要です。 さらに、すべてのソフトウェア製品にモバイル版があるわけではなく、大半の企業はリリースノートをサポートやヘルプセクションの下のどこか別のページで公開しています。 (企業は戦略的にリリース ノートを埋め、なぜ誰も読まないのかと文句を言います。)

製品の更新を通知するスマートな方法はたくさんあります。 たとえば、製品の更新を紹介する優れた電子メールを書いたり、別のブログ記事を作成したりします。

👉 関連記事

人生におけるあらゆることと同様に、構造と組織、および最新の技術をもたらすことによって、より簡単なソリューションを作成し、退屈で不必要なものにはなりません。

うまくいけば、私たちのサンプル ソフトウェア リリース ノート テンプレート
と例がお役に立つでしょう。