プログラマに優しいバグレポートの書き方

31
プププププププププ ププププププププププ ププププププププ ププププププププププププププ ププ ププ

Transcript of プログラマに優しいバグレポートの書き方

Page 1: プログラマに優しいバグレポートの書き方

プログラマに優しいバグレポートの書き方

東京開発グループリードソフトウェアエンジニア

牧野 克俊

Page 2: プログラマに優しいバグレポートの書き方

バグとは?

Page 3: プログラマに優しいバグレポートの書き方

コンピュータプログラムに含まれる

誤りや不具合のこと

Page 4: プログラマに優しいバグレポートの書き方

バグを修正するためには何が必要?

Page 5: プログラマに優しいバグレポートの書き方

プログラマがバグを再現する

Page 6: プログラマに優しいバグレポートの書き方

そのためには?

Page 7: プログラマに優しいバグレポートの書き方

〜をしたら〜になった「原因と結果」

Page 8: プログラマに優しいバグレポートの書き方

バグレポート

Page 9: プログラマに優しいバグレポートの書き方

何を報告したらいいの?

Page 10: プログラマに優しいバグレポートの書き方

• 分かりやすい要約• 前提条件• 時間・ユーザ(キャラクター)名• 起きた現象の詳細• 証拠• 詳しい再現手順• カテゴリ• 重要度・優先度

Page 11: プログラマに優しいバグレポートの書き方

• 分かりやすい要約–結論から記述し、理由や経緯を簡

潔にまとめる

Page 12: プログラマに優しいバグレポートの書き方

• 前提条件–アプリのバージョン–接続先サーバ–自分の環境

• 時間・ユーザ(キャラクター)名–サーバにあるログを特定するため

の情報

Page 13: プログラマに優しいバグレポートの書き方

• 起きた現象の詳細• 証拠–画面のキャプチャー–ログ

Page 14: プログラマに優しいバグレポートの書き方

• 再現手順–同じことが複数の方法で可能なら

ば、自分がとった方法を–あるならば回避方法

Page 15: プログラマに優しいバグレポートの書き方

• カテゴリ• 重要度・優先度–過大評価しない–頻度(=再現の手軽さ)–影響範囲(人数)

Page 16: プログラマに優しいバグレポートの書き方

• オンラインゲームでは進行不能 >= データ不整合

> サーバダウン > ルール> クライアントダウン > グ

ラフィック > 文言

Page 17: プログラマに優しいバグレポートの書き方

プログラマの反応

Page 18: プログラマに優しいバグレポートの書き方

「いや問題でないよ」

Page 19: プログラマに優しいバグレポートの書き方

「いや問題でないよ」

• プログラマの手元では動いている• 動かないのは環境や状況に違いが

ある

Page 20: プログラマに優しいバグレポートの書き方

「いや問題でないよ」

• なので、–操作、手順に違いがないが–環境にどんな違いがあるか–勘違いしていないか

Page 21: プログラマに優しいバグレポートの書き方

「どうやって再現するの」

Page 22: プログラマに優しいバグレポートの書き方

「どうやって再現するの」

• 操作を正確に伝える–手順–対象

• 勘違いに気をつける

Page 23: プログラマに優しいバグレポートの書き方

「もう起こせないの」

Page 24: プログラマに優しいバグレポートの書き方

「もう起こせないの」

• 何かがおかしくなったら、ただちに何をするのもやめる• 可能なかぎり状況を保存した上で

再現確認

Page 25: プログラマに優しいバグレポートの書き方

「もう一回試してみて」

Page 26: プログラマに優しいバグレポートの書き方

「もう一回試してみて」

• 面倒くさがらないで• 以前との違いに注意–特にエラーメッセージの違い

Page 27: プログラマに優しいバグレポートの書き方

その他諸注意

Page 28: プログラマに優しいバグレポートの書き方

• すみやかに報告する• 既に報告されていても報告する–(正しい)情報は多いほどいい

• 再現方法がわからなくてもとりあえず報告する

Page 29: プログラマに優しいバグレポートの書き方

• 推測は書かない–書くならば推測だと分かるように

書く• 問題を切り分ける• 要約以外は冗長なぐらいがいい

Page 30: プログラマに優しいバグレポートの書き方

• 代名詞は避ける• 絶対に読みなおす–間違い・抜けがないか–何も知らない人から見て理解でき

るか

Page 31: プログラマに優しいバグレポートの書き方

• 仕様を調べる–期待した動作が間違っていないか