documentation - リリースノート、何のために？

Question

リリースノートとは何のためのもので、誰が読むものですか? 現在のリリースのバグ修正を吐き出すだけで自動化する必要がありますか?それとも、人間が慎重に編集する必要がありますか? では、ソフトウェアのリリースノートに関するベストプラクティス (理由付け) へのリンクを持っている人はいますか?

score 16 · Accepted Answer

バグ修正と機能追加。ユーザーはそれらを読んで、インクリメンタルアップグレードをインストールするか、次のリリースまで待つかを判断します。

少なくとも人間がそれらを読み、各メモが有用であることを確認する必要があると思います. バグ修正に対するコメントの良し悪し次第です。

score 6 · Accepted Answer

これは、アプリケーションが誰のために構築されているか、および組織の目標に大きく依存します。ただし、リリースノートは、特定のリリースに含まれる重要な追加、拡張、または修正の簡潔なリストである必要があると考えがちです。

バグ追跡システム情報の単純なダンプで十分な場合もあれば、改良が必要な場合もあります。

重要なのは、通常、リリースノートは「私たちが行ったことを見てください」タイプの変更リストであると考えられていることです。

score 6 · Accepted Answer

リリースノートは、テスト組織 (ある場合) にとっても重要です。これにより、リリースで何が変更され、テストが必要かを知ることができます。

score 5 · Accepted Answer

私たちのリリースノートは、機械が作成したものではなく、人間が作成したものです。3 つの主要なトピックをカバーします。

リリースに含まれるもの (ファイルのリスト)
インストール方法
前回のバージョン以降の変更点 (特に、変更点がまだマニュアルに記載されていない場合)。

項目 1 と 2 はバージョンごとにあまり変わりませんが、見直す必要があります。項目 3 が最も多くの作業を必要とします。

score 5 · Accepted Answer

リリースノートは、運用環境でも非常に重要です。

彼らは古くからの質問に答えるのに役立ちます:

現在、一体何が本番環境に入っていますか?

または、より洗練された質問: このバグはこのリリースで実際に修正されていますか?

score 4 · Accepted Answer

私は定期的にリリースノートを読んでいます。私は、新製品の利用をさらに強化するために、機能変更の完全な包括的なリスト (またはもっともらしいもの) が必要になる傾向があります。

特定の重大なバグや重大なセキュリティ問題がいつ解決されるかを知りたいです。

score 1 · Accepted Answer

リリースノートと README は、顧客がアップグレードのために通常の手順に加えて特別な措置を講じる必要がある場合に非常に重要になります。また、新しいパッチをインストールした結果、データベースのアップグレードが自動的に行われる可能性があることを顧客/ユーザーに警告するのにも役立ちます。私の見方では、リリースノートと README は、システム管理者向けに書かれている必要があります。そのため、重要な変更点の概要、インストール方法、既知のバグ、誰かが頭を悩ませる可能性のあるソフトウェアの動作など、彼らが知りたいと思う種類のことを含めてください。

score 1 · Accepted Answer

リリースノートは組織によって異なります。

私は自分の組織のために話すことができます。PDF 形式のリリースノートを使用し、clickonce またはバックエンドバージョンを公開するたびに使用します。リリースノートをオフィスマネージャーに送信します。これは、ビジネスのトップ管理者 (IT だけでなく) が使用するドキュメントです。このドキュメントは、彼らが何が起こっているかを知る方法です。変更点、現在運用中の新機能、修正されたバグ、およびユーザーに説明したいその他の事柄。

これは 3 ～ 4 ページのドキュメントで、このバージョンで行われた作業を簡単な言葉で説明しています。

score 0 · Accepted Answer

リリースノートは、テスターとユーザーが新機能や変更点を知るためのものです。さらに、リリースノートは、クライアント用に構築しているクライアント用のソフトウェアの新しい「バージョン」を請求する際のサポートドキュメントとして使用できます。v1.31 は、関連付けと掘り下げがはるかに簡単なようです。

両方のリストを手動でコンパイルするのではなく、リリースノートを使用してそれを行うことができれば、それは素晴らしいことです。

score 0 · Accepted Answer

もちろん、これはアプリケーション/サービス/その他の種類に大きく依存し
ますが、お気に入りの開発ツールなどのリリースノートを読んでいると、
私が欲しかった素敵な機能、興味深い機能、さらには致命的な機能に出くわすことがよくあります。少なくともメモをざっと読んでいなかったら、おそらく見逃していたでしょう.....まあ、おそらく致命的ではありませんが、あなたは私のドリフトを理解しています;-)

ほとんどのコンピューターパワーユーザーとして (これはどういう表現でしょうか...)
私は通常のドキュメントを気にすることはあまりありません
。

documentation - リリースノート、何のために？

10 に答える 10

Related

Reference