Close

Loom を使用して明確なバグ レポートを記録する方法

重要ポイント

  • 短い Loom の録画により、開発者は何が起こっているかを正確に把握できます。長い文章での説明は不要で、誤解の余地もありません。
  • 各ステップを説明しながら進めることで、視聴者が内容を追いやすく、すぐに問題を理解できます。
  • 録画で重大度、影響、想定されている動作を明確に示すことで、開発者は問題の優先順位付けと修正に必要なすべての情報を得られます。
  • ブラウザ、デバイス、コンソール ログ、ネットワーク情報が Loom によって自動的にキャプチャされるため、報告者と開発チーム間のやり取りが削減されます。
  • Loom のリンクを Slack、メール、または Jira にドロップして、チーム全員が各自の都合に合わせてレビューやコメントを行えるようにしましょう。ミーティングは不要です。



Loom を使用して明確でアクションにつながるバグ レポートを作成する

バグ レポートを文章で作成しようとしたことがある方なら、どれだけ多くの情報が失われてしまうかご存知でしょう。手順、エラー メッセージ、その時に行っていた操作を記述するだけでは、開発者が確認する必要がある情報をすべて捉えることはほぼ不可能です。

では、ソフトウェア開発におけるバグ レポートとはどのようなものでしょうか? バグ レポートとは、何がうまくいかなかったのか、どうすればその問題を再現できるのか、そしてどのような動作が想定されていたのかを正確に記録したドキュメント (書面または録画) です。ゴールは、開発者が何度もやり取りすることなく、問題を理解し、優先順位を付け、解決するのに十分な情報を提供することです。

Loom を使った動画バグ レポートにより、そのプロセスが大幅に高速化されます。長い文章を入力する代わりに、画面を録画して問題を説明し、リンクを共有しましょう。これにより、迅速にチーム全員に同じ認識を持たせ、混乱をなくすことがます。問題の迅速な修正に必要なすべての情報を提供するバグ レポートを作成する方法について、引き続きお読みください。

ステップ 1. 報告するバグを決定する

録画を開始する前に、問題を確実に再現できることを 1 分ほどかけて確認してください。一度発生しただけで、再現できないバグは、開発チームにとって調査がはるかに困難です。

想定されている動作と実際の動作を考えてみてください。正常な動作とエラーが発生した動作を対比させることが、有用なバグ レポートの核心です。それが明確になったら、バグが発生する領域に移動して、その場面でバグを捉えられるよう準備します。

ステップ 2. Loom で画面録画を開始する

Loom を開いて、画面のみを録画するか、画面とカメラの両方を録画するかを選択します。ほとんどのバグでは、画面のみで問題ありません。カメラを追加すると、技術に詳しくない関係者に何かを説明する場合や、よりユーザー固有の状況情報を追加したい場合に役立ちます。

バグが発生する特定のウィンドウまたはタブを選択してください。録画を適切な範囲に限定することで、視聴者は開いている他のウィンドウや関連のないコンテンツに気を取られることなく、内容を追いやすくなります。

ステップ 3. バグをトリガーする手順を再現して記録する

これは録画の最も重要な部分です。問題の原因となる各アクションを順番に実行し、説明しながら操作しましょう。クリックする箇所、想定されている動作、実際の動作を言葉で説明してください。

ゆっくり操作しましょう。使い慣れた手順は急いで進めたくなるものですが、視聴者にとっては初めて見る内容かもしれません。速度を落とすことで、内容を追うためだけに再生を押す人が少なくなります。

ステップ 4. バグを指摘し、何が問題なのかを説明する

バグが画面に表示されたら、一時停止して明確に指摘してください。バグが明白であると思い込まないでください。何がうまく機能していないか、または正しくないかを正確に説明し、代わりにどう機能すべきだったかを述べます。

これは、録画がソフトウェア チームにとって真に有用になる瞬間です。問題が発生した正確な瞬間での明確なナレーションにより、開発者は曖昧なタイムスタンプを解釈したり、報告者が何について言及していたのかを推測したりする必要がなくなります。

ステップ 5. 録画中に影響と重大度を指摘する

バグを見せた後、そのバグが誰に影響を与えるか、また、どのようにワークフローやエクスペリエンスを妨げるかを説明する時間を取ってください。ユーザーがチェックアウトを完了できなくなるバグは、ささいな表示の問題とは大きく異なります。

発生頻度、完全なブロッカーかどうか、既知の回避策があるかどうかについて言及してください。その情報は修正の優先順位付けに役立ちます。

Loom のコメントやリアクションの機能もここで役立ちます。バグが発生した正確な瞬間にタイムスタンプ付きのコメントを残すことができるため、視聴者はその箇所に直接ジャンプでき、動画中を探し回る必要がありません。

Loom では、ブラウザの種類、デバイス、コンソール ログ、ネットワークの詳細など、開発者がトラブルシューティングに必要な技術的な状況情報も自動的にキャプチャされます。これにより、レポートを提出した人と解決にあたるチームとの間で通常発生するフォローアップ質問のやり取りがなくなります。

ステップ 6. バグ レポートを見直してトリミングし、Loom AI で磨きをかける

録画を共有する前に、再生して確認しましょう。不明瞭な部分がないか確認し、不要な間や偶発的な無音時間を削除します。簡潔な動画は視聴しやすく、行動を起こしやすくなります。

この処理は、Loom の AI を活用して簡単に行えます。動画編集の経験がなくても、誰でも洗練されたプロ仕様の録画を作成できます。AI を活用した編集により自動的に不要な部分を除去できるため、明確に話す必要があるにも関わらず、カメラの前では緊張してしまうチーム メンバーにとっては特に助けになります。

