[ベストプラクティス]仕様書や設計書のレビュー観点
ソフトウェアの仕様書や設計書を念頭に置いたレビュー観点です。 抽象度高めでまとめたので、装置の仕様書や組織の設計書といった異分野のケースにもある程度応用できると思います。 仕様書も設計書も、下図の1~7番のうち必要な観点をピックアップしてレビューします。 仕様書と設計書のレビュー観点を1つの図にまとめた理由 仕様書と設計書の使い分けは会社、部署、プロジェクトにより様々です。 たとえば小規模なプロジェクトであれば仕様書と設計書を兼ねる1つのドキュメントにまとめることもあるでしょう。 また、社内向けなのか社外向けなのかによってもこの2つの使い分けは異なってきます。 上図は「ベストプラクティス」として様々なケースのレビュー観点集の第一候補として用いることができるようにしたいので、汎用性を高めるためにあえて仕様書と設計書を線引しないことにしました。 レビュー観点の見方 1~7番の観点をみて、記載漏れをチェックします。 また、仕様書も設計書も、図中の番号の順番に記載するとまずは概要を説明し徐々に詳細化していくという流れになるので読みやすいと思います。 ただし、6番(内部構成物)と7番(非機能)については必要に応じて適宜挿入するほうが良いケースもあると思います。 図中の単語は、「仕様記述対象もしくは設計対象」といちいち書くと長くなるので、「設計対象」で揃えました。 各項目の説明 1. 記述している設計対象を時間軸上で特定 「どの時点について記述しているのか」を明確化するために日付や設計対象のバージョンを記載します。 目的: そもそも記述対象を明確化するため 2. 文脈の中で設計対象が果たす役割、占める位置 文脈とはビジネス、関連技術、ロードマップなどのことです。 たとえば以下のような事柄を記載します。 設計対象がビジネスの中でどういう役割を負っているか 例: システム利用者からクレジットカード情報の入力を受け付けてカード会社に紹介して決済を完了させる 関連技術とどのような関係性なのか 例: カード決済の安全性について定義したISO-xxxxxではoooとxxxの要件を満たすように定められているが、本システムではoooのみに対応し、xxxには対応しない ロードマップのどこまでを達成す