詳細設計書レビューの目的と3つのチェック項目

レビューする

前工程の仕様に基づき作成された詳細設計書をレビューする際、どのような点に注意してレビューすればいいでしょうか?ここでは、私が実際にレビュー作業を行う際に確認している点をご説明いたします。

 

レビューの目的

詳細設計書作成時、作成者の不注意や仕様認識不足により、前工程の仕様と異なる部分が発生します。詳細設計工程単独としてみると些細な間違いですが、システムからは不具合として表面化します。つまり、詳細設計書作成と同時に不具合も作りこんでいた形となります。

レビュー工程では、こうして作りこんでしまった不具合を見つけだし、問題のない状態で後工程へ引き渡すために実施します。

 

レビューにあたって

レビューするにあたって「仕様に問題がないか」であったり「誤字はないか」というのは一般的に思いつきますが、他にいくつかチェックしておくと後工程での戻りが発生しにくくなります。

 

渡される値の範囲は明確か、値の取り扱いは明確か。

たとえば男=1、女=2であった場合、3が来たらプログラムではどのように扱えばいいでしょうか?このように、プログラム内で使用する予定である値については明確になっているケースが多いですが、それ以外の値についての取り扱いが明記されていないケースがよくあります。

 

名称は統一されているか

区分値はカラムの名称は前工程で定義されたものと統一されているかを確認します。ここで漏れがあった場合、後工程でどの値を指して述べているのかわからなくなります。

 

等号、不等号が明確か

日本語で「○○が1以上である場合」や「○○が1より大きい場合」等と記載するケースもありますが、万が一認識がずれる場合を考慮して「○○≧1の場合」等と書いておいた方が後工程の間違いを防止できます。

 

レビューは結構大変

大抵のプロジェクトでは、少人数のレビュアーが多数の設計書をレビューするという状況が発生する形になりますので、レビューのガイドラインをあらかじめ伝えておき、設計書作成時から留意して作成してもらうとスムーズに進むと思います。

 

今日のまとめ

  • 設計書レビュー時の注意点を説明したよ!
  • これでレビュー戻りが少しでも減ればいいね!
  • 私も1日中レビューしてた時とかあったよ!!

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

日本語が含まれない投稿は無視されますのでご注意ください。(スパム対策)