当ブログの読者の皆様、バグの報告をする機会ってどれぐらいありますか?本記事の中の人は日常的にテスト業務を行なっており、テストの際にはほぼ毎度バグが見つかります。今でこそある程度のバグ報告ができている(はず笑)のですが、この仕事を始めて間もない頃はバグ報告の書き方についてボスによく指導していただいてました。せっかくなので今回は”バグ報告をする時に大事なこと”と題して貯めてきたノウハウを放出していきたいと思います。
大事なことっていっぱいあるんですけど、全てに共通する1番大事なことは”確実に伝わる書き方をすること”です。
Coolwareでは日常の業務管理をRedmineを用いて行なっています。そのためバグが見つかった際にはチケットを発行するわけなのですが、このチケットの書き方がキモとなります。
”端的に内容を伝えること”です。
バグ報告を受けたプログラマーはまず、バグを再現した上で修正作業にとりかかるため、手早く確実に報告のあったバグを開発環境で再現できなければ「バグが再現しません!!」と報告がつき返されるのです。しかも、「時間をとらせるんじゃねー!」って感じでちょっと機嫌悪そうな時も・・
( ; ω ; )
バグ以外にもチケットは大量に発行されているため、チケットのタイトルでそのチケットの内容が何なのかを明確にする必要があります。もちろんチケットのトラッカーは”バグ”とした上で、端的に内容を伝えるタイトルをつけます。それと同時に、バグが発生している箇所も記載します。チケットのタイトルにバグの発生箇所を記載するだけで、1箇所に複数の修正があった場合、二度手間になることを防げます。もちろんこれは基本的なことなので、バグの内容がどうしても端的に説明できなかったり、発生場所の説明が長すぎる場合はチケットの本文に持ち越します。
タイトルにはある意味端折って内容を書いてるわけなので、よっぽどわかりやすい内容とかでない限りまずはバグの発生箇所・内容を改めて記載します。一目でバグが明らかなものもありますが、バグの再現手順を厳密に説明しないと伝わらないものもあるため記載していきます。バグの再現手順もダラダラと書くわけではなく、箇条書きにするなどしてスマートに書きます。(こんなこと言ってますがブログはだいぶダラダラですね(苦笑))
もちろんバグのある箇所を文章で”〇〇のページの××という項目”と書いてもいいんですけど、人間やっぱり画像の方がその辺よく伝わるんですよね。というわけで、大体のバグチケットに画像をつけます。多くの場合はバグの発生箇所のスクリーンキャプチャに印をつけて添付します。
この記事の中の人はMac大好きでWindowsでの方法は少し変則的ですが、どちらの場合も画像を貼るだけでなく画像に注をつけています。
Macの場合は⌘⇧3で全画面キャプチャ、⌘⇧4で選択範囲のキャプチャ、⌘⇧4の後にスペースを押すとウィンドウ単位のキャプチャが取れます。まずはこれらをうまく用いてあまり無駄部分が入り込まないように撮影を行います。次にフリーソフトのSkitchにて書き込みを行います。下図は当ブログの記事”Android Studioから実機にアプリをビルドすると毎回クラッシュする時の対処法“より引用している画像です。ブログ用に作成した画像なので実際のバグ報告とは少し異なる箇所もありますが、伝えたい箇所には赤枠をつけ(場合によっては文字も追加)、見せてはいけない箇所にはモザイクをかけるなどの処理をしています。
Windowsの場合はSnipping Toolを利用してスクリーンキャプチャの作成を行なったり、Screenpressoを利用してキャプチャの作成や編集を行なっています。
バグの再現方法が比較的少ない工程の場合は良いですが、テストデータを作成してからでないとバグが再現しない場合もあります。そのような場合はデータベースをエクスポートしてSQLファイルを添付することも有用です。これがあればバグを再現するための環境づくりが一発で完了します。
ここまで書いてきた内容で普段はバグチケットを発行しバグ報告を行うわけなのですが、人間の操作なのでミスが生まれることもあります。Redmineの場合はチケットの説明(本文)の際修正や、コメントの追記なども行えるのでそれらも有効に利用しながら伝わりやすいバグ報告を目指しましょう!!。