せっかく見つけたバグが「再現しませんでした」で戻ってくる。原因の多くは、バグそのものより報告の書き方にある。
バグ報告が「再現しません」で返ってくると、見つけた側も直す側も時間を失う。やり取りが一往復増えるたびに、修正は遅れる。たいていの原因はバグが気まぐれだからではなく、前提条件が報告から抜けているからだ。直す人は、書かれたとおりにしか再現できない。
環境を最初に書く
OS、ブラウザとそのバージョン、端末、ログイン状態、アカウントの種別。当たり前のものほど抜ける。自分の環境では起きるのに相手の環境では起きないバグは、ほとんどここで決まる。一行でいいので、必ず先頭に置く。
「操作」ではなく「状態の遷移」を書く
「ボタンを押すと落ちる」では再現できないことが多い。「未ログインの状態で、カートに2件入れて、クーポンを適用してから、ボタンを押すと落ちる」。再現は前提が9割だ。何をしたかより、どういう状態で何をしたかを書く。
期待と実際を分ける
「おかしい」ではなく、「こうなるはずなのに、こうなった」。期待値と実際の挙動を分けて書くだけで、相手は「何が問題なのか」を読み取らなくて済む。スクショは1枚で十分。矢印を1本引いて、どこを見てほしいかだけ示す。
1チケットに1事象
関連して見えるバグをまとめて1枚に書くと、片方だけ直して「直りました」で閉じられる。面倒でも、事象ごとに分ける。粒度をそろえておくと、あとで「何が残っているか」も追いやすい。
いいバグ報告は、書いた本人がその場にいなくても再現できる。誰が読んでも同じ操作にたどり着ける——それを目標にすると、報告の質は自然と上がっていく。