WRブログ

ドキュメントレビューのポイント vol.3 〜レビュアーの準備~

ドキュメントレビューのポイント vol.3 〜レビュアーの準備~

システム開発プロジェクトを遂行する中で作成される各種ドキュメントの品質を担保するために、レビューは欠かせません。正しいレビューを行うためにも、レビューの手順を理解しておきましょう。

別記事ドキュメントレビューのポイント vol.2 〜レビューの準備〜では、レビューは「4つのステップ」で実行されるということをご紹介しましたが、本記事では前述の別記事でご紹介した「1.レビューの準備」のうち、レビュアーが準備段階で実施するタスクを詳細に確認していきます。

多くのシステム開発プロジェクトの現場では、レビュアーは他業務をこなしながらレビューを担当しています。レビューを効率的に進めつつ、重大な問題を見落とさないようにするには、レビュアーも事前準備をしっかりと行い、レビューに備える必要があります。

レビュアーの準備タスク

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

レビュアーの準備タスク

1. シナリオの順序検討

シナリオが未作成の場合は、シナリオを作成します。すでにシナリオが作成されている場合は、自身にアサインされたシナリオの内容を参照し、シナリオの優先度や重要度を検討していきます。レビュー対象ドキュメントに「漏れ」「曖昧さ」「誤り」がないか、順にチェックをしていくわけですが、手当たり次第にレビューを行ってはいけません。レビューにおいて重大な問題を効率的に検出するために、シナリオの順序は重要なのです。

チェック順 チェック観点
1.「漏れ」 レビュアーがレビュー前に想定した「ドキュメントにかかれているべき内容」と実際のドキュメントとの差異をチェックする
2.「曖昧さ」 複数通りの解釈ができてしまう表現の有無や説明が不足している箇所がないかチェックする
3.「誤り」 a. ドキュメント内の不整合:レビュー対象ドキュメント内で異なる定義がなされている箇所がないかチェックする
b. ドキュメント外の不整合:レビュー対象ドキュメントと参照ドキュメントにかかれている内容に齟齬がないかチェックする
2. 情報整理

シナリオの内容から、レビュー対象のドキュメントに書いてあるべき内容がどんなものか、想定します。事前に想定ができていないと、誤字脱字や体裁(フォント、表組、等)のなどの些細な誤りに気を取られ、本来検出すべき重大な問題を見逃してしまう可能性があります。

また、レビューに必要なドキュメントを全て揃えておくことも重要です。レビュー対象ドキュメントを読み始めてから、関連する参照ドキュメントが手元にないことに気づくと、そのドキュメントを探すための工数が余分にかかってしまいますし、チェックする集中力が途切れてしまいます。スムーズにレビューを進めていくために、レビュー対象のドキュメントに関連して必要となる参照ドキュメント類をあらかじめ手元に揃えておく必要があります。

3. 検出方法の検討

次に、レビュー対象ドキュメントの内容の「漏れ」「曖昧さ」「誤り」を見逃さずに検出できるよう、ドキュメントのどの箇所をチェックしていくのか、具体的な方法を検討します。

チェック対象箇所を絞らずにレビューを行ってしまうと、ドキュメントの前半部分を集中してチェックしがちで、そのために後半のチェックが甘くなってしまうことがあります。

ドキュメント 漏れが発生しやすい箇所
要件定義書・運用設計書 ・業務フローの開始/終了条件
・非機能要件
・システムやサブシステムの境界部分
・運用要件
基本設計書・詳細設計書 ・例外処理、エラー処理
・データ定義(型、桁数、等)
・メモリ処理
・機能間連携、依存関係
4. 実施タイミングの検討

レビューの時間をまとめてとって実施するケースと、レビュアーが作業の合間に個別にレビューを進めて行くケースがあります。プロジェクトの進捗状況にもよりますが、レビュアーがレビューを後回しにしてしまいチェックが疎かにならないよう、レビューするシナリオごとにどのような進め方が適しているか、判断していく必要があります。

まとめ

レビューを効率的かつ着実に進めていくためには、準備段階におけるタスクを理解し、準備をしっかりとしておく必要があります。レビュー対象ドキュメントをチェックし、重大な問題を検出できるよう、レビュアーとしての準備もしっかりと進めたいですね。

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

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

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

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

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

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

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

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

Scroll Up