バグ票に盛り込むべき5つの項目

コンピュータのプログラムを書くお仕事の話です。

最近の若者や中国人には適切にバグ票を書けない人が多い。
適切にバグ票を書けない人が適切にバグを修正できるのか？
私がこれから上げる5つの項目を盛り込むよう指示しても「なんでですか？それ不要だと思うんですけど？」等と言って平気で仕事を放棄する。
こういう人に限ってコーディングが荒かったり、修正不十分があったり・・・
一人でも多くの人に適切にバグ票を書ける（＝適切にバグを修正できる）ようになってもらいたいと思い、ここにバグ票に盛り込むべき5つの項目を示します。

１：現象

どのような現象が発生しているのかユーザ目線に立ってキチンと分析し文章にしましょう。

例：
〜テキストボックスに「’テスト’」と入力し、「登録」ボタンを押下するとエラー画面に遷移し「〜」と言うメッセージが表示される。

現象欄にイキナリ原因を書く人が最近多いように感じます。

ダメな例：
〜テキストボックスに「’テスト’」と入力するとシングルクォートをエスケープしていなかったのでSQLが不正になりDBへのinsert文でSQLの構文エラーが発生する。

シングルクォートを入力する事でSQL文の構文が不正になるのはバグ発生の原因です。
現象ではありません。
注意しましょう。

２：技術的原因

バグが発生した技術的な原因を文章にしましょう。
あくまで「技術的」に的を絞って書くのがポイントです。

例：
入力項目にシングルクォートが含まれているとSQL文の構文が不正になり、DBへのinsert時に構文エラーとなる。

３：動機的原因

「なぜそのバグを作りこんでしまったのか？」「自分のどこが悪かったのか？」鳥瞰して見て文章にしてみましょう。

例：

1. SQLで使う特殊文字が入力された場合に対する考慮が漏れていた
2. テストを代表的な入力例だけで済ませてしまい、すべての入力可能文字を使ったテストを行なっていなかった。

動機的原因を文章にする事は自分の成長のために有効な手段です。
これを文章にするのは辛い事ですが、バグ票を記述する真の理由はここにあります。
もっとも力を注ぐ部分と思います。

４：対策

１〜３を文章にして初めて適切な対策が明確となります。
ここまで読んでいただけたらこの項目に何を記述するべきかは自明ですよね？

例：
〜テキストボックの入力文字列の「’」を「¥’」に置換するコードを追加する。

５：再発防止策

類似不良の摘出や自分の成長のためにも再発防止策を文章にする事は2番目に大切な事です。
１〜４を順を追って文章にして来たならどのような文章を書くべきが自明ですよね？

例：

1. SQL構文において特殊な意味を持つ文字を調べて洗い出し、それらが入力された場合について対策を検討する
2. すべてのテキストボックスについて入力可能文字すべてを使ったテストがチェックリストに記述されているか確認し、記述されていない場合は追記して実施する

バグ票はバグを報告する書類であると同時に自分の成長のためのツールです

最近の若者や中国人等には「動機的原因」や「再発防止策」を記述しない・できない人が多いと感じます。
「動機的原因」「再発防止策」は自らの成長と言う意味で最も重要なパートです。
適切に記述するように心がけましょう。

気がつけばレベルアップした貴方がいるハズです。(^^)