不具合報告の書き方｜実際の表示・期待する動き・再現手順を伝える - Smart Work Lab

不具合を伝えるときは、実際に起きた表示と、期待していた動きを別々に書きます。その前に何を操作したか、どの画面で止まったかも残すと、調べる対象を特定する材料になります。

私も自作アプリの改善を依頼する中で、表示されない、処理が止まるといった状況を伝えてきました。この記事では、そのような報告を整理するための書式を紹介します。書式の例は説明用であり、特定の原因や修正完了を示すものではありません。

最初に現象を一文にする

「使えない」ではなく、どの操作の後に何が起きたかを書きます。

［画面］で［操作］を行うと、［実際の表示や状態］になります。期待していた動きは［期待する結果］です。

原因が分からない段階で「データが消えた」「通信が壊れた」と断定しません。画面に何も出ていないことと、保存データがなくなったことは、別々に確かめる必要があります。

再確認していないなら「毎回起こる」と書かず、未確認とします。実際の注文や登録へ影響する操作は、同じ不具合を調べるために何度も実行してよいかを先に確認します。

画像だけでは、直前の操作や期待する結果が分かりません。画像に写った事実と、補足の文章を一緒に渡します。

画像を共有できない場合は、メッセージを文字で控える方法もあります。添付した画像が開けないときは、画像の共有状態を確認する手順で渡し方を確認します。

「いろいろ試した」ではなく、操作と結果を一組にします。

試した操作：［内容］
結果：［変化したこと／変わらないこと］
未確認：［まだ試していない条件］

試した順序も残します。設定変更やデータ更新が含まれる場合は、調査のために何を変えたのかが分かるようにします。改善したように見える場合も、同じ入力と操作で確認したかを書き添えます。

以下の不具合報告を整理してください。観測した事実、期待する動き、再現手順、試した操作、未確認事項を分けてください。原因を断定せず、確認できた根拠と次の調査を示してください。修正後は同じ条件で再確認した結果を報告してください。

作業範囲を最初に決める場合は、目的と完了条件を伝える依頼文も使えます。画面の自動操作が関係するときは、対象を絞って試す確認方法と合わせて調べます。

不具合報告では、現象、期待、操作順、試したことを分けます。自分が見た表示を事実として残し、原因や影響範囲は確認できるまで推測で埋めません。

修正後も「直した」という説明だけで終えず、元の条件で何を確認できたかを記録します。スマホからでも、この項目をメモにまとめて送ることで、調査に必要な情報を整理できます。