新卒エンジニアのおれん(@ren0215tennis)です。
入社してから10ヶ月ほど経ち、もうすぐ1年が経とうとしています。
あっという間に過ぎていく毎日で、いつの間にか後輩が入ってくる。そんな時期になってしまいました。
この10ヶ月は色々な単語を覚えたり、なんとか業務をこなしていったり、時にはうつ状態になることもありました。
業務内容についてですが、最初の頃は開発チーム側で何もわからないなりにタスクをこなしていたのですが、
最近ではテストチームで仕事をすることが多くなってきました。
いわゆるテスターです。
そんな中でバグを見つけた時のバグチケットの書き方を指摘されることが多かったのでチケットの書き方の注意点について紹介していきます。
バグチケットとは
今回も結論から紹介していきましょう。
そもそもバグチケットとは何かという問いに答えていきます。
バグチケットはテスト実施の際に「こういったバグがありましたよ。」という事を報告するものです。
簡単にいうとバグの報告書みたいなものです。
その報告書をリーダーが管理したり、その報告書の情報を元に開発者がバグ対応をおこなったりします。
その為どういった動作でどういったバグが起こったのかわかりやすく記入しなければいけません。
ではなぜわかりやすく記入すべきなのか。。
それは効率化が理由です。
普通であればバグが起きたらこういうバグ起きましたよ。と口頭で伝えることもできます。
ですが、業務は忙しいのでそんな時間は使っていられません。
その為バグチケットを作成することで、開発者の良いタイミングで確認し、対応できるようになるという効率化が実現するのです。
ということでここから指摘を受けたことをまとめていこうと思います。
5W1Hも重要?
学生時代で学ぶ5W1HはIT業界でも重要になります。
こういう手順でエラーが起きましたという報告をした時、
先輩に、このバグチケットからは
・手順の文面がわかりにくく、何を伝えたいのかわからない
・どの機能がエラーを起こしているのか分からない
・エビデンスがないからどんなバグが起きたのかわからない(エビデンスとは)
・期待値が分からないからどうなって欲しいのかが分からない
上記の点を指摘を受けました。
開発者の中には開発ばかりで手順を完璧に理解できていない人や、外国の方、多忙で瞬時に理解できるバグチケットを求めている人など様々であることを教えていただきました。
そこで先輩に助言頂いたのは、
中学生でもわかるようなレベルで書けるようにしてほしい
こう言われました。
エンジニアという仕事は今はまだ下っ端かもしれないけど
将来非ITのお客様にシステムの説明をする機会も出てくるかも知れない。
そんな時の為にも、誰にでもわかるように書く力をつけようと教えていただきました。
もしバグチケットを書くときは上記の指摘部分を意識して書いてみるといいかも知れません。
簡潔な見出しと条件と期待値
では具体的に何を書けばいいんじゃ!
って声が聞こえてきそうなのであくまでも自分の先輩に教わったことを元にまとめていきます。
結論は条件と期待値これは必須です。と言われました。
ここからは例を出していきます
見出し名
お問合せフォームでデータを入力し送信ボタンを押すとエラーが起こります
できるだけ簡潔にどういうバグかわかるように書きます
条件
どういったシステムのどのアカウントで、どういった項目にこういう値を入力すること。
1.必須項目を入力する
2.規約を呼んでチェックを入れる
3.送信を押す
上記の手順で行うこと
こういった感じでできるだけ具体的に書いていきます。
期待値
送信ボタンを押してもエラーにならないこと
できる限り何がどうなってほしいと伝えます。
ログ
今までやった点が基本的なことになりますが、できればログのURLをつけてあげましょう。
なぜ必要かというと、効率化の為です。
ログのURLがないと開発者は手順を再度実施して再現してログを見る必要が出てしまいます。
二度手間にならないよう作成者がログのURLを貼ってあげると効率化につながり、開発者の時間を奪わずに済むのです。
まとめ
今回は「バグチケット」について紹介しました。
IT業界では様々な単語が飛び交っています。
今後もできる限り簡単に説明していきますのでぜひ参考にしてください。
ではまた次回お会いしましょう〜おれんでした!
プログラミング初学者におすすめの本
基本情報技術者の取得におすすめの本
基本情報技術者試験を取る人にはもちろん、取らない人もエンジニアとして働く上で大切な事が詰まった本です。
おすすめポイント
- イラストベースで初心者でもわかりやすく説明されている
- 暗記するのではなく仕組みや流れから理解できるので現場で活きる知識が身につく
私も実際に使って勉強しているこの本。評価も高くとてもわかりやすいのでIT未経験でも大丈夫!
データベースのおすすめ本
これからデータベースの勉強を始めるへ
エンジニアになる人、なりたい人はデータベースを学んで損はないです。
いつも何気なくみているWebサイト、アプリは私たちが見えている表の部分だけではないことが理解できる素晴らしい本です。
おすすめポイント
- ただ仕組みだけを書いているのではなく仕事内容も書いてあるから想像力を膨らませながら勉強できる
- 実例を交えた解説で頭に入ってきやすくわかりやすい
- 初心者向けで初歩的な用語から説明があるため、躓きにくい
自分自身も購入し助けられたからこそおすすめできる本です
テスト工程の理解におすすめ本
これからテストチームでの業務に関わる人・勉強を始める方へ
エンジニアになりたての頃はテスト工程を任されることが多いので、テスト工程についての知識を入れておくだけでかなり差がつくと思います。
過去の自分にもおすすめしたい本です!
おすすめポイント
- 基礎からしっかり、体系的に学習できる
- 品質を決定づけるテスト工程の全体像と実施方法がよくわかる
- 初学者を対象としているため丁寧な解説、平易な文章でわかりやすい