パッチノートでバグIDを引用することが悪い習慣と見なされるのはなぜですか？
コメント と バグの再開vs.新規 からのその後の賛成票に基づく：
パッチノートでバグIDを引用することは、非常に不親切です。 – Krelp
少なくとも一部の人々は、パッチノートでバグIDを参照することは良い考えではないと感じています。私はかなり経験の浅い開発者なので、なぜそうなのか疑問に思います。
私の意見では、ユーザーがバグデータベースへの読み取りアクセス権を持っていることを前提として、これは良い習慣です。アップグレードするタイミングを決定するために、特定のバグが修正されるのを待つことがよくあります。
私は眉をひそめていると思いますonlyバグIDを引用して他には何もありません。バグトラッカーに行かなくても、理解できる説明を常に提供する必要があります。これにより、以前のリリースノートを完全に無効にすることなく、将来バグトラッカーを切り替えることもできます。
それは、引用されたコメントで述べられているように...不親切です。
自分に不親切
次のシナリオを想像してみてください。ソース管理でログを表示しています。コミットがどのように変更されたのか疑問に思っています。それを平易な英語で説明する代わりに、それはあなたに伝えます：
解決済み＃1307
あなたはバグ追跡システムを実行し、何か役立つものを期待しています。バグ＃1307は解決されたと報告されています。説明には、次が表示されます。
＃1284と同じバグ
おかげで、とても役に立ちました。バグレポート＃1284に移動して、バグ＃1112、＃1065、および＃1067を参照するバグ＃1113の複製であることを確認する必要があります。
5分後、最初は何を探しているのかわかりません。
はるかに役立つバージョン管理ログメッセージは次のようになります。
ユーザーが25文字を超えるパスワード（＃1307を参照）でログオンできないという問題を解決しました。これは、Webサイト自体で使用されているものと同じパスワード長のポリシーをデータアクセスレイヤーに適用することを削除することにより行われます。
同様に、バグ追跡システムでは、レポート＃1307はより自明であり、バグレポート＃1284の内容、および新しいレポートと古いレポートの違いを思い出してください。 。
お客様に不親切
これが唯一の親しみやすさの問題ではありません。
2つ目は、追加情報なしで参照しすぎると、パッチノート/バージョン管理ログ/バグ追跡システムレポートがこれらのシステムにあまり慣れていない人で使用できなくなることです。バグ追跡システムを毎日扱う場合、レポートをすばやくナビゲートしたり、複数のレポートを並べて表示したりする方法を知っています。技術的な背景がないお客様は、簡単に見失ってしまう可能性があります。
ここでも、参照だけでなく、より詳細なメッセージが非常に役立ちます。引き続き参照を保持したいことに注意してください。2週間前に発生したバグと同じバグですが、そのIDを思い出さないでください。
注意として、同じ問題が多くの法域に存在します。たとえばフランスでは、法律が複数の情報源に言及することは珍しくありません。つまり、それを完全に理解するためには、図書館で数時間を費やして、数十の参照テキストを検索する必要があり、各テキストには他のテキストへの独自の参照があります。
ユーザーが引用されている問題を読むことができるという条件で、パッチノートの問題番号を引用することに何の問題もありません。バグデータベースで誰でも読むことができる場合は、バグ番号を引用すると非常に便利です。 （パッチノートがリンクを許可する形式である場合、それらの問題IDを問題の問題へのリンクにしてください。）これは、すべての問題を一般に公開する必要があることを意味しません。覆い隠されたものがあると便利です（たとえば、ライブパスワードが入っている場所など）。
読んでいる人が行くことができず、バグの詳細と履歴を調べることができない問題番号を引用することは、非常に不親切です。問題IDなしでそのような問題を引用することは、はるかに友好的ではありません。
それは明らかにパッチノートを読む人々が誰であるか、そしてソフトウェアのターゲットユーザーに依存します。
しかし、ほとんどの場合、ユーザーの大多数は、バグIDが何であるかを単純に気にしません。彼らはなぜそれが壊れたのか、何が修正されたのか、その他何でも気にしません-彼らは非常に簡潔なテキストの説明で何が変更されたかを知りたいだけで、変更のたびに別のページに行く必要はありません。
バグIDを引用することで私は立ち止まって考え、ユーザーとして-私は考えたくありません。使いやすさの問題です。
Visual Assist Xの変更ログ の例を見てください。これらのリンクされたすべてのバグIDは単なるノイズであり、何が変更されたかを理解できません。そして、これはプログラマを対象としたVisual Studioのアドオンです。そして私はプログラマーです。これが気になる場合は、バグトラッカーが何であるかさえ知らない平均的なユーザーを想像してみてください。
PS：私は質問を引き起こしたコメントの著者でした
バグIDは必須であり、参照ポイントです。理由：
- あいまいさを防ぐ： 2つ以上のバグに同様の説明がある場合があります。したがって、それらを区別するためにいくつかのアンカーが必要になります。
- Convenience：顧客または社内でバグについて話し合う場合、バグIDは短い形式でよく使用されます。 IDがパッチノートから省略される場合、それらについて説明することは困難です。
3052はすでに修正されており、3077で作業中です
より便利です：
「適用ボタンでのアプリケーションクラッシュ」が修正され、「ユーザーの変更をクリックするとNullReferenceExceptionが発生する」
私はそれがあなたのシステムに依存すると言います：私は幸運です 私が使用するものはコミットメッセージでそのような参照を自動的に検出し、チケットへのリンクを追加しますバグトラッカーに保存されるため、問題ありません。
しかし、それが利用できないシステムを使用している場合でも、チケットIDについて言及します（そうすればチケットIDでログをすばやく検索できます ）バグの簡単な説明と一緒に。