本稿ではエビデンス(証跡)について、2分で読めるボリュームに要約して紹介する。
1.エビデンスとは
エビデンス(evidence)とは証拠、根拠、証明という意味で、IT業界ではプログラムやシステムの試験の結果や、動作検証を確認したことを証拠として残すために作成する。または、システムトラブルやシステムバグが発生した際にも、システムの状況を事実として記録するために作成する。
エビデンスは、システム試験の成果物として顧客から成果物として提示されることも多く、エビデンスの作成はSEにとって必須のスキルといえる。
2.エビデンスの作成方法
エビデンスは、システムのある時点の状態や、処理結果の証拠である。証拠として十分な情報を取得するためには以下のような手法がある。
システムログを取得する
最も一般的な方法である。プログラムの出力するログだけでなく、コンソールの操作ログや標準出力の内容もログとして取得しよう。
画面キャプチャを取得する
画面の試験ではログを取得するよりも実際に表示された画面のキャプチャを取得することが有効だ。対象ウインドウだけでなく、画面全体のコピーをとっておくと後で確認がしやすい。
DBのダンプを取得する
システムの処理により、DBに変更が入った場合には処理前後のDB内容のダンプを取得しておくことでエビデンスとできる。
3.エビデンス作成のポイント
事実の保全
エビデンス作成では、事実をできる限りありのままに記録することが肝要だ。ログなどに手を加えることはしてはならないし、画面キャプチャであっても、編集する場合は個人の判断で情報を削り落としてしまったりしないよう、注意が必要だ。
他者にもわかりやすい表現
事実の保全と並んで大切なことが、表現方法だ。
システムが正常に稼動していることを示すエビデンスとしてのログであれば、どの部分を確認することで正常と判断できるのか、という情報を付与してあげることで他者が見てもチェックしやすくなり、品質の向上につながる。例えば、メモで「X行目にエラーが出力されている」と追記するなどである。
システムトラブルが発生した際の画面キャプチャであれば、どの部分が想定と異なるのかを噴出しで付与してあげるなど工夫を行うことで問題を共有しやすくなる。
4.まとめ
- エビデンスとは、システムの試験やバグの結果の証拠である。
- エビデンスを取得する際には事実をありのままに取得する。
- 表現方法を工夫し、エビデンスを他者が利用しやすくする。
コメントを残す