使う場面

メジャーリリースであれ小さなパッチであれ、出荷するすべてのバージョンでリリースノートを公開しましょう。ユーザーや管理者はいつアップグレードするかを判断するために読み、サポートチームはその後の問い合わせに答えるために読みます。監査や変更承認、オフラインでの保管が必要なリリース文書として、PDFの控えが役立ちます。

含まれる内容

• プロジェクト名の入力欄を含むタイトルと、それに続くバージョン番号とリリース日です。
• ハイライトに続き、おなじみの変更履歴の順序で並ぶ追加・改善・修正それぞれのリストです。
• 番号付きのアップグレード手順、既知の問題のセクション、メールアドレスの入力欄を含むフィードバックの行です。

より良い文書にするヒント

• 修正内容は、内部の原因ではなくユーザーが目にする挙動で説明しましょう。ユーザーが気にするのは、どの関数が直されたかではなく、エクスポートが失敗しなくなったことです。
• バックアップや設定変更のように対応が必要な事項はアップグレード手順に書き、ハイライトでも触れましょう。テクニカルスタイルは、バージョン番号やコマンドを見やすいまま保ちます。