ステップ 7. 録画をチームと共有して、各自の都合がつく時間に確認できるようにする

Loom リンクをコピーして、チームが作業している場所 (Slack、メール、バグ追跡ツールなど) にドロップします。

Jira を使用している場合、さらにスムーズに渡すことができます。[Generate] タブから、[Create in Jira] ボタンを使用して、Loom を離れることなく、チームの Jira ボード上に直接、作業項目を作成できます。動画、状況情報、詳細が作業を行う場所に直接送られます。

チームメイトはそこから非同期コミュニケーションを通じて視聴し、コメントし、認識を揃えることができます。スケジュールの調整は不要です。Loom を使った非同期作業により、分散チームは都合の良い時間に問題を確認し、議論し、認識を揃えることができるため、フィードバック サイクルが高速化され、不要なミーティングを削減できます。


バグ レポートを記録する際に含めるべき重要な要素とは

強力なバグ レポート動画は、次のような要素をカバーする必要があります。

  • 明確な再現手順: 開発者が推測せずともバグを再現できるように、バグを引き起こすすべてのアクションを順番に説明します。
  • 挙動の可視化: 口頭で説明するだけでなく、画面上で実際に起こっていることを視聴できるようにします。
  • 期待される結果と実際の結果: 何が起こるべきだったか、そして代わりに何が起こったかを明確に記載します。この枠組みにより、問題をただちに把握できます。
  • 影響と重大度のコンテキスト: バグが誰に影響するか、どの程度の影響があるのかを説明して、チームが適切に優先度を付けられるようにします。
  • 環境の詳細: Loom はブラウザーとデバイスの情報を自動的に取得しますが、必要に応じて OS、アプリのバージョン、またはアカウントの種類を言及すると役に立ちます。

Loom でバグ レポートを記録するタイミング

すべてのバグ レポートに Loom 動画が必要というわけではありませんが、場合によっては画面録画のほうが文章だけのメモよりもはるかに効果的です。バグ レポートを記録することが理にかなう実際のシナリオをご紹介します。

  • ライブ通話なしで正確な再現手順を示す必要がある場合: 異なるタイム ゾーンで作業している場合や、バグをテキストで説明するのが困難な場合があります。
  • 開発/QA がコメントを何度もやり取りしており、膠着している場合: バグが発生した手順を読みながらそれを再現しようとするのは、簡単ではありません。
  • 技術者以外の報告者が、目の前の状況を明確に示す必要がある場合: カスタマー サクセス チームやマーケティングの担当者が、有用なバグ レポートを提出するために適切な専門用語を覚えるのは効率的ではありません。
  • 特定の条件下でのみバグが発生する場合: 特定の順番でクリックした時に発生するバグや、特定のユーザー権限でのみ発生するバグの場合、説明するよりも実際に見せるほうが早くなります。
  • 視覚的な問題が関わる場合: レイアウトの問題、レンダリング エラー、アニメーション グリッチなどは、文章では正確に説明できないことがほとんどです。
  • 断続的なバグを報告する場合: 問題が毎回発生するわけではない場合、発生したときに動画でキャプチャすることで、チームが作業する際の具体的な材料を提供できます。
  • バグが複数の画面やタブにわたり、複数のステップで発生する場合: 複雑なワークフローを順番に説明する際は、番号付きリストよりも動画のほうが理解しやすくなります。

Loom でバグ レポートを適切にキャプチャするためのヒント

より効果的なバグ レポートを作成するには、いくつかの習慣を身に付けることが大事です。初めてレポートを作成する場合でも、すでに何度も作成している場合でも、次のようなヒントをお役立てください。

  • 焦点を絞る: できるだけ 1 つの動画につき 1 つのバグを記録しましょう。複数の課題を 1 つの記録にまとめると、開発者が課題をトリアージして作業を割り当てることが困難になります。
  • 操作内容を説明する: 単にクリックするのではなく、今何をしているのか、そしてその理由を説明しましょう。各ステップについて説明することで、背景知識を持たない人にも有用な録画になります。
  • カーソルの動きを意図的に使用する: 重要なエリアに注意を向けられるように、マウスを動かしましょう。バグが表示される箇所の近くにカーソルを置くと、視聴している人が何に注目すべきなのか、正確に把握しやすくなります。
  • 明確なタイトルを記載する: 「プロモ コード適用後にチェックアウト ボタンが反応しない – Safari」のようなタイトルは、「チェックアウト時のバグ」よりもはるかに分かりやすいでしょう。適切なタイトルを付けることで、チームが動画を 1 つずつ開かなくても、検索、ソート、優先順位付けを行えるようになります。

Loom とは、人気のバグ レポート ツールの 1 つであり、ソフトウェア ドキュメント ツールと統合することで、すべてを一元的に整理できます。


ビジュアル レポートでバグの解決を加速させる

バグの説明を文章で記述しようとすると、それに関わるあらゆるメンバーの作業速度を落とすことになります。レポートを提出する人はすべてを記録するのに苦労する一方で、それを読む開発者は詳細を推測しなければなりません。QA のチーム メイトがバグを再現しようとしても、多くの場合で行き詰まります。チームの誰もが素早く視聴できる短い Loom 録画によって、こうした手順を置き換えましょう。Loom の画面レコーダーでは、課題を明確にキャプチャして、動画プレゼンテーション形式の手引を追加し、それをすぐに共有できます。

一度共有すれば、チームに必要なものがすべて揃います。フォローアップの電話も、確認のメールも、誰かが対応可能になるまで待つ必要もありません。