開発者が思う「バグ報告時」の欲しい情報
Webアプリやスマホアプリなど開発している人なら、共感してもらえるんじゃないかと思うけど、テスト時などでバグが出た時に当然報告を受けることある。でもその報告内容が不十分で修正に時間がかかりすぎる、なんてことありますよね？
なのでテスト実施者に対して、自分がいつも思う「バグ報告時に欲しい情報」を偏見ながらまとめてみた。
(足りない部分があったらごめんなさい。)
バグ報告時の三大「欲しい情報」
１．バグの概要および再現方法
これらは必然的に欲しい情報。
・バグの概要について
「どのようなバグが発生しているか」を記載してくれないことには、こちらとしてもバグと認定できない。というか、もしかしたらその動作が仕様なのかもしれない。
つまり開発者と報告者の互いが「これは確かに動作がおかしい」と認識が一致することがバグと認定する条件。
・再現方法について
バグの概要と等しく重要な情報。再現方法を記載せずバグの概要だけ書かれても、再現しないことには修正もできない。本当にそんなバグ発生するの？と首をかしげることもしばしば。
これらの情報が無いとどうなるかというと、原因を特定するまでに時間を要してしまう。原因を特定する時間が一番かかると言っても過言ではないので・・・。
概要と再現方法さえ記載されていれば、その手順を踏んでみるだけで良く、またそのバグが環境依存なのかどうなのかもわかる可能性があり、修正する側としても時間短縮にもなるのでたいへん助かる。そのうえで「何回実行して同様のバグが何回発生したか」も記載してくれると最高。仮に再現率が極端に低い場合は優先度を下げられるので。(最終的には直さなくてはいけないけど)
２．期待する結果
いわゆる「どのように動作すれば正常と判断するか」を明記して欲しいということ。この内容が無いと正直どのように修正を施していいかがわからないから、これも必須。
これを記載してほしい最大の理由は「正常な動作の認識合わせ」にある。書いていないからと言って直さないわけではないが、認識が合っていないと三度修正しないといけなくなる可能性が出てきて手間がかかる。単刀直入に言うと、時間の無駄。
いや書いて無かったら聞くか・・・普通。
３．再現環境
「Androidでは発生しないのにiOSでは発生した」「Chromeでは発生しなかったがFirefoxでは発生した」など、確認しているブラウザやアプリのバージョンなどが違う、スペックの弱い/強いで、発生する/しないが出てくるため、ほぼ必須。
特にWebアプリなどはブラウザとJavascriptの相性もあって、より重要だったりする。
ちなみにSVNのリビジョンの違い云々もあるので、どのリビジョンでテストしたかも記載すると最高。
バグ報告時のあった方が「より良い情報」
１．証拠(エビデンス)画像やドキュメント、その他
キャプチャなどの画像やエラーログなどなど。
特にエラーログは欲しい情報の一つ。どのようなエラーかで粗方の原因は推測できるから。自分が組んだシステムなら尚更推測が容易になる。
また「百聞は一見に如かず」ということわざがある通り、一目でわかるようなものがあれば最高。特にキャプチャ画像はどのようなバグがを再現せずとも大体想像できるので可能であればお願いしたいレベル。
２．前提条件
テストをする際にいくつかの条件を設定する場合があると思う。例えば、「このチェックボックスをONにして、このラジオボタンを選択しておく」など。
こういう特定の条件で発生するケースもあるため、それらを記載してくれると再現する際にさらに楽になる。ただしそれだけのケースで発生しようがしまいが修正する際には全ケースをチェックしないといけないので、個人的には「できれば欲しいなぁ」ぐらいな感じ。
まとめ
下記については絶対記載してから報告して欲しいな、という願望。
バグの概要および再現方法
期待する結果 (正常な動作)
再現環境
これを入れるだけで大幅な時間短縮になるので、マジでお願いします。
余談
バグを修正する際のチャートと所要時間の割合
自分がいつもバグ修正する手順と大体の所要時間の割合を記載してみる。ちなみに上記の『バグ報告時の三大「欲しい情報」』が記載されている場合。(括弧は割合数値)
バグ再現 (1)
原因調査および修正案の提示 (2.5)
バグ修正 (2)
デグレードの確認 (4)
コードレビュー依頼 (0)
指摘事項の修正 (0.5)
再現手順が明記されていると、デグレードの確認が一番時間がかかっている。これは修正したことにより他に不具合が出ていないかという確認で一番重要な工程。
まあバグ修正の規模にもよるけれどね。これはあくまで一例であり自分の感覚。
以上。
この記事が気に入ったらサポートをしてみませんか？