Search

検索したいワードを入力してください

詳細設計書の書き方の例とおすすめの本|システム/ソフトウェア

初回公開日:2017年12月16日

更新日:2020年03月09日

記載されている内容は2017年12月16日時点のものです。現在の情報と異なる可能性がありますので、ご了承ください。

また、記事に記載されている情報は自己責任でご活用いただき、本記事の内容に関する事項については、専門家等に相談するようにしてください。

システム構築における詳細設計書は、設計者と構築者をつなぐ、重要な役割を担っています。優秀な詳細設計書があれば、重大なバグが作り込まれることもありません。本記事では、詳細設計書に取り組む際に、参考になる書籍の紹介を含め、詳細設計書の書き方をご紹介します

data-max-num-ads=8 data-matched-content-rows-num="2" data-matched-content-columns-num="4" data-matched-content-ui-type="image_stacked" data-ad-format="autorelaxed">

詳細設計書の目的

システム構築をするなかで、最終構築直前の作業として、詳細設計書が作成されます。システムセットアップのための詳細設計書、データベース構築のための詳細設計書、プログラミングのための詳細設計書など、実際にシステム機器と向かい合って作業を始めるための、指示書ともいえるのが、詳細設計書です。

IT業界で決められた、詳細設計書の明確なフォーマットや、記述ルールはありません。多くは、ベンダや、プロジェクトによって、そのフォーマットと記述ルールを規定しています。次工程である構築作業に、不具合が生じないよう、設計の内容が作業者に伝わるように記述する設計書ですが、書き方の内容を統一して定義できていないのが、業界の実情です。

意識すること

詳細設計書の書き方で、もっとも意識すべきことは、次の工程である構築に、確実に指示を伝えるということです。書き方に配慮が足りず、指示漏れや、誤解を招く記述が含まれていると、次工程に情報が正しく伝わらず、不具合を生む結果となります。

指示が完璧に伝わる詳細設計書というのは、皆無に近いのが実情ですが、意識した書き方をするだけで、記述漏れや間違いを、次工程の担当者が気づけます。

詳細設計書担当者のひとりよがりな書き方で、「詳細」ではなく「概略」に近い書き方がされている詳細設計書も多く見受けられますが、こういった書き方だと、次工程の担当者も勝手な解釈をして、仕事を進めてしまうことになりかねません。

書くべきこと

詳細設計書の書き方として、意識すべきことは、「伝えなければならないこと」を網羅することです。「伝えなければならないこと」は、次工程で、誰が読んでも、設計の方向性について、間違った解釈をせずに済む、最低限の項目のことです。

読み手によって、解釈が異なりそうな内容がある場合は、間違った方向に進まないように、補足することまでが、「伝えなければならないこと」に含まれるということです。「伝えなければならないこと」は、内容だけでなく「正確さ」も含みます。

誤字脱字、修飾語がどの部分を修飾しているのかわからないような書き方は、読み手が誤解したり、勝手な解釈をするもとになります。詳細設計書は、技術者が記述するため、国語的な部分がおろそかになりがちですが、他人に意思を伝えるという意識を持てれば、きちんとした文章を書くことも、心がけられます。

詳細設計書の書き方の例

詳細設計書には、定型のフォーマットや書き方というものが決まっていないので、ここでご紹介できるのは、あくまでも「書くべき内容の例」になります。「書くべきこと」や「書き方」は、プロジェクトのなかで、必要に応じて、工夫して作り上げなければなりません。

また、ITの世界では、関わっている企業やプロジェクト、クライアントによって、各工程の呼び名が異なることがあります。ここで取り上げる詳細設計書は、上流工程(要件定義)から、下流工程(プログラミング)に、設計内容を伝える設計書という位置付けとして、ご紹介します。

システム構築

ベンダやプロジェクトによって、工程の呼び名は変わりますが、コンピューターのハードウェア作業からソフトウェア開発、実際にクライアント企業で、システムが動くまでの作業を意味する「システム構築」の際に、必要となる、詳細設計書の書き方(内容)例をご紹介します。

システム構築の中で、詳細設計書を作成する単位としては、「インフラ」「ネットワーク」「ソフトウェア」といった内容が考えられます。「ソフトウェア」の中には、すでにできあがっているアプリケーションの設定作業から、プログラミングが必要となるオリジナルソフトウェアの開発、データーベース構築までを、含みます。

インフラ設計

「インフラ」とは、インフラストラクチャー(英:infrastructure)の略語です。「社会インフラ」「交通インフラ」など耳にしたこともあるでしょう。インフラとは、基盤のことを意味し、システム構築における「インフラ」とは、アプリケーション以外のものを指します。

パソコンの場合は、Excel、ゲームといったものが「アプリケーション」であり、Windows10のようなオペレーティングシステム(OS)や、パソコンのハードディスクなどを、「インフラ」と呼びます。

インフラ関連の詳細設計書の書き方

インフラの詳細設計書に書くべきことは、OSやハードウェアの初期値などです。優秀な詳細設計書の書き方としては、素人であるクライアントが見ても「何がどう設定されているか」がわかるよう、記載されていることです。詳細設計書ではなく、「セットアップ手順書」「SG仕様書」などと呼ばれることもあります。

