リリースノート とは？

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

CHANGELOGは技術的な変更を全部記録する開発者向けの網羅リストだけど、リリースノートはユーザーに伝えたい重要な変更をピックアップして、分かりやすく説明したものだよ。同じアップデートでも、CHANGELOGに30項目あるうちの5項目だけリリースノートに載せる、なんてことも多いね。

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

そうだよ。GitHubにはReleasesという機能があって、タグを打ってリリースノートを書ける仕組みが用意されているんだ。最近はGitHubが自動でプルリクエストの一覧からリリースノートを生成してくれる機能もあるよ。

「ユーザー目線で書く」ことだね。「APIのレスポンスキャッシュを実装」ではなく「ページの読み込みが最大2倍速くなりました」と書く方が伝わるよ。あと破壊的変更がある場合は目立つように警告するのが鉄則だね。Appleのリリースノートで有名な「バグの修正と改善」だけ、というのは悪い例として語り継がれているよ。