こんにちは。マニュアル作成・ナレッジ共有ツール「NotePM」ブログ編集局です。
バグ報告書のテンプレートと例文をご紹介します。
マニュアル作成・ナレッジ共有ツール「NotePM」を無料でお試し！
バグ報告書とは？
バグ報告書とは、テスターが発見した不具合について開発チームに報告するのに利用するドキュメントです。単に「動かない」といった報告だけでは開発チームに伝わらない不具合内容も、フォーマットに沿って記述することで理解されやすくなります。
不具合報告はともすると感情的になりやすく、受け取る側もストレスです。バグ報告書を用いた規定フォーマットの中でシステム的に記述することで、相互にとってストレスが低いやりとりが可能になるでしょう。
バグ報告書の目的
バグ報告書は不具合の発生内容を開発チームに正しく理解してもらうことにあります。また、その不具合の起きた要因や再現法を明記することで、重要度が変わります。内容によって緊急対応になるケースもあるでしょう。
開発者でない人たちにとって、どのように伝えれば開発チームに理解してもらえるか分かりづらいかも知れません。バグ報告書のようなフォーマットを用意することで、起こった不具合を適切に報告できるようになるでしょう。
バグ報告書の書き方
バグ報告書で大事なのは、何が起きたのか、何を期待したのか、どうやって発生したのかを記述することです。仕様通りの動作の場合、期待した動作ではないから不具合とはならないことがあります。また、再現する方法が分からないと開発チームの負担が大きくなるため、優先度が下がってしまうでしょう。
タイトル
不具合の内容を端的に説明するためのタイトルです。
発生した事象
発生した事象を分かりやすく、端的に記述します。ただし、「動きません」だけではよくありません。エラーであれば、どういったメッセージが出たのかを書いたり、動かないとしたら何をして動かないと判断したのかも書きましょう。
期待した結果
システムが適切に動いたとして、その結果何を期待したのかを記述します。完了画面の表示であったり、顧客データへの新規追加や更新、注文完了メールの送信など起きて欲しかった結果を明記します。
この期待した結果と、システム仕様とがミスマッチになっているケースは多々あります。この場合は不具合ではなく、要件漏れや仕様、または誤解を生むようなUIの問題かも知れません。
発生日時
事象の発生した日時を記載します。これはシステムログであったり、新バージョンのデプロイ中だったといった原因追及に役立つ可能性があります。
再現方法
不具合の再現方法は大事です。報告者自身が同じ操作を行ってみて、不具合が再発するのを確認しましょう。再現する場合には不具合かも知れませんが、一時的な問題（ネットワークなど）の可能性もあります。
実行環境
Webブラウザ、ソフトウェアのバージョン、OSなどを記述します。Webブラウザの場合、機能拡張によって起こる不具合の可能性もあります。アドブロックなど思い当たる節がある場合には、それも記述しておく方が良いでしょう。
補足資料
不具合の再現や検証に役立つ資料です。特にスクリーンショットは必須です。
スクリーンショット
不具合が発生している画面のスクリーンショットがあると、不具合の解析でとても役立つ資料になるでしょう。不具合の箇所を丸く囲んだり、分かりやすくしているとより親切です。
ログ
Webブラウザのコンソールに出ているエラーメッセージや、HARファイルを添付していると解析に役立ちます。テキストの報告だけでは伝わらない内容がログメッセージには数多く含まれていますので、原因究明が早まることでしょう。
マニュアル作成・ナレッジ共有ツール「NotePM」を無料でお試し！
バグ報告書のサンプル例
##タイトル
販売管理システムにおける売り上げ確定処理が失敗します。
##発生した事象
販売管理システムにて売り上げ確定処理を行った際、特定の顧客のみ失敗します。
- 顧客番号： 1001
- 注文番号： 31001や32001
表示されるエラーメッセージ
- 担当者が見つかりません。担当者を作成後に再実行してください。
なお、顧客番号 1001に担当者は存在します。
##期待した結果
売り上げ確定処理の完了。
##発生日時
2022/02/11 15:04頃
##再現方法
- 販売管理の検索機能で顧客番号 1001 を検索
- 検索結果の注文をすべて選択
- 売り上げ確定ボタンを押す
##実行環境
- Webブラウザ: Google Chrome 98
- OS: Windows 11
##補足資料
###スクリーンショット
スクリーンショットを添付します。
###ログ
開発者ツールのコンソールにて出ていたメッセージを添付します。
xxxxx
NotePM（ノートピーエム） は、Webで簡単にマニュアル作成できて、強力な検索機能でほしい情報をすぐに見つけられるサービスです。さまざまな業界業種に導入されている人気サービスで、大手IT製品レビューサイトでは、とくに『使いやすいさ・導入しやすさ』を高く評価されています。
NotePMの特徴
- マニュアル作成、バージョン管理、社外メンバー共有
- 強力な検索機能。PDFやExcelの中身も全文検索
- 社内FAQ・質問箱・社内ポータルとしても活用できる
- 銀行、大学も導入している高度なセキュリティ。安全に情報共有できる
URL: https://notepm.jp/
