WRブログ

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

ソフトウェアの開発において、システムに対しておこなうテストは、単体テストからシステムテストまで、充実しています。
また、そのテスト技法もさまざまあります。しかし、仕様書や設計書へのテストはどのようにおこなわれているのでしょうか?
ここでは、ドキュメントレビューについて解説します。
■ドキュメントレビューとは
document

ソフトウェア開発でよく言われる「テスト」は、システムや、プログラムに対しておこなわれるものを想像しがちです。
しかし、ドキュメントレビューとは、仕様書や設計書などの文章に対するレビューです。
開発を進めるうえで、トラブルが起きそうなポイントなどを予測するのに有効で、事前に準備しておくことができます。
■仕様書のチェックリスト
仕様書ではどのようなことを確認すればいいのか、下記のチェックリストをもとに見てみましょう。

(1)システム名は誰が見ても分かりやすいものになっているか
例えば、仕様書に「登録システム仕様書」とあっても、いったい何のデータを扱うのかまったく分かりません。
この場合「ユーザー情報登録システム」など、何を登録するシステムなのか、ひと目で分かるようにしておきましょう。

(2)システムの概要は明確であるか
システムの内容が、実際の業務に落とし込むイメージが持てる内容になっているか確認します。

(3)画面の名称と仕様は明確か
画面の名称や、そこでのデータの入出力方法、扱うデータの形式、画面のレイアウト、各画面の操作方法などが明記されているかを確認します。

(4)ファイルの名称と仕様は明確か
ファイル名、各データ項目の名称が分かりやすくつけられているか。
また各データ項目の属性や長さや利用目的は明確か確認します。

(5)入力→処理→出力の流れが理解できるか
大規模なシステムになればなるほど、入力から出力までの流れは複雑になってきます。
この流れが分かりやすくかかれているほど、実装はスムーズに進みます。

(6)各画面とデータは関連付けされているか
どのデータが、どの画面でどのように入力され、処理され、出力されるのかが、きちんと明記されているか確認します。

(7)システムが要件を満たしているか
要件定義書などと合わせて見ながら、システムが必要とされている仕様に対し、過不足がないかを確認します。

(8)求められているリソースとスケジュールで実現可能か
要件定義書などと合わせて見ながら、システムが要求を満たしつつ、限られたリソースとスケジュールで実現可能かどうかを確認します。

(9)見積書との整合性があるか
見積書にある画面の種類や数、ファイルの種類や数は一致しているかどうかを確認します。

(10)略語や専門用語の解説は十分にされているか
略語、専門用語、コード表、エラーメッセージ表などが明確であるか確認します。
ここでの認識の違いが大きなトラブルを招く場合があります。

(11)制約条件や回復時間を明記しているか
実際の運用が始まってからの制約条件や、障害発生時の回復時間などを明記しているか確認します。

■設計書のチェックリスト
次に、設計書ではどのようなことを確認すればいいのか、下記のチェックリストをもとに見てみましょう。

(1)仕様書の要求が漏れなく設計に落とし込まれているか
仕様書の段階では、細かい機能まで落とし込まれていないことがあり、設計書がつくられる過程で漏れてしまう場合があります。
仕様書と設計書をよく見比べて、すべての仕様が機能に落とし込まれているか確認します。

(2)設計手法やフレームワークについて明記されているか
どの設計手法やフレームワークを使って、なぜそれを選んだのかが明記されているか確認します。

(3)アーキテクチャが論理的に説明できているか
そもそもきちんとした設計が組まれているか、本当にその設計でいいのかを確認します。

(4)設計上の制約事項が明記されているか
画面サイズの問題などで、文字数やデータの形式を制限しなければいけない場合、それがきちんと明記されているかどうかを確認します。

(5)各データの桁数、属性、識別キーなどが明記されているか
使用する各データの情報が詳しく明記されているかを確認します。

(6)障害対策やバックアップの機能が組まれているか
想定している障害に対して、きちんと対策がとられているか、また要求されている回復時間を守れているか確認します。

(7)エンドユーザー視点での設計がおこなわれているか
リリース後に使うユーザーが分かりやすいように設計されているか確認します。

★まとめ
●ドキュメントレビューは、仕様書や設計書などのドキュメントに対するテスト
●仕様書のチェックリストと注意点
●設計書のチェックリストと注意点

ここまで、ドキュメントレビューがどういったものか解説してきました。
実際にシステムを作る人たちが気持ち良く仕事をするためにも、ドキュメントレビューは重要な作業のひとつです。
またクライアントとの認識のズレも、大きなトラブルの原因になりかねないので、ドキュメントレビューを通して解消しておきましょう。


【参考文献】:
『ソフトウェアテスト教科書 JSTQB Foundation 第3版』

【参考URL】:
http://www.itmedia.co.jp/im/articles/0512/27/news090.html,(参照 2016年7月30日)

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

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

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

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

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

Scroll Up