2020年3月10日

【コンサルタント散歩】

～詳細設計書の作成方法～

設計書は、どの開発プロジェクトに参画しても作成されていますし、記載されている内容を必ず確認します。設計書は、開発プロジェクトのフェーズによって記載されている内容は異なりますが、大きく分けると要件定義書、基本設計書、詳細設計書などがあります。今回は詳細設計書の作成方法を記載します。

皆さんは、詳細設計書を作成する際に、一番大切にしなければならないポイントは何になると考えますか。筆者は、前のフェーズで決めた内容を漏れなく記載することが一番のポイントだと考えています。もし、詳細設計書で基本設計時に決めた内容の記載漏れがあった場合、どのような状況になるのか想像できますか。

例えば、開発フェーズが終わり、テストフェーズの中で仕様に漏れがあると発覚した場合は、他の詳細設計書にも仕様漏れがないかの影響調査や、仕様漏れがあるプログラムの改修からテストまでの作業をすべてやり直す必要があります。また、外部連携用のファイル内容を作成する詳細設計書に仕様漏れがある場合は、外部連携先のシステムに連携してはいけない内容を送ってしまい、連携先のシステムに迷惑をかけることになります。仕様漏れをテストフェーズで発見できればよいのですが、本番稼働後に発覚した場合は、ニュースになるような大規模システムもあります。

では、詳細設計書を作成する際に、基本設計書で決めた内容の漏れをなくすにはどのようにすればよいのでしょうか。筆者が行っていた方法を記載します。詳細設計書に基本設計書の内容を貼り付けることにより、基本設計書の内容がすべて詳細設計書に記載されていることになります。この貼り付けられた基本設計書の内容を詳細に落としていきます。詳細設計書の作成後は、自己レビューとして基本設計書を印刷し、すべての内容が詳細設計に記載されているかを確認します。確認できたものを印刷した基本設計書で塗りつぶしていき、漏れがないようします。

詳細設計書の作成方法は人によっていろいろな方法がありますが、上記の方法を試すのは簡単なので、一度お試しください。やらないよりは、少なくとも仕様漏れを起こす確率は低くなります。

2020年3月