メインコンテンツにスキップ

バグレポートの添付ファイル

バグレポートを提出する際、何を添付する必要がありますか?

対応者:Nikola Jonic

各バグには、少なくとも1つの添付ファイルを付けて記録する必要があります。添付ファイルによって、そのバグがあなたのデバイス、オペレーティングシステム、またはブラウザ上で発生していることを証明します。

注:添付ファイルは、レポートに記載する文章の代わりにはなりません。添付ファイルは問題を視覚的に示すものであり、証拠として機能します。

スクリーンショットとスクリーンキャストのどちらを使うべきですか?

一般的に、機能バグは適切かつ効果的に説明するためにスクリーンキャストが必要です。指示またはチームリーダーから特定の添付ファイルを求められていない限り、バグにスクリーンショットとスクリーンキャストのどちらが必要かを判断する際は、次の目安を使用してください:

  • バグを発生させるために操作が必要な場合、またはプロセスを説明する必要がある場合は、スクリーンキャストをアップロードしてください。静止画であるスクリーンショットはスナップショットにすぎず、根本原因を説明することはできません。そのため、機能バグには常にスクリーンキャストが必要です。

  • バグの性質が静的な場合、たとえば静的なGUIの問題では、スクリーンショットで十分であり、動画よりも適切に視覚化できます。コンテンツまたはビジュアルの問題では、スクリーンショットで十分です。

添付ファイルに関する一般要件

  • すべてのバグレポートまたは再現について、新しい添付ファイルを作成する必要があります。

  • 他のバグレポートや再現から添付ファイルをコピーすることは禁止されています。

  • 添付ファイルには、証拠として機能するために、バグに関するすべての関連情報が表示されている必要があります。

  • すべての添付ファイルは、Test Cycleで指定された言語で作成する必要があります。必要に応じて、スクリーンショットやスクリーンキャストを撮影する前に、デバイスおよび/またはブラウザの言語を変更してください。たとえば、Test Cycleの言語が英語(多くの場合これに該当します)の場合、スクリーンショット、スクリーンキャスト、システム情報、デバイス設定は英語である必要があります。

  • バグを報告するときは、デバイスまたはブラウザを1つだけ選択し、その環境についての添付ファイルのみをアップロードしてください。他のデバイスやブラウザでもバグを再現できる場合は、そのことをActual resultに記載してください。

  • Test IOの他のお客様に関する情報で、Test IOと関連付けられる可能性のあるもの(例:招待メールやブラウザのタブ名)は表示しないでください。他のお客様がインストールしたアプリを表示することは許可されています。

  • 写真、動画、オートコレクトによる不適切な単語の候補など、個人情報やプロフェッショナルではないデータは表示しないでください。添付ファイルは他のテスター、Test IOのスタッフ、およびお客様が閲覧できることを忘れず、何を表示するかには十分注意してください。

  • Webサイトのテストでは、添付ファイル上にURL欄が表示されている必要があります。

  • テキストや要素を簡単に識別できるよう、解像度は十分に高くしてください。

  • 必ず画面全体を録画してください。

  • アプリのクラッシュに関するバグレポートおよび正常な再現では、クラッシュログが必須です。クラッシュを記録した動画は、添付されたクラッシュログと一致している必要があります。つまり、タイミングが整合していなければなりません。

スクリーンショットには何を含める必要がありますか?

スクリーンショット固有のルール:

  • スクリーンショットはJPGまたはPNGファイル形式である必要があります。

  • スクリーンショット上でバグを強調表示してください。

録画ツールとベストプラクティスについては、次の記事をおすすめします:スクリーンショット

よくあるミスについては、次の記事をご覧ください:
添付ファイルでよくあるミス

スクリーンキャストには何を含める必要がありますか?

スクリーンキャストは、できるだけ短く、必要な長さだけにしてください。つまり、バグの原因とならない手順は省略してください。たとえば、Webショップの商品詳細ページにある「カートに追加」ボタンに不具合がある場合、Webショップ内をどのように移動して商品詳細ページに到達したかは、通常関係ありません。最後のナビゲーション手順、バグを発生させる操作、そしてバグそのものは、通常、必要な情報です。

