読者です 読者をやめる 読者になる 読者になる

へっぽこエンジニアのもやもやブログ

役立ちサービスの紹介、システム開発Tips、本の紹介、雑記など

仕様書のレビューをする時に持つべき視点とコツをまとめた

どうも、リョウです。

 

システム開発の過程では、多くの仕様書を作成します。仕様書はたいていその会社独自のフォーマットがあるので、そのフォーマットにそって書けば、大抵それらしい仕様書ができます。

 

で、出来上がった仕様書に不備がないか確認するためにレビューをします。 

 

僕には仕様書をレビューする際に頭に入れている視点があります。

今回、多くのレビューをやるなかで自分なりにポイントをまとめたので公開します。

そのポイントとはこちら。 

 

  • 記載粒度

細かすぎないな、大雑把すぎないか?

その仕様書で記載すべきことか?

他の仕様書(上位・下位の仕様書)で記載すべきことではないか?

  • 誤字・脱字系

誤字脱字がないか?

各所の日付は合っているか?

ですますの統一は取れているか?

  • NGケース

入力値・出力値、上限値・下限値は明記されているか?

想定外の値が入力されたらどうなるのか?

  • 例外

例外発生時の動作はどうするか?

エラーダイアログをだすか。ログを出力するか。

  • 仕様の整合性

他の仕様書と整合性は取れているか?

過不足はないか?

お互いの仕様書で「あちらの担当です」状態にはなっていないか?

  • 実現性

技術的に可能か?

より良い方法はないか?

見積もりの範囲内でできそうか?

リスクはないか?

  • 注意制限事項

仕様書として、注記すべき点はないか?

制限はないか?

  

一番大事なのは、これら視点の2〜3個だけを頭にいれてレビューすること!!

 

というのも、これらの視点を全てを頭に入れてレビューをするのは経験として相当難しいです。全てを頭に入れてレビューすると、必ずモレが発生します。

これら視点の3個程度を頭に入れてのレビューが限界です。

 

ですので、何度も言うけど

 

2〜3個だけを頭にいれてレビューしてください!!

 

じゃあ、選択した2〜3個以外の視点でのレビューはどうすれば良いかというと、別の視点で再度レビューするんです。

ただ、実際これをやると時間的に大変なので、僕の場合は状況・立場に応じてレビューする視点を2〜3個に絞ってレビューをしています。

 

この方法を取り入れてからは、よい指摘ができるようになったと感じます。

 

どうぞ、お試しください‼

 

 

 

 

ドキュメント・レビュー!!要求仕様書・設計書のレビュー実践とチェックポイント

ドキュメント・レビュー!!要求仕様書・設計書のレビュー実践とチェックポイント