unoh.github.com

良いバグレポートの書き方

2006-05-22 10:58:39 +0000

こんにちは!やまもと@テスト番長です。

連日テストをしていると飽きませんか?とたまに聞かれるのですが
実はちっとも飽きていません。怪しい現象を追跡したり、
発生しそうなバグを予測したりと、
さながらハンティングみたいなものだと思っている節があります。

さて、今回はバグレポートを書く時に、より良いものになるよう
普段気をつけていることをご紹介してみましょう。

・言葉使いを丁寧に
 読む側はどんなコンディションで見ているかわかりません。負担を掛けないよう冷静に公正に。

・要約を分かりやすく書く
 本文をじっくり読まなくてもすぐ理解できるように書きましょう。

・5W1Hを忘れない
 前提条件を記述しないときちんと伝わりませんよね。

・原因の見当が付いていても断定しない
 余計なお世話になり、プログラマをいらつかせる可能性大です。
 見当を付けた先を更にテストして、状況証拠を増やしておくのはOK。

・再現しないバグも報告する。
 ダメもとで報告してみましょう。話を聞いて何か思い当たってくれるかもしれません。

・証拠を提出する。
 画面キャプチャ・ログなどはなるべく添付しましょう。必ず役に立ちます。

・すばやく報告する。
 発見したときすぐに報告しないと、別の現象に隠れて確認できなくなったりするかもしれません。

・問題を選り分ける
 デバッグが進むうちにタイトルと内容がズレてきたら、臨機応変に別スレッドを立てましょう。

・重要度をつける
 バグの量が増えてタールの沼になりそうなとき、唯一の道標となります。

・仕様があやふやでも泣かない
 本来仕様に対してテストを行うのですが、全て揃っているとは限りません。
 ドキュメントが無ければ自分が作るくらいの心構えで参りましょう。


まだまだ色々ありそうですね。
他にも良いのがあればぜひ教えてください!