Windows10のセットアップに関する詳細設計書を、例にあげてみましょう。Windows10のセットアップ時に、対話形式で設定していく、全項目が「詳細設計書」に書き出されていれば、誰でもWindows10のセットアップができます。下流工程担当者の技術を問わず、「誰もができる」ように書かれている詳細設計書が、優秀な詳細設計書と言えます。

ネットワーク設計

ネットワークの設計では、詳細設計は「物理設計」と呼ばれることが多い工程のことを指します。「物理設計」を行う前に「論理設計」として、各機器のインターフェースの設計をし、論理構成図を書きます。

「物理設計」では、「論理設計」の内容を、実際のネットワーク関連機器を接続・設定できる内容にブレークダウンします。ブレークダウンした内容を記載するのが、詳細設計書です。「物理設計」では、論理設計で行なったインターフェース設計から、IPアドレス設計を行い、論理構成図から「物理構成図」を起こします。

ネットワークの詳細設計書には、各機器がネットワーク内に存在するための情報をすべて記載します。ネットワーク内での、機器の名称、割り当てるIPアドレスの番号は、基本的な内容として必ず必要になります。

ソフトウェア関連

システム構築として必要な、ソフトウェアの詳細設計書とは、プログラム開発とは別に、できあがっているプログラムをコンピューターで動作させるために必要な、設定を書きます。どのフォルダにプログラムを配置して、プログラムの設定ファイルに、どういった内容を記載すれば、プログムが想定通りに動作するのかについて、書く必要があります。

【例】
・プログラムAの配置場所:Dドライブ、AAフォルダに配置
・設定ファイル:冒頭に、配置したコンピューターのネットワーク内の名称を記載
・設定ファイルの配置場所:Dドライブ、AAフォルダに配置

上記のように、箇条書きや手順、表形式などを使って、設定内容を作業者が簡単に理解できるように、工夫して記載します。

VBなどのプログラミング

ソフトウェアのプログラミングにおける詳細設計書の場合は、設計者とプログラマの間で、詳細設計書の書き方について、取り決めを行います。詳細設計書は、いわば、日本語で書かれたプログラムといえるレベルの設計書です。日本語をプログラム言語に置き換えていけば、プログラミングができてしまうというレベルの詳細設計書が、もっとも理想的な書き方です。

しかし、一般的には、詳細設計書の段階では、割愛して書かれてしまう処理や、考慮されていない処理が多く、プログラミングでバグが入り込む原因とも言われています。プログラミングのための詳細設計書の書き方としては、データのINとOUT、処理の内容に誤解が入り込まないような言葉で綴ることを、強く意識すべきです。

データベースの詳細設計書の書き方

データベース設計では、「物理設計」と呼ばれることの多い工程が、詳細設計にあたる工程となります。「物理設計」では、データーベースのユーザ、スキーマー、テーブル、ビューなど、ひとつひとつの設計をすべて具体化し、プログラム内で使用される名称を定義し、記述します。

データーベースの項目が必要とするサイズについても、詳細設計書にはすべて明記する必要があります。詳細設計書に書かれている内容に沿って、コンピューターにデータベースを作り上げるので、データーベース構築に必要な、すべての項目とその内容を記載する必要があります。

SQLの詳細設計書

SQLは、データーベースからデータを引き出すための言語であり、一種のプログラミング言語と言えます。そのため、詳細設計書は、プログラミングの詳細設計書と同じように、「日本語で記述したプログラム」というレベルの書き方になります。日本語をSQL言語に置き換えれば、SQL文として成立するような書き方が、理想の書き方です。

詳細設計書の書き方がわかるおすすめの本

口コミ:
最近、ITの技術は変化が早く、それを追いかけるような本が多い。しかし、システム開発にはその様な部分だけでなく、もっと「不変な何か」があり、それが重要だろう。その「不変な何か」にたどり着くための重要なヒントがこの本にはある。ITシステムに携わる者なら必ず座右に置くべき一冊だ。
 最近はユーザ企業のエンジニアは業務をSI企業に丸投げが多いと聞く。その中で、サービス業を営む企業の社内システムエンジニアに、これだけのまとまった本を書ける人がいるというのにも、舌を巻いた。

出典: http://amzn.asia/hQaw9tp |

「システム設計のセオリー」では、詳細設計書だけではなく、要件定義から設計の流れを解説されています。著者が、ベンダ側の観点も、クライアント側の観点も、持ち合わせているので、システム側のひとりよがりにならない考え方を学べるでしょう。

次工程の指標となる詳細設計書を書きましょう

要件定義から始まったシステム構築の、上流工程から下流工程への橋渡しとなる大切な工程が、詳細設計です。下流工程に渡される「詳細設計書」は、設計者の観点だけではなく、下流工程担当者が必要としている情報を、確実に埋め込む必要があります。

詳細設計者は、プログラマーなどの下流工程担当者の目を持って、必要十分な情報を、詳細設計書に確実に記述できるよう、書く内容と書き方に工夫をこらす必要があります。上流工程でバグを作り込まないためにも、詳細設計書がキモとなることを心に留め、記述漏れのない詳細設計書を目指しましょう。

Latests