バグ報告をするときに書き留めておきたい項目

自分の経験値をアウトプットするシリーズ

改修者にやさしいバグの報告とは

何かしら「バグってる！」と思ったとき、それは直さなければいけないのだが、それを直すべきか、直すためには何を書き残しておくとよいのかというのは人によって観点はバラバラであることが多い。そのため、何を書き残しておくと直す側にとって優しいのかを挙げてみる。

大きく分けると3つ

まま文字通りに起きたことを書く。文章で表現できる内容であればそれを記載すればいいし、もし絵面としての崩れなどであればそれを画像として保存しておくとよい。そうすれば、より起きた不都合な事象がわかりやすくなる。

「バグった」と認識するからには期待される事象が別にあるということになる。これの記載がないと、直すべきゴールが見えないので書くことで認識合わせのコストがグッと減る。

そのバグを起こす手段を記載する。原因特定にもつながるだけではなく、そのバグが本当に直せているかの確認の際にも必要になる。また起票者としてもこの項目がかくことにより、自身の見間違いではないなどのセルフチェックにもつながる

文章の内容は正しく伝えること、端的な表現だとバグの状態を読み取り間違えてしまうことがある。

例えば「年齢の部分が間違っています」という書き方だと「年齢の値が漢数字で表示されるところが英数字になってしまっています」という意味でも通るし、「年齢の枠のデザインのCSS色が意図したものと違います」とも受け取れるので、正しく書くことがコミュニケーションコストの削減につながる。