詳細設計書とは？SE＆PGそれぞれに必要な設計書！

「SE（システム・エンジニア）」は、システム開発において、顧客と開発者を結びつける重要な存在です。もちろん、SEだけではシステムは作れませんし、「PG（プログラマー）」だけでも作れません。両者の連携があってこそ、システム開発は成り立ちます。

その際に必要となるのが、今回説明する「詳細設計書」です。そこで今回は、詳細設計書に関連する、以下の事項を解説します。

詳細設計書とは? 誰がいつ作るの?

「詳細設計書」とは、「ウォーターフォール型開発」（Waterfall Model）において、基本設計を終えた後におこなう設計工程です。ウォーターフォールにおいては前から3番目におこなう工程であり、本工程から下流工程となります。

ウォーターフォールやその他の設計書に関しては、以下に示す記事をご参照ください。

Beエンジニア

ウォーターフォールとは？新人SE＆未経験でも分かり易く解説！

https://www.pmi-sfbac.org/waterfall-model

「ウォーターフォール」という言葉を聞いたことがあるでしょうか？今後、SEやプログラマーとして活躍したいと思う方には、避けて通ることは出来ない程、重要なアプローチモデルとなります。今回は、ウォーターフォールについて詳細に解説します。ウォーターフォール型開発とはなにか?ウォーターフォール型開発の詳細ウォーターフォール型開発の利点はなにか?ウォーターフォール型開発の欠点はなにか?ウォーターフォール型開発とは？ウォーターフォールとは滝のこと。滝のように段々と開発をすすめる様子から命名「ウォーターフォール型...

Beエンジニア

 

1 Pocket

要件定義書とは何？任されたら花形SE！詳細に理解しよう！

https://www.pmi-sfbac.org/requirement-definition-document

「要件定義書を作成するSEは、花形SEである」と言っても、過言では有りません。それだけに、「要件定義書は大切な存在である」と言えます。そこで今回は、要件定義書に関連する、以下の事項を解説します。「要件定義書」とは何か?「要件定義書」は誰がいつ作るのか?「要件定義書」はどんな内容を書くのか?要件定義書は誰がいつ作るの?要件定義書は、基本的にはSEが作成します。しかし、規模の大きい企業や部署においては、要件定義を専門に請け負う部門や担当者も存在します。この要件定義書は、ソフトウェア開発工程において、主に「...

Beエンジニア

基本設計書とは？ ポイントを抑えて分かりやすく解説！

https://www.pmi-sfbac.org/basic-design-documents

「SE（システム・エンジニア）」は、顧客目線が大切です。その上で、社内でシステムを実際に開発する「PG（プログラマー）」へ、開発する内容を伝えることも重要です。そのために作成するのが、今回解説する「基本設計書」です。そこで今回は、基本設計書に関連する、以下の事項を解説します。「基本設計書」とは何か?「基本設計書」は誰がいつ作るのか?「基本設計書」はどんな内容を書くのか?基本設計書とは?「基本設計書」は、顧客が求める機能を実現するために、そのシステムの概要を記述するものです。基本設計書には、顧客が使用...

また詳細設計書は「内部設計書」と呼ばれることもあります。

詳細設計書は、SEが主導し作成しますが、場合によっては開発を担当するPG（プログラマー）を迎えて作成することもあります。

詳細設計書にはどんな内容を書くの?

詳細設計書は、主に2つの役割があります。

なお、詳細設計書も要件定義書や基本設計書などと同様に、統一された書式や形式はありません。しかしながら、多くの場合、詳細設計書には以下の内容を記載します。

代表的な詳細設計書の成果物に絞ってピックアップします。

規約類 - ファイル仕様書、ネーミング規約、コーディング規約

詳細設計書は、実際にシステムを開発するため、様々な規約（ルール）が必要です。

• ファイル仕様書
  システムで使用するファイルやフォルダを定義するものです。ファイル名やアクセス権限、最大容量にバージョン管理なども決定します。サーバーサイド・プログラミングなどでは、「ビュー」（View、Web技術等を利用した画面を構築するファイル）や「テンプレート」（雛形）のファイル名も定義します。
  
  
• ネーミング規約
  システムを開発する際に、業務やある機能に名前を割り当てる際の法則を決定づけます。プログラムのファイル名や変数名であったり、「DB」（Database、データベース）のテーブル名やカラム名、制約名などに適用します。
  
  
• コーディング規約
  コーディング（ソースコードを書くこと）において使用する、体裁や方針のルールです。なお、最近では「フォーマッター」（自動書式ツール）を用いることが多く、どのフォーマッターを使うかや、その際の設定などを記載することも増えています。

データ - 処理機能（IPO）、SQL定義体

• 処理機能（IPO）
  各機能や画面などで入出力されるデータ（Input Process Output：IPO）を定義したものです。入力=Input、処理=Process、出力=Outputの頭文字をとってIPOと呼ばれます。
  IPOは機能の「Input（入力パラメータ）」⇒「Process（処理）」⇒「Output（出力パラメータ）」の流れを文章で記載して作成します。図だけでは、細かい部分が伝わり辛く、最終的には文章をもって処理の流れを表現していきます。

• SQL定義体
  「処理機能（IPO）」で定義された項目を取得/更新するためのSQLを定義します。場合によってはストアドプロシージャ（SQLの内容がサーバ側に格納されているもの）を呼び出すことが前提のこともあります。

OOP - クラス図、シーケンス図、アクティビティ図

最近では「オブジェクト指向プログラミング」（OOP）の普及により、OOPと親和性の高いUMLのドキュメントを作成することが増えています。

Beエンジニア

UMLとは何か？ メリット・デメリットを詳細に解説

https://www.pmi-sfbac.org/uml-merits-and-demerits

エンジニアとして今後活躍していこうと考えると、UMLから目を背けることはできません。今回は、UMLの基本的な事項である、以下の3点について解説します。UMLとは何かUMLのメリットは何かUMLのデメリットは何かUMLとは?UMLはエンジニアの間で全世界的に使用されている、作図法『UML』（Unified Modeling Language）とは、「統一モデリング言語」と訳されます。一般的には、そのままUMLと表記します。UMLは「エンジニアの設計用途で使われる、作図上の決まり事」であり、ルールのようなものです。主に「オブジェクト指向開発」（Object O...

• クラス図
  OOPの基本となるクラスの構成を図示したものです。必要となるクラスがわかるため、システム全体を見通すことが容易になりますし、スケジュール管理にも役立ちます。
  
  シーケンス図
  「シーケンス図」や「アクティビティ図」は。各エンティティ（人間や開発するクラスなど）がやり取りをする内容やその内部の処理を定義します。これによりどのクラスがどのエンティティと課関係があるか把握できますし、処理の内容が定義できます。