WRブログ

ドキュメントレビューのポイント vol.4 〜ドキュメントレビューの実施〜

ドキュメントレビューのポイント vol.4 〜ドキュメントレビューの実施〜

システム開発を進めていく中で作成される各種ドキュメントは、レビューを重ねて品質を高めていきます。精度の高いドキュメントを整備できれば、開発されるシステム(プロダクト)の品質を上げることができます。

当ブログでは、これまで3回に渡り、ドキュメントレビューのポイントをご紹介してきました。

・vol.1 レビューの間違い
・vol.2 レビューの準備
・vol.3 レビュアーの準備(シナリオ作成)

今回は、レビューの実施手順を具体的にご紹介します。レビューの準備と同様に、レビュー実施にも正しい手順というものがあります。手順通りに進めていくことで、レビュー時の抜け・漏れやムラを防ぎ、レビューそのものの品質を向上することができるのです。

レビューの実施手順

下記の4つのタスクがあります。

レビューの実施手順

1.チェック

準備したシナリオを元に、レビュー対象のドキュメントを読み込みます。

レビュー中は、ついつい見つけやすい、誤字脱字や体裁のバラつきといった箇所が気になってしまうかもしれませんが、あくまでもシナリオに沿って検出すべき問題の有無をチェックしていきます。チェックが散漫になってしまう可能性が高いため、同時に複数のシナリオをチェックしてはいけません。

仮に、問題であるかどうか悩む箇所が出てきた場合は、当該箇所についてメモを残しておきます。悩んだ理由も記録しておくと、再度検討するときに役立ちます。再び問題であるか検討しても判断出来ない場合は、ドキュメント作成者に直接確認するか、レビュー会議等の場で質問として提起することで、他者の判断を仰ぎます。

2.問題検出

検出した問題の内容をメモに記録します。詳細に記録する必要も、その問題に関する調査をする必要もありません。記録や調査に手を掛けすぎてしまい、本来やるべき問題検出のチェックレベルがバラバラになってしまうことを防ぐためです。まずは問題を検出していくことのみに集中します。

ドキュメントを一通りチェックし終わったら、問題を検出したメモを確認しながら、それぞれの問題の詳細を記録に残していきます。さらに、類似の問題が同一ドキュメント内の別の箇所にないかも確認します。

3.振り返り

シナリオを1件チェックしたら、チェック方法を記録しておきます。レビュー会議には、記録したチェック方法を持ち寄って集約し、プロジェクトチームとしてドキュメントレビューをどのような方法で行ったのかを把握します。レビューそのものの品質を維持向上させるためには必要不可欠な活動です。

まれに、シナリオに沿ってチェックしたものの、問題を全く検出できなかった、というケースも出てきます。この場合は、対象ドキュメントの品質が良かっただけ、と安易に判断せず、レビュアーのスキルや知識がチェック対象のドキュメントやシナリオに合っているかを再確認します。もし、レビュアーが対象ドキュメントをチェックするために必要な知見を有していない場合は、別のシナリオをアサインし直します。

4.問題の記録

検出した問題を、問題記録票にまとめていきます。検出した問題の全てに対して問題記録票を作成する必要はありません。

たとえば、誤字脱字や体裁のバラつきなどの軽微な問題の場合は、問題記録票に詳細を記述するよりも、レビュー対象ドキュメントを印刷してマーカーや下線を引くなどの対応をした方が、ドキュメント作成者にもわかりやすく、レビュアーが問題記録票を作成する工数も削減できます。

逆に、ドキュメント作成者に対して問題の内容を詳細に説明する場合は、問題記録票に「問題種別」「問題を検出した箇所」「問題の内容」を記載し、レビュー会議で提出します。問題の内容には、本来記述されているべき内容・書き方と、レビュー対象ドキュメントに記述されている内容・書き方とで何が違うのか、詳細に説明を記述します。

まとめ

レビューを実施する際には、事前に準備されたシナリオに沿って正しい手順で進めて行く必要があります。また、レビューで検出した問題についても、やみくもに全てを記録するのではなく、検出された問題の重要度に応じて適切に問題記録票を作成していくことが重要です。こうした取り組みを通して、ドキュメントの品質を向上させ、システム(プロダクト)の品質担保につなげていきましょう。

【無料ダウンロード】ソフトウェア品質向上ガイドBOOK

第三者検証のスペシャリスト集団である株式会社ウェブレッジが、特に上流工程でのソフトウェア品質向上の手法に関してまとめた資料を無料でご提供しております。

ソフトウェア品質向上ガイドブック

ソフトウェア品質向上ガイドブック

ソフトウェア品質向上ガイドブック

■ドキュメントレビューに関するその他の解説記事

ドキュメントレビューのポイント vol.1 〜レビューの間違い〜
ドキュメントレビューのポイント vol.2 〜レビューの準備〜
ドキュメントレビューのポイント vol.3 〜レビュアーの準備〜
ドキュメントレビューのポイント vol.4 〜ドキュメントレビューの実施〜 【本記事】

【参考文献】
間違いだらけの設計レビュー [改訂版] 日経BP社

Scroll Up