読者です 読者をやめる 読者になる 読者になる

Knowlbo 開発者ブログ

株式会社Knowlboの開発者ブログです。

バグ報告

バグ

Knowlbo 開発部の本橋と申します。弊社開発部で技術ブログを始めることとなりました。ソフトウェア開発に関する色んな事をこの場で発信し、同様の事に悩まされている方、同じ轍を踏みそうな方に少しでも貢献できればと思います。

初回はバグ報告についてです。

バグ報告

自社製品やサービスにバグが発見されると BTS/ITS を通じて開発者に報告されるのが一般的かと思います。 この段階でうまく報告できないと開発者と報告者の間で余計なコミュニケーションが発生し、お互いに無駄な時間を使うことになります。

そこで、開発者から見た時に「こんなバグ報告が欲しい」というのをまとめてみました。

開発者が欲しいバグ報告

  • 問題とその背景
    • 問題は何で、どう困っているのか。
  • 問題の再現方法
    • どういう状態で何をすると何が起こるのか。
    • 必ず起こるのか、たまにしか起こらないのか。
    • たまになら、必ず起こるときとの差異は何か。
  • 問題の回避方法
    • こうすれば大丈夫、みたいなのがもしあれば。
  • 温度感
    • そのバグの重大度だったり。
    • 対顧客の場合は顧客側の温度感。
  • デバッグに必要な情報
    • アプリケーションの出力するログ。
    • 再現に必要なファイル等がもしあれば。

そんなの全部書けない?

いくら開発者が欲しいと言っても、上記を全部埋められるケースはあまりありません (特に顧客から報告があった場合)。 そんな時は「不明」と書いておきましょう。少なくとも不明であることがわかります。判明したら追記しましょう。

そんなの面倒くさい?

結局は自分を助けることにつながりますのでできるだけ書きましょう。報告から1週間経って「あのバグなに?」と聞かれて即座に説明出来る人はあまりいないと思います。

コツは「1週間後に自分が読んで理解できるか?」を心がけることです。

最後に

初回からあまり技術的ではない内容になってしまいました。 ソフトウェアにはバグがつきものですのでバグ報告はとても重要です。しっかりとしたバグ報告スキルを身に着けていきましょう。