リリースノート

リリースノートは、ソフトウェア製品やハードウェア製品に同梱されて配布される文書で、製品がまだ開発中またはテスト段階（ベータ版など）のときに配布されることもあります。^[1]^[2]すでに顧客が使用している製品の場合、リリースノートはアップデートがリリースされたときに顧客に配信されます。リリースノートの別の略語は、変更ログ、リリースログ、ソフトウェアの変更、改訂履歴の 更新、またはREADMEファイルです。^[3]ただし、リリースノートと変更ログが別々に公開される場合もあります。この分割は、機能のハイライトを、バグ、変更要求（ CR）、または改善点から明確に区別するためです。 ^[4]^[5]

目的

リリースノートは、組織のエンドユーザー、顧客、クライアントと共有される文書です。「エンドユーザー」、「クライアント」、「顧客」という用語の定義は、本質的に非常に相対的であり、特定のコンテキストに基づいてさまざまな解釈が可能です。たとえば、ソフトウェア開発組織内の品質保証グループは、内部顧客として解釈できます。^[6]

コンテンツ

リリースノートには、企業が提供するサービスや製品に対して行われた修正、変更、機能強化（機能的または非機能的）の詳細が記載されています。 ^[7]^[8]^[9]

これらは、特に情報技術組織に関連して、システムテストやシステム統合テスト、およびその他の管理された環境の成果物に付随する成果物として提供される場合もあります。

リリースノートには、テスト結果やテスト手順に関する情報も含めることができます。この種の情報により、リリースノートの読者は修正や変更が行われたことにさらに自信を持つことができます。また、この情報により、変更の実装者は基本的な受け入れテストを実施することもできます。

これらはエンドユーザー使用許諾契約とは異なり、ソフトウェア製品やサービスの法的条件は含まれません（含まれるべきではありません）。焦点はソフトウェアのリリース自体に置かれるべきであり、法的条件などには置かないでください。^[10]

リリースノートは、新機能やバグの解決を強調するのではなく、ソフトウェアのインストール方法やビルド方法を説明するものとして解釈することもできます。^[11]この文脈でよく使用される別の用語は、システム要件であり、ソフトウェアのインストールまたはビルドに必要なハードウェアとソフトウェアを意味します。

フォーマットスタイル

リリースノートには、さまざまな組織で共通する標準の形式はありません。組織は通常、配布する情報の要件と種類に基づいて独自の書式スタイルを採用します。リリースノートの内容も、リリースの種類によって異なります。テスト段階にある製品や新しくリリースされた製品の場合、内容は通常、バグ修正や機能強化のリリースノート (通常は簡潔) に比べて詳細になります。

リリースノートには次のセクションが含まれる場合があります。

ヘッダー- ドキュメント名 (リリースノートなど)、製品名、リリース番号、リリース日、ノートの日付、ノートのバージョンなど。
概要- 他の正式なドキュメントがない場合に、製品と変更点の簡単な概要。
目的- リリースノートの目的の簡単な概要と、バグ修正や新機能など、このリリースの新機能の一覧を示します。
- 問題の概要- リリース内のバグまたは機能強化の簡単な説明。
- 再現手順- バグが発生したときに実行した手順。
- 解決策- バグを修正するために行われた変更/機能強化の簡単な説明。
エンドユーザーへの影響- アプリケーションのエンドユーザーが必要とするさまざまなアクション。これには、これらの変更によって他の機能が影響を受けるかどうかも含まれます。
サポートの影響- ソフトウェアを管理する日常的なプロセスで必要な変更。
注記- ソフトウェアまたはハードウェアのインストール、アップグレード、および製品ドキュメント（ドキュメントの更新を含む）に関する注記
免責事項- 会社および標準製品関連のメッセージ。例:フリーウェア、著作権侵害防止、複製など。免責事項も参照してください。
連絡先- サポートの連絡先情報。

リリースノートは通常、特定のソフトウェアリリースにおける最近の変更、機能強化、およびバグ修正の簡潔な概要です。ユーザーガイドの代わりになるものではありません。リリースノートは現在形で書かれることが多く、明確で正確かつ完全な情報を提供します。

オープン仕様の提案が存在し、リリースノートスキーマ仕様と呼ばれています。^[12]

参照

さらに読む

Laura Moreno他「ARENA: リリースノートの自動生成のためのアプローチ」、IEEE Transactions on Software Engineering（第43巻、第2号、2017年2月1日）^[13]
ニュートン、ケイシー(2016 年 2 月 10 日)。「ビールを飲みながら、Medium リリースノートチームと一緒にリリースノートを書きました」。The Verge。Vox Media。2021年4月 5 日閲覧。
GNU コーディング標準- 6.8 変更ログ

参考文献

