0.Redmineのチケットの書き方
1.Redmineとは
Redmineはオ－プンソ－スの無料で使えるプロジェクトの管理を行うツ－ルである。
プロジェクト管理には本来多くの種類があるのだが、このページでは、バグやインシデントについての管理を行うインシデント管理、問題管理についてのみ取り上げる。
なお、インストールに関しては以下のリンクを参考にするとよい。
2.Redmineのチケットの書き方
Redmineのバグチケットは書く項目が多くあるが、書くポイントがあるものや分かりにくいものに焦点を絞って説明する。
2-1タイトル
一目で分かるように記載する。
例○○すると、△△が発生する。
※詳細については説明に記載するので記載しなくてよい。
2-2説明
説明に記載するべきものは以下の3つである
- ・エラー発生手順
- ・(発生手順で書ききれなかった)エラーの詳細
- ・エラーログの内容
一つづつ具体的に説明会していくと、以下のようになる。
2-2-1エラ－発生手順について
以下のような記述をすると、分かりやすいように思える。
(不具合発生手順)
- 1.手順1
- 2.手順2
- 3.手順3
手順を細かく書く理由としては複数人で仕事をしていると、全員が対象のプログラムを必ず把握しているとは限らないという点がある。
修正者はまず修正の前にバグの内容の確認も兼ねて不具合の再現を行う。
しかし、状況によっては不具合の再現ができなかったり、不具合の内容を理解できないということがありうる。
時間をかけて理解したり、テストした人に確認をとることで解決はするのだが、それなら最初から詳しく書いた方が親切ではある。
2-2-2エラーの詳細について
不具合について題名や発生手順で書ききれなかった詳細な内容があれば、詳細な内容を記載する。
例 ※○○の条件であれば正常に動作する。
2-2-3エラーログについて
エラーログはエラーの修正をするのに大きく役立つ
修正者側でログを探した場合、該当ログの識別に時間がかかるため、いつ不具合が出たか分かる試験者がログを探して貼り付ける方が効率がよい。
なお、私が張るときには以下のように記載している。
なお、エラーログは以下の通り
(エラーログを張る)
2-3ステ－タス
ステ－タスは一つのバグ、インシデントに関する進捗情報が書かれており、以下のようになっている。
- ・起票……作成されたばかりの状態で、修正者の割振りがされていない状態
- ・対応待ち……修正者の割振りはされたが、修正に未着手の状態
- ・対応中……修正者が修正している途中である状態
- ・修正確認……修正者の修正が完了し、再試験によって確認するべき状態
- ・解決……エラーやインシデントが解決された状態
2-4担当者と起票者
この2つは初めてRedmineを使用する場合には非常にややこしいが､以下の2つの違いがある。
○担当者
- 不具合に対して対処を行う人を記載
- 自分のやることリストを確認するために使用
○起票者
- バグやインシデントを最初に発見した人を記載
- 不具合の内容の質問をする人の目安として使用
3.Redmine検索方法
Redmineをプロジェクトで実際に使ってみると、でバグやインシデントは多く発生し、一目でどれが自分の担当分バグであるか、対応している既知の誤りは存在しているのかを探すのは困難である。
そのため、実際の運用では過去に発行したバグチケットは検索機能て探すことになる。
そこで、私が実際に時々使った3つの検索機能について以下にあげる。
3-1やることリストの検索
これは開発段階でバグ修正をする側として利用しているときによく使う検索機能であり、以下の手順で行うことができる。
1.フィルタと書かれているところの右下にドロップダウンメニューがあるのでそれを押す。
2.担当者を選択する
3.自分を選択して「適用」を押す
3-2既知の誤りの検索
既知の誤りとは、既に知られているバグのことをさす。
バグチケットを発行する際に重複していないことのチェックや、似たような誤りがあったら修正や回避策の参考とするために利用される。なお、検索方法は以下の通りである。
1.フィルタと書かれているところの右下にドロップダウンメニューがあるのでそれを押す。
2.機能名を選択する
3.自分を選択して「適用」を押す
3-3チケット番号(不具合番号)の検索
右上の検索のテキストボックスにチケット番号を入れて。Enterキ－を押す。
この検索は他の人にバグの内容に関する報告をしたり報告を受けたりする時に利用される。