Macでバグをステップ形式のスクリーンショットに記録する方法

この記事では、ほかの人が再現できるソフトウェアのバグについて、スクリーンショットの証拠を集める方法を説明します。環境を記録し、期待結果と実際の結果を定義し、必要な操作を撮影します。証拠を整理し、送信前に報告を一度テストしてください。

要点: 役立つバグ報告には、明確な開始状態、正確な再現手順、期待結果と実際の結果、発生頻度、環境情報、最初に見える失敗の証拠が揃っています。

最初に環境を記録する

環境情報から、バグが起きる条件が分かります。アプリのバージョン、macOSのバージョン、デバイスの種類、アカウントまたは権限の状態、動作を変える設定を記録します。

条件を再現できるだけの具体性を持たせてください。「最新版」は次のリリース後に曖昧になりますが、「macOS 15.5上のShotomatic 1.8.2」なら後からでも役立ちます。

該当する場合は、次の項目を含めます。

• アプリとビルドのバージョン
• macOSのバージョン
• Macのモデルまたはプロセッサアーキテクチャ
• アカウントの種類またはプラン
• ブラウザとブラウザのバージョン
• 接続中のディスプレイまたは入力デバイス
• 関係する権限と機能設定
• ネットワークの状態

期待結果と実際の結果を書く

結果の組み合わせで、レビュアーが手順を読む前に問題を定義できます。本来起きることを1文、代わりに起きることを1文で書きます。

原因の推測ではなく、観察できる結果を使います。「PDF書き出しボタンを押しても何も起きない」は証拠です。「書き出しサービスが壊れている」は、確認されていない原因を前提としています。

例：

期待結果： Export PDFを選ぶと保存ダイアログが開く。

実際の結果： Export PDFを選ぶとメニューは閉じるが、保存ダイアログは開かず、ファイルも作成されない。

結果の横に発生頻度を加えます。毎回、断続的、特定の先行操作後だけ、のいずれかを明記してください。

既知の開始状態から再現する

明確な開始状態があれば、報告から隠れた準備を除けます。アプリを閉じて開き直す、新しいテストデータを作る、関係する設定を初期状態へ戻す、といった準備をしてから一連の操作を撮影します。

資料にする前に、その状態から一度バグを確認します。問題が再現しなくなった場合は、記憶を頼りに確信のある手順を作るのではなく、何が変わったかを記録してください。

必要な操作ごとにスクリーンショットを1枚撮る

各スクリーンショットは、レビュアーが次の操作を繰り返す、または失敗を見分ける助けになるものにします。開始状態、すべての必須クリックまたは入力、最初の誤った状態、診断を変えるエラーメッセージを撮ってください。

結果に影響しない操作は省きます。ウインドウを横へ動かす、無関係なパネルを開く、といった操作は、発生条件の一部でない限り余計な情報です。

Action Captureを使う場合は、きれいな開始状態から通常の速さで問題を再現します。Shotomaticは受け付けた各クリックの直前に対象状態を保存し、クリック位置を記録するため、再現手順の最初の下書きができます。Freeのセッションは5ステップまで保存でき、Proではセッションのステップ数制限がなくなります。

状態変化を説明する文章を加える

スクリーンショットだけでは分からない内容を、短い文章で説明します。操作名、入力する値、操作後に期待する変化を記載してください。

次の形式で書きます。

1. 操作： Export PDFを選ぶ。
2. 期待するチェックポイント： 保存ダイアログが開く。
3. 観察された結果： メニューが閉じ、ダイアログは開かない。

「ここをクリック」のように、見えているマーカーを繰り返すだけの文章は避けます。クリックマーカーはすでに場所を示しています。文章では、コントロールの名前と、次に確認することを伝えてください。

非公開情報を守る

報告がテスト環境の外へ出る前に、非公開情報を除きます。可能ならサンプルアカウントとテストデータを使ってください。後から覆い隠すより、元データを置き換えるほうが安全です。

実データを避けられない場合は、無関係な範囲を切り取り、名前、メールアドレス、メッセージ、トークン、ライセンス情報、顧客記録、通知プレビューをぼかします。レビュアーが画面を特定できるだけの周囲のUIは残してください。

切り抜き、ぼかし、サンプルデータのどれを使うかは、別の墨消し確認手順で判断します。

バグ報告の構成

次の構成なら、報告を長い物語にせず必要事項を揃えられます。

タイトル：

環境：
- アプリ／ビルドのバージョン：
- macOS／デバイス：
- アカウントまたは権限の状態：
- 関係する設定：

期待結果：

実際の結果：

発生頻度：

前提条件：

再現手順：
1.
2.
3.

証拠：
- 各必須操作のスクリーンショット
- 最初に見える失敗
- 必要な場合、エラーメッセージまたはログ

回避策：

補足：

これは文章の構成であり、Shotomaticへ読み込めるテンプレートではありません。チームがすでに使っている課題管理ツールまたはサポートシステムへコピーしてください。

送信前に報告をテストする

最後の再現テストで、説明されていない前提を見つけます。報告に記載した環境から始め、記憶に頼らず文章の手順だけを進めてください。

同じ順序で記載した結果へ到達し、必要な値がすべて書かれ、スクリーンショットが正しい画面を正しい順で示していれば、報告を送れます。タイミングや動きに依存するステップには、文章の手順を主な参照として残しつつ、補助証拠として短い録画を添えてください。

Action Captureはクリック順を集められますが、報告には環境、期待結果、実際の結果、発生頻度も必要です。一般的な撮影と編集の流れは、Macでクリックからステップ形式の手順書を作る方法をご覧ください。