バグを起票・報告する際の小さなテクニック

この記事はソフトウェアテストの小ネタ Advent Calendar 2018 – Qiitaの1日めです。

テストでバグもしくはバグらしきものを見つけたら、次はBTS(バグトラッキングシステム)などに起票することが多いかと思います。

そこで今回は、私がバグを見つけたときに起票・報告に使っている小テクをご紹介します。

なお、いわゆるバグ票の良いフォーマットの話や、バグ管理システムの導入などについては触れません。記事の末尾に参考資料を載せておきますのでそちらを参照ください。

バグの起票・報告時の小テク

起票内容はテンプレを用意する

人によって起票のフォーマットがバラバラだと見る側やレビューする側が辛いので、フォーマットはなるべく揃えるようにしたいですよね。

バグを管理するシステム側でテンプレート機能があれば積極的に使います。テンプレート機能が無い場合は、ブックマークレットなどを作成&共有して、ワンクリックで挿入できるようにするとよいでしょう。

もちろんGoogleAppScriptなど外部と連携して挿入できるならそれでもOK。

客先常駐だとそういったツール追加や外部との連携に制約があることが多かったので、私はブラウザのみで書けるブックマークレットに頼っていました。

参考:Backlogの課題の詳細にテンプレートを挿入するブックマークレットを作った – ひびテク

画面を録画して、動画で伝える

どういったバグが発生しているのか、文章のみで伝えようとすると難しいことがあります。

バグ起票で「バグ起きてます」「再現しません」「いやおきます」「いやいや・・・」という、QA・テストチームと開発との間で何往復もやりとりが続いてお互いイライラするパターンは避けたいところ。

そのため、文章だけで伝えづらい場合は画像や動画を積極的に使うようにしています。

画像はWindowsであればSnippingToolを使えば楽にキャプチャできますが、意外と知られていないのがパワポで画面録画が出来ること。

PowerPointにはデスクトップの操作を動画にする機能があるので、動画撮ってファイルサーバにでもおいて見てもらえば、一発で何が起こっているのかを伝えることができます。

パワポで画面録画

検索用に表記を揺らすor別でキーワードを書いておく

これは反対意見もあるかもしれませんが・・・

不具合に出会ったときに「あれー、確か前にこれ似たようなのあった気がするな・・・」というとき、バグ管理システムに検索をかけるのですが、システムによっては検索機能がそれほど優秀でない場合もあります。

そんなときは検索にかけるキーワード頼みになるので、キーワードにひっかかりやすいような書き方をします。

たとえば「特定の操作をすると画面が固まって操作を受け付けなくなる」というバグを過去に起票していた場合。このチケットを発掘しようとして「画面 フリーズ」と検索すると、「固まる」と「フリーズ」で表現が異なるため、検索に出てきません。

こういった状態を避けるため、起票時には

以下の操作を行うと、画面が固まる(フリーズする)。

のように、カッコをつけたり、あるいは本文中で「固まる」と「フリーズ」の両方を使ったりします。

表現が変わるのが気持ち悪いので、カッコ書きするほうがマシだと思っています。

まとめ

小ネタとしていくつか紹介しましたが、

  • 書き手と読み手双方を楽にする
  • 手戻りを防ぐ

ためにできるちょっとした工夫は沢山あります。

よければお試しください。

その他参考

バグ票の書き方参考

今回の記事で触れていない部分の参考になる資料です

この記事を書いた人

yoshikiito

都内でテストエンジニア&ブロガーをやっている@yoshikiitoです。

ソフトウェアエンジニアの学習方法や成長するための考え方、会社に依存せず自分の力で生きていけるエンジニアになる方法などについて興味があります。
こういった方法や考え方、自分が試したことなどをブログを通じて発信します。

仕事は主にソフトウェアテストやテスト自動化。
趣味は浦和レッズと読書と技術書を買って積むこと。

技術評論社から本を出すのが夢

この記事が気に入ったら
いいね!しよう

最新の情報をお届けします