リリースノートとは — 書き方とテンプレート
リリースノートは「何が変わったか」を利用者に伝える短い文章です。定義、 changelog との違い、書き方の型、そのまま使えるテンプレート、公開場所の 決め方までを 1 ページにまとめました。
リリースノートとは
リリースノートとは、製品やサービスを更新したときに「何が変わり、利用者にとって何がうれしく、何をすればよいのか」を伝える文書のことです。ソフトウェアの更新に付いてくるものと 思われがちですが、必要になる条件は「使っている人がいて、その人の行動に 影響する変更がある」ことだけなので、アプリでも、店舗のサービスでも、 社内システムでも同じように書けます。
読む人は開発者ではありません。「バージョン 2.4.1 でExportScheduler を追加」ではなく「毎週月曜に自動で書き出す 設定ができるようになりました」と書く、というのがリリースノートの いちばん基本的な作法です。
changelog・更新履歴との違い
呼び分けは現場によってまちまちですが、実務では次の整理が使いやすいです。
| 呼び方 | 読者 | 粒度 |
|---|---|---|
| リリースノート | その製品を使う人 | 1 回の公開につき 1 本。要点だけ |
| changelog (更新履歴) | 使う人 + 開発者 | 変更を時系列に積む。細かくてよい |
| コミットログ | 開発者だけ | 1 変更 1 行。公開向けではない |
迷ったら「これは誰が読むのか」だけを決めてください。 読者が利用者なら、コミットログをそのまま貼るのは避けます。自動生成した 一覧は網羅的で正確ですが、利用者から見ると「自分に関係のある行」を 探す作業になってしまいます。
ちなみに「更新履歴」を英語で書くなら changelog が いちばん一般的です。画面の短いラベルなら What's new、 文書の改訂の記録なら revision history という言い分けも あります。更新履歴の書き方そのものは、次の節の「4 つの問い」が そのまま使えます — 違いは、1 回の更新だけを伝えるか、すべてを 時系列に積んでいくかだけです。
書き方 — 4 つの問いに答える
形式より順番が大事です。読者の関心の順に並べると、それだけで読まれる 文章になります。
- 何が変わった? 1 文で。利用者が使う言葉で書きます
- 自分にとって何がうれしい? 実装ではなく、なくなった 手間を書きます
- 何かする必要はある? 多くの場合は「特にありません」。 書かないと「あるかもしれない」と読まれます
- 次はどこを見ればいい? 機能そのもの、ヘルプ、 問い合わせ先へのリンク
タイトルは結果にします。「エクスポート機能の改善」より 「エクスポートを毎週自動で」のほうが、一覧に並んだときに開かれます。 日付とバージョン番号は必ず入れてください。読者が「自分に関係のある回か」 を判断する手がかりがそれだけだからです。
テンプレート
機能追加のとき。いちばん使う型です。
## v1.8.0 エクスポートの自動実行 **変わったこと** 毎週月曜の朝に CSV を自動で書き出せるようになりました。 これまでは毎回ボタンを押す必要がありました。 **使い方** 設定 → エクスポート →「スケジュール」から、曜日と時刻を選んでください。 **必要な対応** ありません。これまでの手動エクスポートもそのまま使えます。
修正が中心のとき。小さい変更はまとめて 1 本にします。
## v1.7.3 修正と改善 **改善** - 検索が部分一致するようになりました (「請」で「請求書」が見つかります) - 一覧の並び順を次回も覚えているようにしました - 通信の遅い環境での初回表示を速くしました **修正** - 10MB を超えるアップロードが Safari で失敗する問題 - 日付の選択で月がずれることがある問題 ご報告いただいたみなさま、ありがとうございました。
仕様変更・提供終了のとき。これだけは省略しないで 書きます。
## v2.0.0 旧 API の提供終了について **3月31日までに対応をお願いします** 旧 API (/api/v1/) は3月31日で応答を停止します。以降は 410 を返します。 **対応方法** /api/v2/ に移行してください。項目名の変更は2つだけです。 - created → created_at (形式は ISO 8601) - owner → オブジェクトを返します (これまでは ID の文字列) **影響を受ける方** API を直接呼んでいる方のみです。管理画面と公式 SDK (v3.2 以降) を お使いの場合、対応は不要です。 **期日に間に合わない場合** support@example.com までご連絡ください。 連携が止まるより、期日を延ばすほうがよいと考えています。
毎月まとめて出すとき。継続的に更新している場合はこの型が読まれます。
## 3月の更新まとめ **今月の目玉** エクスポートの自動実行。一度設定すれば毎週月曜に届きます。 **そのほか** - 検索の部分一致 - 通信の遅い環境での初回表示を高速化 - 不具合の修正 7 件 (Safari でのアップロード失敗を含む) **次にやること** ダッシュボードの共有。先行して試したい方はメールでご連絡ください。
ありがちな失敗
- 社内の言葉で書いてしまう — 「コレクション」ではなく、 利用者が言う「フォルダ」で書きます
- コミットログをそのまま貼る — 網羅的ですが、読者は 自分に関係する行を探せません
- 「特に対応は不要です」を書かない — 書かれていないと、 利用者は何かあるのではと身構えます
- アプリ内のポップアップだけで済ませる — 一度閉じたら 二度と読めません。あとから参照される場所が別に要ります
- 完璧に書こうとして出さない — 短くても今日出したものが、 丁寧でも出ないものに勝ちます
どこに公開するか
リリースノートはURL を持った場所に置くのが基本です。 サポートの返信から貼れて、検索から見つかって、購読もできる。この 3 つが あとから効きます。自社サイトにページを増やすのが難しいときは、 お知らせ専用のページを別に持つ方法もあります。
The Latest は、まさにこの用途のサービスです。投稿を公開すると、ページと RSS フィード、自分のサイトに貼れる埋め込みウィジェットに同時に反映されます。 上のテンプレートは見出しや箇条書きのままエディタに貼り付けられます。 無料ではじめられて、クレジットカードも要りません。