エンジニアの方で基本設計・詳細設計とは何かわからない方いらっしゃるのではないでしょうか。
本記事では、基本設計・詳細設計について違いや作成の進め方について解説しています。
基本設計・詳細設計について詳しく知りたい方や初心者エンジニアの方はぜひ、参考にしてみてください。
目次
基本設計とは?詳細設計とは?
まず初めに、基本設計・詳細設計とは何か解説していきます。
基本設計・詳細設計について詳しく知りたい方はぜひ、参考にしてみてください。
基本設計とは?
基本設計とは、ソフトウェア開発における工程の1つで要件定義と詳細設計の間の工程になります。
要件定義で抽出した要件を機能で分けて、それぞれの機能でどういうことを実現したいかを決める工程になっています。
基本設計は、必ずしも作成する必要はなく、プロジェクトによっては作成しないで詳細設計のドキュメントとわかれていないこともあります。
基本設計は外部設計と呼ばれることもあります。
詳細設計とは?
詳細設計とは、ソフトウェア開発における工程の1つで基本設計の次の工程になります。
基本設計で実現したいと決めた機能に対して、どのような設定を行うのかパラメータなどを決める工程になっています。
詳細設計で決めた設定値を元に構築を行うため、かなり重要な工程になっており、エンジニアとしても技術・知識が必要になっています。
詳細設計は内部設計と呼ばれることもあります。
基本設計作成の進め方
基本設計を作成する際にどのように作成するのか解説します。
基本設計を作成する機会がある方はぜひ、参考にしてみてください。
①要件定義の内容を確認
基本設計を作成する前にまず、要件定義の内容を確認する必要があります。
要件定義をもとに基本設計を作成するため、要件定義の確認は重要になります。
②基本設計の設計を行う
要件定義を確認したうえで基本設計をどのように組み立てるのかを簡単に設計を行います。
具体的には、以下のような内容はこの段階で確認しておきたいです。
実装を考えている機能
画面のレイアウトの決定
設計に必要になるデータの整理
③基本設計書の作成
②で設計が決まったら基本設計書の作成を行います。
基本設計書は作成が完了したら最終的にこの設計で進めることをクライアントと合意する必要があります。
そのため、開発者以外の方でも理解しやすいように作成することが重要になります。
基本設計書とは、具体的にどんなものがあるかプロジェクトによって異なりますが、基本的に以下のようなものを基本設計としているプロジェクトが多いです。
基本設計書 | 説明 |
機能一覧 | システムで使用する機能をまとめたもの |
業務フロー | システムを使用する際にどのような流れで処理が実行されるか明確にする図 |
システム構成図 | システムの構成要素の関係性がわかるような図 |
画面設計図 | システムを利用するとどのような画面が表示されるか設計したもの |
バッチ設計図 | システムで使用するバッチの一覧・バッチ処理がどのように行われるか示したもの バッチとは、一連の処理を自動化することができる処理方式 |
外部インターフェース設計図 | 使用するシステムと外部システムをつなぐ方法などを定義したもの |
④レビュー
基本設計書作成完了後に、内部でのレビューとクライアントとのレビューを行います。
設計者の観点だけでなく、様々な方の観点を取り入れることで品質の向上を目指します。
基本設計の注意点
上記で基本設計の作成方法を説明しましたが、作成する際に注意が必要になることを解説していきます。
システムの全体像を意識する
基本設計を作成する際には、1つの機能にとらわれることなくシステムの全体像を意識しながら作成することが大事になります。
1つの機能などにとらわれた視点をしてしまうと、他の機能との連携がうまくいかないこともあるため、いろいろな角度からの視点が重要になります。
要件定義の内容と合っているか
基本設計は要件定義で決めた内容を元に作成されるため、要件定義で決めていないことは基本設計で定義することはクライアントのニーズからずれてします危険があります。
そのため、基本設計を作成する際には要件定義を元に作成しましょう。
設計内容は実現できるか
基本設計で決めた設計は、基本設計後に詳細設計・構築などの作業につながります。
そのため、構築の際に基本設計で決めた内容で実現できないとなると、再度クライアントと設計を合意し直し、詳細設計を行う必要が出てきます。
また、最悪な場合基本設計全体の修正が必要になる可能性もあります。
後続の内容を意識して基本設計を作成することが重要になります。
詳細設計作成の進め方
詳細設計を作成する際にどのように作成するのか解説します。
詳細設計を作成する機会がある方はぜひ、参考にしてみてください。
①基本設計書の確認
詳細設計は、基本設計で決めたシステムの全体像に対して設定値を決めて行きます。
そのため、基本設計で決めた内容をしっかりと理解しておくことが重要になります。
②設計を行う
詳細設計書に記載された各機能の設計を行います。
具体的には、以下のような内容はこの段階で確認しておきたいです。
機能の整理
使用する機能の割り振り
共通にできる箇所の設計
③詳細設計書の作成
②で設計が決まったら詳細設計書の作成を行います。
詳細設計書は作成が完了したら最終的にこの設計で進めることをクライアントと合意する必要があります。
そのため、開発者以外の方でも理解しやすいように作成することが重要になります。
詳細設計書とは、具体的にどんなものがあるかプロジェクトによって異なりますが、基本的に以下のようなものを詳細設計としているプロジェクトが多いです。
詳細設計書 | 説明 |
クラス図 | システム同士の関係や構造を表したもの |
アクティビティ図 | ユーザの操作やシステム処理の流れを表したもの |
シーケンス図 | アクティビティ図よりさらにシステムの処理を細かく記載したもの |
モジュール構成図 | 各機能に必要な処理をモジュールごとに示し、またモジュール同士の関係を表したもの |
④レビュー
詳細設計書作成完了後に、内部でのレビューとクライアントとのレビューを行います。
設計者の観点だけでなく、様々な方の観点を取り入れることで品質の向上を目指します。
詳細設計作成の注意点
上記で詳細設計の作成方法を説明しましたが、作成する際に注意が必要になることを解説していきます。
わかりづらい表現はやめる
詳細設計の後は、構築に入るため構築する際に迷わないようにわかりづらい表現はやめましょう。
わかりづらい表現をすることで構築ミスにつながる恐れがあります。
説明文をシンプルにする
説明文が長いと読み手が理解するのに時間がかかるため、作業工数も高くなります。
そのため、説明文をシンプルにすることで作業工数や読み手に伝わりやすくなるため、重要になります。
まとめ
いかがでしたか。
本記事では、基本設計と詳細設計とは何かや違いについて解説しました。
基本設計と詳細設計について詳しく知りたい方や初心者エンジニアの方はぜひ、参考にしてみてください。
・基本設計とは?詳細設計とは?
・基本設計・詳細設計作成の進め方
・基本設計・詳細設計の注意点