WRブログ

ドキュメントレビューのポイント vol.1 〜レビューの間違い〜

ドキュメントレビューのポイントvol.1

システム開発プロジェクトの現場では、多くのドキュメントが作成されます。要件定義書・基本設計書・詳細設計書などの設計に関連するドキュメント、テストの計画段階で作成されるドキュメントやテストケース・リリース手順書・操作マニュアルなど、種類も内容も多岐にわたります。
作成されたドキュメントは、プロジェクトメンバーによってレビューされ、内容が決定されます。

それでは、「良いドキュメントレビュー」とはどのようなものでしょうか。
本記事では、ドキュメントレビューが必要な意義を再確認したうえで、ドキュメントレビューの際に起こりがちな誤りを挙げて、解説していきます。

ドキュメントレビューの目的

ドキュメントレビューを実施する一番の目的は、「工数削減」です。ドキュメントレビュー自体に工数がかかるでしょ、という読者の方もいらっしゃるかと思いますが・・・。

まずは下記の図を見比べてみてください。

ドキュメントレビューの段階で設計ミスを発見できたことで、3人時分の工数を削減することができたわけです。

もちろん、ドキュメントレビューで指摘される問題のレベルによるので、前述の図のようになるとは限りません。エラーメッセージの誤字脱字のような問題であれば、修正自体も時間がかからず、影響範囲も限定的です。
しかし、結合テストや総合テストのように、下流工程で発見されるバグは、影響範囲が大きく、修正と修正後の確認に取られる工数が膨らんでしまいます。ドキュメントレビューは、影響範囲の大きな問題を実装前の段階で摘出し、修正工数を削減するために重要な作業なのです。

レビューで起きがちな「間違い」

ドキュメントレビューにおいてよくある「間違い」を3つ挙げてみます。

①思いつきで指摘する

誤字脱字や体裁は、レビュアーにとって「見つけやすい」問題であると言えます。パッと見て指摘することができるからでしょうが、先に述べた「ドキュメントレビューの目的」である、「下流工程で発見されると影響範囲が大きいバグを実装前に検出する」「修正工数を削減する」という観点で考えると、誤字脱字・体裁といった問題は「小さな問題」です。そうした問題を検出するために工数を割くのはもったいないと考えられます。
ドキュメントレビューでは、データの整合性や仕様の矛盾など、大きな問題を検出するべきです。

②ノルマ達成を目的にする

ドキュメントレビューにおける問題検出数を目標設定としているケースもあると思いますが、その目標を達するためにレビュアーが頭を捻っているというシーンを見たことがあるかもしれません。数字合わせが目的となってしまうと、これまた前述のドキュメントレビューの目的とはかけ離れてしまっています。

③ドキュメント作成者を攻撃する

ドキュメントのレビュアーが上位者(役職者やドキュメント作成者より年次・経験が上の要員)であることが多いのも一つの要因となるのかもしれませんが、ドキュメントの内容の指摘がエスカレートして、ドキュメント作成者自身への攻撃となってしまうことがあります。
「ミスが多い⇒やる気がない」など、ドキュメントの内容と直接関係のない方向に指摘が行ってしまいます。これも、当然、ドキュメントレビューの目的とは乖離してしまっています。

正しいドキュメントレビューは2ステップで構成される

ドキュメントレビューは「①問題検出」「②問題指摘」の2つのステップで構成されます。一般に、ドキュメントレビューは「問題を検出する」という意味で、「①問題検出」の印象が強いかと思いますが、「②問題指摘」は、「①問題検出」と同じくらい重要なものです。ここでは簡単に2つのステップについて解説します。

①問題検出

ドキュメント内容の問題を検出する

②問題指摘

検出した問題を他のレビュアーやドキュメント作成者に伝える

「②問題指摘」は、検出した問題を客観的に伝え、修正すべき内容であるかどうか判断するためのステップであり、レビュアーとドキュメント作成者間のコミュニケーションをいかに円滑にしていくのか、という観点で考えるべき項目、と言えます。コミュニケーションという観点で前述の「間違い」を振り返れば、「③ドキュメント作成者を攻撃する」については「起こるはずのない間違い」ということがご理解いただけると思います。

まとめ

ドキュメントレビューでは、問題を検出するだけでなく、検出した問題を的確に指摘することができて、初めて品質向上の第一歩となります。システム開発の現場で起こりがちなレビュー時に間違いを引き起こすことのないよう、留意してドキュメントレビューを実施してください。

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

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

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

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

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

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

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

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

Scroll Up