リリースノート とは？

主にそのソフトウェアのユーザーが読むものだよ。「今回のアップデートで何ができるようになったの？」「注意することはあるの？」を知るための文書だね。開発者だけでなく一般ユーザーにも分かりやすく書くのがポイントだよ。

CHANGELOGは、バージョンごとの重要な変更を人が読める形で残す履歴だよ。全コミットを並べるものとは限らない。リリースノートは今回の公開内容や注意点を伝えるお知らせとして使えるけれど、呼び方や範囲はプロジェクトによって違うんだ。

一般的には「新機能のハイライト」「改善された点」「修正されたバグ」「既知の問題」「アップグレード手順や注意事項」を含めるよ。スクリーンショットや動画を添えて新機能を紹介すると、ユーザーに伝わりやすくなるんだ。

Releasesは、タグに基づくソフトウェアの公開・配布機能だよ。リリースノートに加えて、配布ファイルなども付けられる。マージ済みプルリクエストや貢献者の一覧からノートを自動生成できるけれど、公開前に内容を見直すんだ。

利用者が何をできるようになり、何に対応すべきかを書くといいよ。たとえば「設定画面に検索を追加」「設定名が変わるので、更新時に移行が必要」という具体的なお知らせだね。破壊的変更や既知の問題は、影響と対処方法が分かるように書こう。