不具合報告するときに何を書いたらいいのかよくわからなくてめんどくさいになる自分の気持ちを多少でも緩和するために、こんな感じで書けばいいのかなの備忘です。
本職の方から見ると至らないかと思いますが、まず自分の中での整理です。

伝える内容

• 不具合内容の要点

• 発生した事象

• 再現手順

• 期待した結果

• 使用環境

それぞれ事実を簡潔に記載する。
感情的な話、要望の話は一緒に送らない。切り分けて別途送る。

不具合内容の要点

メールの件名程度の長さで発生した不具合の要件を書く。
1項目ごとにバグを管理しているので、わかりやすいタイトルが付いていると管理しやすい。

例1
【不具合報告】テンプレート編集画面の保存結果が反映されない
例2
未操作時に意図せずメニューがスクロールする

発生した事象

発生した事象について詳細を書く。
可能であれば、実際のスクリーンショットや操作時の動画があるとより伝わる。

例1
テンプレート編集画面で編集し保存した後に、本文編集画面を開いた場合に初期テンプレートが表示される
例2
情報参照機能からメニューに戻ってきたときに、未操作状態でメニューがスクロールする

再現手順

可能な範囲で事象が発生する手順を書く。
再現させられなかった場合も、そのときどんな操作をしていたのかを思い出せる範囲で書く。
報告先は不具合を調査する際、再現させてどこでどのように動いているから不具合になっているのか調査をする。

例1
1.編集画面から新規にテンプレートを追加する
2.追加したテンプレートをテンプレート編集画面から編集する
3.編集したテンプレートを保存する
4.本文編集画面に戻る
5.本文編集画面でテンプレート表示モードに変更する
例2
1.メニューから情報参照機能を選択する
2.参照する情報を選択する
3.参照情報を見る
4.参照画面からメニューに戻る

期待した結果

事象、再現結果に対して、こうあるべきがどうであったかを書く。
何が異なっているから不具合と判断したのかわかるようにする。

例1
編集画面にテンプレートの編集内容が反映されること
例2
メニューが停止状態で表示されること

使用環境

不具合が起こったときに操作していた環境を書く。
環境依存、OSバージョン依存の不具合もあるので、報告先で再現手順に沿っても再現できない場合の調査の手掛かりになる。

• 機器名

• OS名

• 操作していた段階でのソフトのバージョン番号

例1
機器：Inspiron 7415
OS：Windows 11 Home 22H2
バージョン：2.11.7
例2
機器：LAVIE T8
OS：Android11
バージョン：2.6.6

* 以前書いた関連記事

参考