この記事はNishi Grover Gargによるゲスト投稿です。
バグレポートを書くのはテスターの日常の一部、それも重要な一部です。見つけたバグのレポートをどう書くかは、バグのその後に大きな影響を与え、バグが把握されて修正されるか、先送りにされたり却下されて終わるかの運命を左右します。
あらゆるテスターにとって、見つけた欠陥を上手に伝えることは避けて通れません。以下は、よりよいバグレポートを書くのに役立つ4つのヒントです。
1. 過去のバグレポートを研究する
チームに入ったばかり、あるいはテスト業務自体が初めてという場合、よいバグレポートについて学ぶ最良の方法は、チームの過去のバグレポートを読むことです。バグを理解して再現できるかどうか試してみましょう。レポートが何を言っているか理解できますか？レポートの情報だけでバグを再現できますか？同じステージに到達するために追加の手順や詳しい情報が必要ですか？
このような演習をやってみることで、チームがバグを理解するための最良の方法を学ぶことができます。ビジネスで使われる言い回しやプロジェクト独自の用語の感覚をつかみ、機能やモジュールを説明できるようになります。
また、過去のレポートの不備を見つけることもあるでしょう。そのときは、レポートを改善する方法やほかにどんな情報を含めるのが役に立つかを考えることができます。
2. 自分なりの戦略をたてる
テスターは絶えずバグを文書化しなければならないという要求を受け入れる必要があります。チームがアジャイルで、ドキュメントを最少化または簡略化している場合でも、テスターは依然として何らかの方法でバグを文書化し、バグを明確に伝えて対処できるようにしなければなりません。よいバグレポートを書くことの重要性を理解したら、創造性を発揮できます。
自分なりの近道を作り出すことができます。たとえば、テストを実施しながら、見つけたバグの概要またはタイトルをメモし、スクリーンショットを保存しておくと、レポート作成にとりかかったとき、手順や期待される結果および実際の結果をすばやく書き込み、保存しておいたスクリーンショットを添付できます。そうすると時間の短縮につながり、必要なスクリーンショットやログを取るためだけに手順を繰り返す労力を節約できます。
3. チェックリストを持つ
たいていの欠陥追跡ツールでは、欠陥レポートを登録するとき、いくつかのフィールドに入力する必要がありますが、これは十分な情報を提供したかを判断するのに便利です。通常、エラー状態のスクリーンショットや動画の記録、エラーログなど、何らかの形でバグの「証拠」を含める必要があります。
自分が以前にレポートしたバグを追跡し、後で開発者にどんな追加情報を求められたか、問題の修正に役立つ追加のログファイルやスタックトレースなどを認識するとよいでしょう。今後はそのアイテムを標準でバグレポートの一部とすることができます。
追加情報を含めると、バグレポートを読む開発者にとってわかりやすくなるだけでなく、あなた自身がより深く観察して詳細な解析を行うことにつながります。ときには、バグの根本原因まで突き止められるかもしれません。
4. 書き方に気を配る
何を書く場合でも、ある程度のコミュニケーションスキルが必要です。バグレポートを書くときには、内容にだけ集中するのではなく、問題を明確に伝え、適切な印象を与えられるよう、書き方にも気を配るべきです。
- 短いセンテンスを使用する
- 簡潔に意味をなすように書き、不要な経緯や情報を排除する
- 個人名や個人への直接的な言及を避ける
- 明確な番号付きリストによるバグ再現手順を記述する。手順が自明だと感じられたとしても、新しく入った人が初めてレポートを読む場合や、何年もたってアプリケーションが変更された場合には自明ではないかもしれません。
- 常にあいまいな点がないようにする。バグが毎回同じように再現されない場合、その点を明確にしましょう。
- 期待される結果を記述する。期待される結果が明確ではない場合、正しい結果と考えられる選択肢を記述します。判断はチームやプロダクトオーナーにゆだねます。
最後に
重要なアドバイスをするなら、どのバグレポートにも最善を尽くし、しかるべき労力を注ぐべきです。しかし、個人的に入れ込むことはしないようにしましょう。すべての情報を提供し、すばらしいレポートを書いたとしても、注目されないままだったり、ビジネス上の理由で却下されるバグはたくさんあるでしょう。それもテスターの日常の一部です。淡々とよい仕事をし、次の仕事に移りましょう。
Nishiは企業トレーナー、アジャイルの信奉者、そして根っからのテスターです。業界で11年以上の経験を持ち、現在はSahi Proでエバンジェリスト兼トレーニングヘッドとして働いています。トレーニングに情熱を注ぎ、テストコミュニティイベントやミートアップを主催したり、多数のテストイベントやカンファレンスで講演を行っています。アジャイルおよびテスト分野での最近のトピックを取り上げたブログをご覧ください。
（この記事は、開発元Gurock社の Blog 「Four Tips to Write Better Bug Reports」2020年7月17日の翻訳記事です。）