例1:
Webサイト上のバグをデスクトップデバイスでテストした場合

例2:
アプリ内のバグをモバイルデバイスでテストした場合

スクリーンキャストの作成手順:

  1. バグが発生するページを開きます。

  2. 録画を開始します。

  3. ページを更新します。

  4. バグを発生させる操作を行います。

  5. バグが発生するまで待ちます。

  6. 録画を停止します。

スクリーンキャストの作成手順:

  1. アプリを起動し、バグが発生するページに到達するまでに必要なナビゲーション手順があと1つだけ残っているページを開きます。

  2. 録画を開始します。

  3. 正しいページに移動するための最後のナビゲーション手順を実行します。

  4. バグを発生させる操作を行います。

  5. バグが発生するまで待ちます。

  6. 録画を停止します。

チームリーダーから、外部または追加の録画を求める情報リクエストが送られる場合があります。これは、バグをより正確に理解するため、またはバグを再現できないことによって判断が難しい場合に行われます。

スクリーンキャスト固有のルール:

  • スクリーンキャストはMP4ファイル形式である必要があります。

  • 添付ファイルの最大サイズは25 MBです。

  • バグレポートのスクリーンキャストの最大時間は60秒です。ただし、バグでローディング処理や長時間にわたる必要な手動入力を示す必要がある場合を除きます。

  • ReproductionおよびUser Storyの添付ファイルでは、バグを発生させた最後の操作だけを表示する必要があるため、スクリーンキャストの最大時間は15秒です。

  • 録画は一度に行ってください。途中で一時停止したり、途中の部分をカットしたりしないでください。スクリーンキャストが長すぎて編集したい場合は、ファイルの冒頭または末尾だけをカットしてください。

  • スクリーンキャストの再生速度を上げることは禁止されています。許可された時間を超えて録画した場合は、スクリーンキャスト内に不要な手順を含めていないか確認してください。

  • いかなるノイズも録音しないでください(赤ちゃんの泣き声、会話、テレビ、音楽、ペットの音など)。

録画ツールとベストプラクティスについては、次の記事をおすすめします:スクリーンキャスト

よくあるミスについては、次の記事をご覧ください:
添付ファイルでよくあるミス

ストリーミングデバイスに関するスクリーンキャスト固有のルール:

  • テレビ画面全体を必ず録画してください。

  • スクリーンキャストは高解像度で、十分な品質である必要があります。

  • 周囲の明るさが暗すぎないようにしてください。

  • スクリーンキャストにはテレビのリモコンが表示されている必要があります。また、リモコン全体がはっきりと見える状態である必要があります。

  • バグレポートではスクリーンキャストの最大時間は60秒ですが、バグの再現およびUser Storyの添付ファイルでは最大15秒です。

  • いかなるノイズも録音しないでください(赤ちゃんの泣き声、会話、テレビ、音楽、ペットの音など)。

  • スクリーンキャストは常にプロフェッショナルに見えるようにしてください。足、散らかったテレビ台などが映り込まないようにしてください。

キーボードバグのスクリーンキャストを録画する方法

コンピューターのキーボードキーを使ってWebサイトを操作すると、バグが発生することがあります。

この場合、スクリーンキャストではバグを発生させる操作を示す必要があるため、キーボード入力を表示することが必須です

キーボード入力を表示したスクリーンキャストを作成する方法の優れた例はこちらです:

すべてのデバイス向けスクリーンキャスト添付ファイルのマスターガイド

添付ファイル上の個人情報をぼかす

ブックマーク、アカウント名、保存されたメールなどの個人情報がブラウザのタブに表示されないようにするため、ぼかして隠すことができます。

添付ファイルに個人情報を含める必要があるものの、それを表示したくない場合は、この例に従ってプロフェッショナルな方法で隠してください。メールアドレス、ユーザー名、ブックマークが表示される可能性のあるブラウザのタブ名は非表示になっていることに注意してください。

URLは引き続き表示されている必要があり、Webサイトの要素を隠したり覆ったりしてはいけない点に注意してください。

プロフェッショナルな理由から、以下の例に示すように、添付ファイル上の情報を隠す際に手書きや雑な方法を使用することは避けることが重要です:

こちらの回答で解決しましたか?