リリースノートのテンプレートと例文をご紹介します。
WEB上で簡単にリリースノートの作成・管理を行えるツール「NotePM」
リリースノートとは
ソフトウェアやWebサービスの場合、不定期にアップデートが行われることが一般的です。その際、何が変わったのか、どういった改善があったのかを明記するのがリリースノートになります。基本的にはじめてリリースされる際には作成されず、更新時に変更ポイントをまとめた文書として作成されるのが一般的です。
WEB上で簡単にリリースノートの作成・管理を行えるツール「NotePM」
リリースノートの目的
アプリストアやWebサービスの場合、過去バージョンの利用は基本的にできません。そのためリリースノートを通じて変更点を把握することで、それまでできなかった新機能を知ったり、不具合が改善されたポイントを知ることができます。リリースノートがあることで、過去にどういった変更や修正が行われてきたかを確認できます。
オープンソース・ソフトウェアの場合、リリースノートにはどのPR（Pull Request）を取り込んだかもリストアップされます。それによってどの修正が取り込まれたのか、一目で把握できます。開発に参加しているメンバーにとっては、自分の修正が取り込まれたことによる参加欲求が満たされるでしょう。
リリースノートの書き方
リリースノートで書かれるべき主な項目になります。
ヘッダー
リリースに関するメタ情報を記述します。例えば以下のような項目があります。
- ソフトウェア、Webサービス名
- リリース日
- リリースバージョン
概要
主な修正点や追加機能など、リリースに関する概要を説明します。
目的
緊急のセキュリティパッチなど、リリースに関する目的がある場合にはそれを説明します。
リリース内容
更新された内容を記述します。更新が多岐にわたる場合にはカテゴリー毎に分けたり、プラットフォーム毎に記述します。
影響範囲
不可逆な変更やデータに修正が入っている場合に、利用者にどの程度影響が及ぶのかを記述します。
サポート範囲
リリースに伴う不具合が発生した場合の問い合わせ先、その対象を記述します。
備考
アップデート方法や、追加資料がある場合にそのURLを記載します。
免責事項
記述すべき免責事項があれば記載します。
WEB上で簡単にリリースノートの作成・管理を行えるツール「NotePM」
リリースノート サンプル例
○○ v1.5.0 リリースノート
- リリース日
2022年1月10日- リリースバージョン
v1.5.0概要
v1.5.0では以下の機能を追加しています。
- ユーザー一覧API
- 管理画面に権限管理機能の追加
また、以下の不具合修正を行っています。
- 検索時に絵文字が使えない不具合の修正
- ページ一覧で権限外のページが表示されてしまう場合がある不具合の修正
目的
お客さまからのご要望が多かったユーザー一覧APIを実装しました。詳しい利用法についてはAPIドキュメントをご覧ください。また、管理画面では権限管理を一元的に設定、管理できる画面を用意しています。
リリース内容
ユーザー一覧APIについて
参加しているユーザーを一覧で取得できるAPIになります。参加ユーザーが多い場合にはページネーションを行ってください。
管理画面に権限管理機能の追加
ページに対する権限を一元的に管理できる画面になります。グループの管理、ユーザーの設定時にご利用ください。
不具合修正
以下はお客さまのフィードバックで寄せられた不具合の修正になります。
- 検索時に絵文字が使えない不具合の修正
- ページ一覧で権限外のページが表示されてしまう場合がある不具合の修正
影響範囲
本リリースは全ユーザー様を対象に即日実施されています。本リリースに伴うデータの不可逆な修正は行われておりません。
サポート範囲
本リリースに関するお問い合わせはこちらよりお願いいたします。お問い合わせはベーシックユーザー以上を対象としております。
備考
- ユーザー一覧APIはAPIドキュメントにて詳細をご確認ください。
- 管理画面に権限管理機能の追加についてはユーザードキュメントをご覧ください。
免責事項
- 本リリースとサービスの動作が異なる場合は、サービスの動作が優先されるものとします。
- 本リリースは2022年1月現在有効であり、すでにリリース内容を無効にする更新が実施されている可能性があります。
検索性に優れたマニュアル作成・ナレッジ管理ツール「NotePM」
NotePM（ノートピーエム） は、Webで簡単にマニュアル作成できて、強力な検索機能でほしい情報をすぐに見つけられるサービスです。さまざまな業界業種に導入されている人気サービスで、大手IT製品レビューサイトでは、とくに『使いやすさ・導入しやすさ』を高く評価されています。
NotePMの特徴
- マニュアル作成、バージョン管理、社外メンバー共有
- 強力な検索機能。PDFやExcelの中身も全文検索
- 社内FAQ・質問箱・社内ポータルとしても活用できる
- 銀行、大学も導入している高度なセキュリティ。安全に情報共有できる