^ 「変更ログの概念 (GNU コーディング標準)」。www.gnu.org 。2021 年 4 月 5 日閲覧。
^ Scott, James (2020-04-24). 「優れたリリースノートを書くための技術」. Medium . 2021-04-05閲覧。
^ 「リリース (GNU コーディング標準)」www.gnu.org . 2021 年 4 月 5 日閲覧。
^ 「バージョン履歴 - 英語 - ナレッジベース」kb.i-doit.com . 2021年10月10日閲覧。
^ 「56508 - Zynq-7000 SoC、14.6 FSBL - 変更ログはありますか?」Xilinxサポートキーワード検索。
^ Hobbs, Brian; Besner, Claude (2016-05-01). 「社内顧客と社外顧客とのプロジェクト: 実践における差異の実証的調査」International Journal of Project Management . 34 (4): 675–687. doi : 10.1016/j.ijproman.2016.02.010 . ISSN 0263-7863.
^ 「変更ログ (GNU コーディング標準)」www.gnu.org . 2021 年 4 月 5 日閲覧。
^ Wang, C.; Li, J.; Liang, P.; Daneva, M.; Sinderen, M. (2019 年 9 月)。「開発者のアプリ変更への注目: アプリ変更ログに関する調査」。2019 IEEE 第 27 回国際要件エンジニアリング会議ワークショップ (REW)。pp. 207–212。doi : 10.1109 /REW.2019.00042。ISBN 978-1-7281-5165-6. S2CID 209460408。
^ Bourne, Kelly C. (2014-01-01)、Bourne, Kelly C. (編)、「第 10 章 - アップデートとパッチ」、アプリケーション管理者ハンドブック、ボストン: Morgan Kaufmann、pp. 150–165、doi :10.1016/b978-0-12-398545-3.00010-8、ISBN 978-0-12-398545-3、 2021-03-25取得
^ release-notes/release-notes-spec、リリースノート、2021-03-25、2021-03-25取得
^ 「Linuxカーネルリリース5.x — Linuxカーネルドキュメント」www.kernel.org . 2021年3月25日閲覧。
^ release-notes/release-notes-spec、リリースノート、2021-03-25、2021-03-25取得
^ Moreno, L.; Bavota, G.; Penta, MD; Oliveto , R.; Marcus, A.; Canfora, G. (2017 年 2 月)。「ARENA: リリースノートの自動生成のためのアプローチ」。IEEE Transactions on Software Engineering。43 ( 2): 106–127。doi : 10.1109/TSE.2016.2591536。ISSN 1939-3520。

外部リンク

リリースノートの書き方
リリースノートはどのように書くべきでしょうか? (Stackoverflow)
アプリリリースノートの奇妙な書き方
リリースノートハブ (https://www.release-notes.com も参照)は GitHub でオープンソース化されています
リリースノートスキーマ仕様

[1] 「変更ログの概念 (GNU コーディング標準)」。www.gnu.org 。2021 年 4 月 5 日閲覧。

[2] Scott, James (2020-04-24). 「優れたリリースノートを書くための技術」. Medium . 2021-04-05閲覧。

[3] 「リリース (GNU コーディング標準)」www.gnu.org . 2021 年 4 月 5 日閲覧。

[4] 「バージョン履歴 - 英語 - ナレッジベース」kb.i-doit.com . 2021年10月10日閲覧。

[5] 「56508 - Zynq-7000 SoC、14.6 FSBL - 変更ログはありますか?」Xilinxサポートキーワード検索。

[6] Hobbs, Brian; Besner, Claude (2016-05-01). 「社内顧客と社外顧客とのプロジェクト: 実践における差異の実証的調査」International Journal of Project Management . 34 (4): 675–687. doi : 10.1016/j.ijproman.2016.02.010 . ISSN 0263-7863.

[7] 「変更ログ (GNU コーディング標準)」www.gnu.org . 2021 年 4 月 5 日閲覧。

[8] Wang, C.; Li, J.; Liang, P.; Daneva, M.; Sinderen, M. (2019 年 9 月)。「開発者のアプリ変更への注目: アプリ変更ログに関する調査」。2019 IEEE 第 27 回国際要件エンジニアリング会議ワークショップ (REW)。pp. 207–212。doi : 10.1109 /REW.2019.00042。ISBN 978-1-7281-5165-6. S2CID 209460408。

[9] Bourne, Kelly C. (2014-01-01)、Bourne, Kelly C. (編)、「第 10 章 - アップデートとパッチ」、アプリケーション管理者ハンドブック、ボストン: Morgan Kaufmann、pp. 150–165、doi :10.1016/b978-0-12-398545-3.00010-8、ISBN 978-0-12-398545-3、 2021-03-25取得

[10] release-notes/release-notes-spec、リリースノート、2021-03-25、2021-03-25取得

[11] 「Linuxカーネルリリース5.x — Linuxカーネルドキュメント」www.kernel.org . 2021年3月25日閲覧。

[12] release-notes/release-notes-spec、リリースノート、2021-03-25、2021-03-25取得

[13] ^ Moreno, L.; Bavota, G.; Penta, MD; Oliveto , R.; Marcus, A.; Canfora, G. (2017 年 2 月)。「ARENA: リリースノートの自動生成のためのアプローチ」。IEEE Transactions on Software Engineering。43 ( 2): 106–127。doi : 10.1109/TSE.2016.2591536。ISSN 1939-3520。