タイトル、URL、手順、実際の結果、期待される結果、添付ファイル、使用環境は、バグレポート機能を構成する項目です。この記事では、バグレポートフォームの各セクションでよくあるミスと、その避け方を説明します。それでは始めましょう!
タイトル
タイトルが一般的すぎて、バグの内容が明確に説明されていない。
タイトルに、問題を理解したり他のバグレポートと区別したりするために十分な情報が含まれていない。
タイトルが読者にとって不明確、または分かりにくい。
バグタイトルを書くときは、レポートを開かなくても読者が問題の概要を理解できるようにしてください。良いタイトルには、バグを理解し、他のバグレポートと区別するために必要な情報が含まれています。必要な情報には、何が起きたのか、どこでバグが発生したのか、いつ、どのように、またはどのような条件で発生したのかが含まれます。
例:
悪い例:Become a Testerボタンが動作しない。
正しい例:ナビゲーションにある「Become A Tester」ボタンをクリックしても反応しない。
悪い例:Data Privacyリンクを開くと404ページが表示される。
正しい例:ユーザーがフッターにある「Data Privacy」リンクをクリックすると、Error 404ページが開く。
URL
Webサイトのテスト時に、間違ったURLが追加されている。
URL欄にURLを追加するときは、バグが発生する場所のURLを指定してください。必ずバグが発生するページを開き、URLをコピーしてURL欄に貼り付けてください。
手順
Webサイトのテストで、最初の手順にURLが含まれていない。
手順が不足している。
メールアドレス、パスワード、日付など、テストに使用した情報が記載されていない。
手順で最もよくあるミスは、テスト対象のWebサイトのURLが最初の手順に含まれていないことです。Webサイトをテストするときは、必ず最初の手順にURLを追加してください。また、手順がいくつか抜けていたり、関係のない手順が記載されていたりすることもよくあります。
手順は、バグが発生するまでに実行した操作だけを記載するものであり、最後の手順にはバグを発生させる操作を記載する必要があります。
例を見てみましょう:
悪い例:
ユーザーがCrowdtestingをクリックする
下にスクロールして、About Usをクリックし、Become a Testerをクリックする
下に進み、登録をクリックする
正しい例:
https://test.io/ にアクセスする
ナビゲーションで「Crowdtesting」をクリックする
フッターまで下にスクロールし、「Company」の下にある「About Us」リンクをクリックする
ナビゲーションにある「Become a Tester」ボタンをクリックする
ご覧のとおり、手順は常に正確かつ詳細に記載し、バグが発生するまでに実行した操作だけを説明する必要があります。また、手順をより分かりやすくするためにMarkdownを使用することもできます。
実際の結果
実際の結果でバグが正しく説明されていない。
実際の結果に、バグに関する情報が少なすぎる。
実際の結果に、バグの内容ではなく、本来どうあるべきかという情報が記載されている。
実際の結果を書くときは、バグを詳しく説明する必要があります。バグが何であり、いつ発生するのかを正確に記載してください。また、エラーメッセージなど、その他の関連情報もすべて含める必要があります。
例:
悪い例:Become a Testerボタンが実装された機能を表示しない。
正しい例:Test IOのWebサイトを開き、ナビゲーションにある「Become a Tester」ボタンをクリックしても反応しない。ユーザーは同じページに留まり、リダイレクトも発生しない。
結果の説明は常に詳細に記載し、関連する情報をできるだけ多く提供してください。これにより、お客様が問題を理解しやすくなり、バグレポートが承認される可能性も大きく高まります。
期待される結果
説明が十分に詳細ではない。
説明が実際の結果の単なる反対になっている。
期待される結果には、バグが発生しなかった場合に何が起きることを期待するのかを正確に記載し、ここでも詳細に説明してください。また、期待される結果は実際の結果の単なる反対にしてはいけないことを覚えておいてください。
例:
悪い例:Become a Testerボタンをクリックすると新しいページへリダイレクトされる。
正しい例:ユーザーがナビゲーションにある「Become a Tester」ボタンをクリックすると、Test IOプラットフォームでテスターになる方法に関する情報を含む新しいページが開く必要があります。
上記でも説明したように、期待される結果は常に詳細かつ正確に記載してください。自分が何を期待しているのかを正確に書いてください。
添付ファイル
添付ファイルでよくあるミスについては、「添付ファイルでよくあるミス」のAcademy記事を参照してください。
使用環境
バグレポートで間違ったデバイス/ブラウザが選択されている。
スクリーンキャスト/スクリーンショットと一致するよう、必ず該当するデバイスとブラウザを選択してください。バグレポートを提出した後でも、チームリーダーによる確認前であれば、この情報を変更できます。間違ったデバイスまたはブラウザが選択されている場合、レポートは却下されます。
