web-dev-qa-db-ja.com

リリースノートはどのように記述する必要がありますか？

リリースノートの記述方法に関するガイドラインやベストプラクティスはありますか？具体的すぎずにポイントを作ることの間の適切なバランスを見つけようとしていると思います。また、開発者は通常、パブリックビューのために提出されたリリースノートと比較して、QAチームにはるかに多くのリリースノートを提供しますか？

deploymentlanguage-agnosticrelease-notes
39
DeFiNite

公開リリースノートには少なくとも以下が含まれている必要があります。

  • リリース、ビルド番号
  • すべての修正された公開バグ
  • 追加されたすべてのパブリック機能

QAリリースノートには少なくとも以下が含まれている必要があります。

  • リリース、ビルド番号
  • バグ番号を含むすべての修正されたバグ
  • 設計ドキュメントへのリンクを含むすべての追加機能

あなたの聴衆を考慮し、彼らが必要とするものを考えてみてください。

追加する他のことは、特定のプラットフォームの新規または廃止されたサポートです。 （たとえば、Win3.1のサポートを終了し、Vista 64ビットを追加しました）。

28
Toon Krijthe

人気のF/OSSプロジェクトのリリースノートを見てみましょう。

これらのプロジェクトにはすべて、読みやすくバランスの取れたリリースノートがあります。

21
Can Berk Güder

プロジェクト管理/問題追跡システムがある場合は、それを使用してリリースノートを生成する必要があります。 Trac と Redmine は特にこれに非常に優れています。

リリースポイントにはいくつかのプロパティが必要です、IMO：

  • オーディエンスを思い出してください。これがiPhoneアプリの場合、Fooクラスの572行目の特定の論理エラーが修繕。しかし、彼らは「アプリは加速度センサーに敏感になりました」について多くのことを気にかけるでしょう。
  • 可能であれば、広範囲にわたる包括的な方法で、新しい開発、機能、およびバグ修正を要約します。これらをテーマに基づいて結び付けることができる場合（たとえば、「ジェネリックと匿名型を実装しました」）、それについての短い言い回しは、人々に全体像を与えるための良い方法です。
  • 修正された特定の項目を、公開されているバグ追跡システムへのリンク（ある場合）に項目化します。通常、これは自動的に生成されます。
  • 過激な詳細を提供しないでください。追加または修正された各事項の1行または2行の要約で十分です。
  • 必要に応じて、常に特定のリリース識別子（「v.1.4.5」など）を含めます。
11
John Feminella

それは本当に聴衆に依存します。テクニカルユーザー（たとえば、APIを使用する開発者）にとっては、非常にテクニカルである場合があります。一方、作成したアプリケーションの高レベルのエンドユーザーは、新機能と大きな変更点のみに関心があるかもしれません。

その間には、サポート部門など、詳細も必要とする非技術系ユーザーもいます。それらの人々のために、例えば「レコードがデータベースに保存されなかったバグを修正した」のように、低レベルの技術的詳細なしで詳細な説明を与えることができます。

2
Gerrie Schenck

私の意見では、リリースノートのベストプラクティスの1つは自動化です。リビジョン管理システムの送信メッセージに関する特定のベストプラクティス（ http://drupal.org/node/52287 ）がある場合、自動化スクリプト（ http：/ /cvs.drupal.org/viewvc.py/drupal/contributions/tricks/cvs-release-notes/ ）。これは本当に素晴らしいリリースノートを作成します： http://drupal.org/node/226165

1
Mork0075

リリースノートの主な貢献者は開発チームです。開発者とテスターがTFSのチェンジセットにリンクされているworkItemsに対するリリースノート関連情報をキャプチャできるようにすることをお勧めします。

次に、 http://tfschangelog.codeplex.com のようなオープンソースプロジェクトを使用して、リリースノートを生成できます。 GUIバージョンとコマンドラインバージョンがあり、リリースノートレポートを毎晩簡単にスケジュール設定できます。

0
Dharmesh Shah