無料のリリースノート生成ツール

リリースノートとは？

リリースノートは、製品の新しいバージョンで何が変更されたか（新機能、改善、修正）をまとめた短い要約であり、ユーザーが何ができるようになったかを伝えるものです。リリースノート生成ツールを使えば、コミットやチケットといったチームがすでに持っている生のリストを要約に変換できるため、リリースから1週間後ではなく、リリースと同時に公開できます。

優れたリリースノートは、顧客にとってそのアップデートがなぜ重要かを伝えます。コミットメッセージは開発者にコードの変更内容を伝えます。その両者を翻訳するのがこのツールの役割です。

リリースノートとチェンジログの違い

これらの言葉は曖昧に使われがちですが、以下のように分けると便利です。

このツールはチェンジログ生成ツールとしても機能します。リリースごとにノートを生成し、チェンジログページの上部に追加してください。

リリースノートに含めるべき内容

• 製品名とバージョンを含むタイトル： 「Acme Analytics 3.2 リリースノート」。
• 1行の要約： 読者が最も気にする1〜2つの変更点。
• 新機能、改善、修正： この順序で記載し、該当がないセクションは省略します。
• メリットを強調した箇条書き： コードの変更ではなく、ユーザーが何ができるようになったかを記載します。
• 破壊的変更： ユーザーが何をすべきかを明確に記載します。
• リンク： 説明が必要な項目には、ヘルプ記事や動画へのリンクを貼ります。

リリースノートの短い例

「feat: レポートをCSVにエクスポート」「fix: ダッシュボードのタイムゾーンが1時間ずれる」「chore: 依存関係の更新」という3つのコミットは、以下のように変換されます。

Acme Analytics 3.2
レポートをどこでも活用できるようになり、ダッシュボードの時刻も正しく表示されるようになりました。

新機能

• CSVエクスポート： レポートをCSVファイルとしてダウンロードし、ExcelやGoogleスプレッドシートで開けるようになりました。

修正

• ダッシュボードの時刻： チャートがタイムゾーンを正しく反映するようになりました。

依存関係の更新はユーザーには影響がないため、顧客向けバージョンからは除外されます。社内向けバージョンには残されます。

生成ツール用に変更内容を準備する方法

リストを事前に整理する必要はありませんが、いくつかの習慣でより良いノートになります。コミットメッセージ、チケットタイトル、文章などを問わず、変更内容を1行ずつ貼り付けてください。「feat:」や「fix:」といった慣習的なプレフィックスは、変更を「新機能」や「修正」に分類するのに役立つため、そのまま残してください。「fix: エクスポート（大規模レポートでCSVが空になる問題を修正）」のように、分かりにくい項目には補足情報を追加します。製品名とバージョンを入力すれば、公開可能なタイトルが完成します。顧客向けと社内向けの両方が必要な場合は、2回実行してください。

リリースノートのベストプラクティス

製品の利用者を意識して書く

「クエリプランナーを最適化」よりも「レポートの読み込みが高速化」の方が伝わります。機能名はインターフェース上の表記に合わせてください。

重要なことから先に伝える

多くのユーザーが気付く変更を最初に記載します。小さな修正は最後に1行でまとめます。

新機能を見せる

スクリーンショットや短い動画は、文章よりも多くの情報を伝えます。解説するヘルプ記事へのリンクを忘れずに。

定期的に公開する

すべてのリリースを1つのチェンジログページに最新順でまとめ、顧客やサポートチームが常に確認できるようにします。

よくあるリリースノートの失敗

• チケット番号や専門用語を含んだまま、コミットログをそのまま貼り付けること。
• 破壊的変更をリストの途中に隠してしまうこと。
• 社内向けの変更をすべて顧客向けノートに記載すること。
• リリースに含まれていない機能や日付を約束すること。

この生成ツールは入力されたリストのみを反映し、指定していない日付を追加することはありませんが、公開前に必ず各項目を確認してください。