正しいバク報告の仕方

みなさん、バグ報告をしたことはありますか?

バグ報告の際、どこまで書けばいいのかわからないという人もいると思います。相手が知らない人ならとりあえず細かく書いておけばいいみたいなところはあるんですが、知人相手に「OSはWindows 10です」みたいなこと言うのって明らかに頭悪いですよね。今回はバグ報告の仕方について説明します。

どこからバグ報告するか

有名なソフトウェアであれば大概公式の窓口があるので、そこから送信しましょう。

個人で開発しているソフトウェアであればメールかなんか送ればいいんじゃないでしょうか。

オープンソースだとGithubにIssue建ててねみたいなケースも多い気がします。

本来バグ報告に記載すべき事柄

本来、バグ報告をする際は以下のような事柄を記載すべきです。

  • 起こったこと(エラーメッセージが表示されたなど具体的に書く)
  • バグ発生までの手順(再現方法)
  • 発生した環境(特にWindows版とMacOS版がある場合など)
  • バージョン
  • 特殊な設定をしている場合それを書く
  • 期待する動作
  • スクショ
  • ログ

しかし、実際そんなちんたら書いていられませんよね。もちろん相手が知人でないならこれぐらい細かく書いておいたほうがいいのですが、知人に対して書かなければいけないことは何があるでしょうか。

これさえあれば大丈夫な事柄

  • どのアプリか
  • 起こったこと(スクショでわかるならスクショ)
  • 直前にやった操作

これだけです。

なぜこれらの項目が必要なのか

どのアプリで起こったのか

そもそもそんなに調べるの手間でもないですし、他のゲームとごっちゃにされる可能性を考えるとちゃんと書いておいたほうがいいです。

まぁ書いておいても読み飛ばして他のゲームとごっちゃにされることもあるんですけどね…

まれにほぼ1作しかゲームを同時に作ってないって人もいるのでなんとも言えませんが…

起こったこと

操作手順をたくさん書く必要があるのは「再現性が微妙なとき」です。全部の環境で起こるわけではないのなら、どういう環境で発生するのかはきちんと書いておくべきです。

一方、たとえば足場の当たり判定がおかしいとか、敵の挙動がおかしいみたいなバグのときは、ステージ名と起こった場所さえわかれば十分です。ステージ名とスクショさえ投げつけてくれればそれで事足りますよね?

ちなみにWindowsだとWin+Shift+Sでスクショ→クリップボードにコピーまでが一瞬でできてマークアップも簡単です。この機能Windows 10最大の改善点な気がする。

直前にやった操作

直前になんの操作をしたかは書いておくべきです。まれにエラーメッセージだけ送りつけてくる人がいますが、どの操作で生じたのかがわからないと直しようがないです。

まとめ

どんなバグ報告でも一緒ですが、相手が再現できれば勝ちですし再現できなければ負けです。「これで再現できるか?」を常に考えましょう。

逆に言うと、再現できればそれで十分です。相手が知らない人なら礼儀とかはちゃんとしておいたほうがいいとは思いますが、再現さえできればエラーレポートがどんなに頑張ったところでムダです。別に再現できるレベル以上にエラーレポートが細かったところでデバッグが楽になるわけでも勝手にバグが直るわけでもないです。

いかがでしたか?次回は中途半端なバグ報告を受け取った場合にすべき事柄について説明します。

2件のコメント

  1. 【バグ報告】
    ・起こったこと
    記事タイトルにおける濁点の欠落
    ・バグ発生までの手順(再現方法)
    ページのタイトルを参照する
    ・発生した環境(特にWindows版とMacOS版がある場合など)
    Google Chrome
    ・バージョン
    現バージョン
    ・期待する動作
    「バ『グ』報告」になっていることが望ましい。
    ・スクショ
    https://imgur.com/CHg7FcW
    ・ログ
    特になし

コメントする

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です