システム開発を行う際、設計はスムーズかつ正確な開発を実現するために必要不可欠なものとなっています。しかし、実際に詳細設計とは何なのか、詳細設計の成果物は何になるのかを明確に説明できる方はそう多くはないのではないでしょうか。 そこで本記事では、システム開発における詳細設計について、詳細設計書を作成するポイントや成果物まで徹底解説いたします。 詳細設計とは 詳細設計とは、基本設計の後に行うことが一般的なものであり、基本設計を元に、実際のプログラミングについて細かく策定することになります。仮に詳細設計を行わずに基本設計のみでシステム開発を進めてしまうとシステム開発の半ばになった時に搭載したい機能の実装ができなかったり、そもそも実装したい機能が曖昧であることからクライアントの要求定義を満たしているかわからなかったりと様々な弊害が出てくるため、システム開発には欠かせない工程の1つと言えるでしょう。 詳細設計と基本設計の違い よく混同してしまう詳細設計と基本設計ですが、大きな違いはクライアントに見せるか見せないかと言えます。基本設計はクライアントにもわかるように対外的な設計となりますが、詳細設計では開発者がわかるような専門的な設計となるため、この違いを意識して作成する必要があります。 詳細設計書を作成する際のポイント 詳細設計書を作成する際には、押さえておかなければならないポイントがいくつかあります。詳細設計書自体がプロジェクトの成功に関わると言っても過言ではないためです。詳細設計書を作成する際のポイントとしては、次の通りです。 目次及び見出しを作成する 難しい言葉及び造語は使用しない 1文はなるべく短くかつ主語は前に持ってくる 曖昧な表現はしない 見やすさを意識する 表記揺れがないか注意する 目次及び見出しを作成する 詳細設計書を作成する際には、目次と見出しをきちんと作成しましょう。本文と統一感を出しつつ、フォントのサイズを変更したり、見出しに階層をつけて複数管理する場合には、見出しと見出しの間に余白を付けることで管理したりすると見やすくなるのでおすすめです。 難しい言葉及び造語は使用しない あたり前のことですが、誰が読んだとしてもわかりやすく理解できるように、難しい言葉、あるいは造語は使用しないように心がけることも大切です。 1文はなるべく短くかつ主語は前に持ってくる 長文や回りくどい言い回しを多用してしまうと読み手にストレスを与えてしまうことになってしまうので、1文はなるべく簡潔かつ短くし、さらにわかりやすいように主語を前に持ってくるように意識します。 曖昧な表現はしない 曖昧な言い回しや表現も読み手に意図しない誤解を与えてしまう可能性があるため、明確にストレートに表現しましょう。 見やすさを意識する とにかく読み手のことを考え、誰が見ても見やすい、読みやすいと感じる詳細設計書を作成しましょう。文字だけでなく必要に応じて図及び表の活用をしたり、フォントを統一したり、インデントを調整したり、時には文字にカラーをつけたりとシンプルでありながらも読みやすい工夫を行うことが大切です。 表記揺れがないか注意する 例えば「Web」や「ウェブ」、「インターフェース」や「インターフェイス」など、1つの詳細設計書において1つの言葉を表記揺れしないようにしましょう。 詳細設計書の成果物 詳細設計書の成果物としては、様々なものがありますが、代表的なものとしては次のものが挙げられます。 パッケージ図 ユースケース図 コミュニケーション図 ステートマシン図 アクティビティ図 シーケンス図 画面一覧 画面遷移図 画面設計書 ER図 CRUD図 項目定義書 システム構成図 クラス図 コンポーネント図 オブジェクト図 モジュール構造図 アクティビティ図 フローチャート IPO（処理機能記述） パッケージ図 パッケージ図とは、UML（統一モデリング言語）で規定されたダイアグラムの1つであり、クラス図などの各モデル要素がどのように分類されているのか、パッケージ（グループ分け）されているのかを表現するものを指します。具体的にはタブ付きの長方形で1つのパッケージを表現することで、パッケージ名及びパッケージに所属する各モデル要素を記述します。さらに、パッケージ間の汎化及ぼい依存関係についてはパッケージ間を破線の矢印で結んで表現します。 ユースケース図 ユースケース図とは、システムがどのように機能するのかや外部環境を表す図です。エンドユーザー視点からシステムを見ることができるだけでなく、システム外部及び内部との境界をはっきりさせることもできます。具体的には、ユースケースというアクションのシーケンスを横長の楕円で表現し、アクターという線で描いた人型で表現し、さらにユースケースとアクターの関連は実線で表現します。 コミュニケーション図 コミュニケーション図は、オブジェクト間の関連により重きを置いた図であることから、相互作用ではなくシーケンス内のメッセージを通じてオブジェクトが関連付けられ接続する様を記述する図のことを指します。 ステートマシン図 … Continue reading 【詳細設計とは！？】詳細設計書を作成する際のポイントや成果物まで徹底解説