エンジニアが嬉しいバグ報告の仕方

「こうしたら」「こうなった」「こうなってほしい」を後から参照できる形で書く

• 書くべき理由
  • 誰が見てもわかる(ように書けるという前提)
  • 言った言わないにならない
  • 人間は忘れる

「こうしたら」が分かると原因を調べて直すのがとても楽になります。100%再現する、たまに起こる、こうすると起こらない、みたいな情報もあればあるほど助かります。

• 例
  • 「画面Aでテキストボックスに絵文字を入力して保存ボタンを押したら」
  • 「メッセージ送信画面で送信ボタンを連打したら」

状況だけでなくアクションも教えて下さい。

• 例
  • 「フォロワーが0人の時プロフィール画面で落ちる」
    • 「フォロワーが0人の時プロフィール画面を 開くと 落ちる」
    • 「フォロワーが0人の時プロフィール画面で ○○を押すと 落ちる」

「こうなった」はより具体的に書いてください。

• 例
  • 「表示がおかしくなった」→「名前が長すぎて改行してしまい、テーブルのレイアウトが崩れた」
  • 「エラーが出た」→「Error: **************というダイアログが出た」

スクリーンショットを添付するとレイアウトの崩れやエラーメッセージを正しく認識できるので助かります。

「○○(機能)ができない」は大体通じないので、具体的に起こって欲しい何が起きなかったかを教えて下さい。

• 例:　「プロフィールを更新できない」と言われても
  • 「プロフィールを書き換えても保存ボタンが押せない」
  • 「保存ボタンを押すと「通信に失敗しました」というエラーダイアログがでる」
  • 「保存ボタンを押すと落ちる」
  • 「保存ボタンを押すと成功したように見えるが、プロフィール画面に行くと反映されてない」

「こうなってほしい」は、仕様漏れなどで動作が決まっていなかった時は特に欲しいです。「こうなってほしい」がわからないと直せません。

• 例: 「名前が長すぎて改行してしまい、テーブルのレイアウトが崩れた」に対する「こうなってほしい」
  • 名前は20文字までしか入力できないようにしてほしい
  • 長すぎる時は「…」を付けて省略してほしい
  • などなど

「正しく表示されて欲しい」は具体的でないので困ります。仕様がまとまってるところへのリンクとかでいいです。

そのシステムで使われている名前で説明する

• 例: 「ユーザー名が表示されない」

  • ユーザーID？
  • ニックネーム？
  • 本名？
  • 「ユーザー名」っていう名前の情報はアプリ内にないんだけどどれ？

• 例: 「投稿画面を開くと落ちる」

  • 作成画面？
  • 一覧画面？
  • 詳細画面？

単語を正しく使う

使い分けられますか？

• バグ
• エラー
• 落ちる

その他

「アプリが原因かサーバーが原因かわからん」みたいなのは、上記の書き方を満たしていればエンジニアのほうですぐに判断できるので、やろうとして起こったことを素直に具体的に書いてもらうのが一番いいです。
変に推測して書かれるとかえってわかりづらいです。