😍

エンジニアにモテるバグ報告のやり方

2022/02/19に公開

はじめに

エンジニアの方にバグを指摘する時、どんな風に伝えてますか?(特に文面で)
焦ってたりすると「表示がおかしいです!直してください!」みたいな感じで飛んでくる時も多いです笑
が...確認する側からすると解決に至るまでの情報が不足しすぎててコミュニケーションが爆増!解決も遅れる危険大です😭

基本的にバグ報告はテンプレ化できるので、紹介したいと思います。
こんな風にバグ報告すればエンジニアにモテます!知らんけど。

テンプレート

結論から言うと、slackだとこんな感じで自分は先輩エンジニアに相談したりします。

(バグの内容一言で)

🚨発生した事象
                                  
👉再現方法
                                    
🙏期待する結果
                                    
💻実行環境

追加で言うと、「解決に向けて試したこと」なんかもあると尚良いかもしれません👍

各項目の説明

🚨発生した事象

まずは、何が起こっているのかを具体的に伝えましょう。
「表示がおかしいです」ではなく、「どうおかしいのか」が伝わる具体度で伝えなければ、そもそも何が起こっているのかを認知できません💦

👉再現方法

発生した事象を再現する条件を伝えましょう。
ページ遷移の条件など、事象の要因が依存するものを限定することがスムーズな解決につながります。

🙏期待する結果

起こっている事象に対して、本来はどのような表示や挙動にしたいのかを伝えましょう。
何をもって解決とするか分かっていると、仕様上難しい課題のような場合でも妥協策を提案できます。

💻実行環境

再現方法と同様に、デバイスやブラウザ等実行している環境が分かるとスムーズです。
コンパイル関係のエラーの時なんかはNodeのバージョン等を記載することも多いです。

解決に向けて試したこと

さらに言うと...
解決に向けて既に試したことが分かっていると、同じことを試してしまう時間が省けるので効率的かもですね。

最後に

本記事で紹介したものは、シンプルなWebページの表示崩れなどの場合を想定しているので最低限の情報になります。
バックエンドやインフラなんかだとさらに細分化されるかもしれませんが、基本的にはこちらで紹介した項目があれば「どういうこと?」とはならないはずです。

Discussion

ログインするとコメントできます