システムを作成する上で、欠かせないのが基本設計書です。設計書と聞くと、システムを構成するために必要な手順や情報が記載されていると想像できるでしょう。システムを構築するであれば、さらに詳しく基本設計書について理解しておかなくてはいけません。
この記事では、基本設計書について詳しく解説していきます。設計書の作成方法や業務の効率化など、システム構築に関わっている人であれば聞いて損することがない情報ばかりです。
基本設計書とは？
そもそも、基本設計書とはどのようなものなのでしょうか。設計書と聞くとおおよそのイメージがある方も多いでしょう。しかし、基本設計書と詳細設計書の違いや、どのような目的で基本設計書を利用するのかわからないという方も多いです。
ここでは、設計仕様書の目的などについて詳しく解説をしていきます。
1.1基本設計書の目的
基本設計書とは、システム機能を具体化するために必要なもので、要件定義の内容を元に、どのような画面になるか、などを定めるものです。どのような要件の機能を備えるかを整理して、その用件をシステムに反映させることを基本設計と呼び、基本設計に必要なのが基本設計書なのです。
基本設計工程については、こちらの記事で詳しく解説しております。
https://products.sint.co.jp/ober/blog/basic-design-detailed-design
基本設計書は後述する詳細設計書と異なり、開発会社とクライアントが認識を合わせることを目的に作られるため、外部設計という言い方をすることもあります。ユーザであるクライアントが目にする部分を設計するので外部設計、内部のプログラマがプログラミングできるように詳細の仕様を決める詳細設計が内部設計というわけですね。
注意するべき点は、要件定義が不十分だと基本設計がうまくいかない場合があるということです。基本設計工程に入ったのはいいものの、要件定義が不十分なままその先の仕様を詰めてしまうことで、プロジェクトが進んだ後にトラブルにつながる可能性もありますので注意が必要です。
基本設計では、要件定義で定めた内容を具体的にしていく作業になるので、基本設計のプロセスを通して、要件定義の内容で双方に認識の齟齬がないかを確認することもできます。ですが、「基本設計で決めればいいや」「基本設計で確認すればいいや」だと非効率ですし、想定のスケジュールで上流工程が終わらないことにもつながりますので、要件定義は要件定義でしっかり行うことがやはり重要です。
1.2 詳細設計書との違い
詳細設計とは、基本設計の次段階に位置する工程です。基本設計は何を作るか（WHAT）を定めるのに対し、詳細設計ではどう作るか（HOW）を定めます。そのため、基本設計はクライアントも一緒になってこの仕様で問題ないかを確認しながら設計書を作成していきますが、詳細設計はSE（システムエンジニア）が自社のプログラマーに向けて、プログラミングができるように細かい設計を行う工程になるので、詳細設計書は納品しますが設計段階の内容をクライアントが確認することはあまりありません。
かんたんでシンプルなシステム開発の場合、詳細設計自体をしないという場合もありますが、ある程度以上の規模のシステムとなると機能が複雑になるので、詳細設計をしっかり行うことが実際のプログラミング工程を効率化するために重要となります。
基本設計書の内容
ここまでご説明したとおり、基本設計はクライアントが求める機能を定めるために欠かせない工程です。しかし、実際に基本設計書にはどのような内容を記載すればよいのでしょうか。
ここでは、基本設計書に含まれることの多い内容について、詳しく解説をしていきます。
2.1 業務フロー
システムを構築するにあたって、ユーザーがどのような手順（フロー）で業務を進めるのか、しっかりと把握しておく必要があります。
一連のフローを確認せずにシステムを構築してしまうと、業務全体で見たときに、思わぬ問題が発生してしまうこともあるでしょう。
そのため、ユーザーの業務フローの確認はしっかり行い、必要な機能を抽出、設計書に落とし込む必要があるのです。
2.2 機能一覧表
構築するシステムの機能を一覧化したものです。
ただ、初期段階ですべての機能をまとめることは難しいでしょう。要件定義書を確認しながら、徐々に内容を拡充し、育てていくのが機能一覧表です。
また、機能一覧表は、構築の進捗確認にも活用されることがあります。
2.3 ネットワーク構成図
ネットワーク構成図は、その名の通りどのようなネットワークを構成すれば、システムの構築を実現できるかをまとめた図です。
外部との接続ポイントや、ネットワーク機器・共有機器の接続、共有機器の接続に必要なアドレスなどの情報を記載します。
2.4 テーブル定義
データベースのテーブル定義をまとめたものです。
最低でも項目名、データ型、キー情報は定義、その他に長さや精度、定義内容も要素として追加してあげると分かりやすいでしょう。
また、テーブル定義書は、システムの引き継ぎ時に欠かせないものなので、しっかりと作成する必要があります。
2.5 ER図
ER図（Entity Relationship Diagram）とは、データ構造の代表的な設計図のことで、シンプルにシステムを表現できるという特徴があります。
作成したER図は、そのままデータ構造に変換することができるため、広く浸透しています。
2.6 画面レイアウト・帳票レイアウト
画面・帳票のレイアウトイメージをまとめたものです。
画面レイアウトと帳票レイアウトは、詳細設計の段階でも活用するので、プログラミングの記述様式も取り入れる必要があります。
基本設計書の作成内容については、こちらの記事でも詳しく解説しています。ぜひ、あわせてご一読ください。
基本設計書の作成ポイント
基本設計書にどんな内容を記載するべきかがわかっても、具体的にどのように作成してよいかがわからなければうまく進めることはできません。ここでは、基本設計書を作成するうえでのポイントについて詳しく解説していきます。
3.1 基本設計を行う目的を明確にする
まずはなぜ基本設計を行うのか、目的を明確にしましょう。基本設計書を作る目的は、要件定義で定めた欲しい機能を具体化し、定めることです。「要件定義で欲しい機能は伝えたから、後はよろしく」では、うまく行かないことをクライアントに認識してもらった上で、どこまでを基本設計で決めるかをしっかり伝えることが求められます。
また、開発に詳しいクライアントも中にはいるでしょうが、基本的にはそうでないクライアントがほとんどでしょう。ですので、基本設計の目的である「欲しい機能を具体化する」には、開発に詳しくないクライアントでもわかるように進めていく必要があります。誰にでもわかる言葉で表現するということを意識する必要があります。
3.2 業務を実際に担当している方に参画いただく
要件定義工程においても同じことが言えるのですが、基本設計に参加するメンバーが情報システム部門だけだと認識の齟齬をなくすことはできません。基本設計の目的である欲しい機能の具体化を行うには実際のユーザとなる業務の担当者にも参加して頂く必要があります。すべての打ち合わせで参加してもらう必要はありませんが、関連する業務に関連する機能を確認する場には参加してもらえるよう、クライアントにも協力を仰ぎましょう。
現場のユーザーが基本設計を確認することなく開発を進めてしまうと、「求めていたものと違う」「やり直して欲しい」など手戻りが発生することにつながります。
コストも増えますし、納期も伸びることになりますので、クライアントのためにもできるだけ現場の担当者にも参画してもらえるようにしましょう。
基本設計書の作成方法
基本設計書を実際に作成する方法は企業やSEによってさまざまです。インターネット上には公開されたサンプルもあるのですが、会社によって書き方は異なると考えたほうがよいでしょう。
ここから、基本設計書の作成方法についてご紹介していきますが、ここでご紹介するものはあくまでも一例です。いろいろなやり方がありますが、もっとも効率的に設計書を作成することができる自社にあった方法を見つけることが重要です。
4.1 ExcelやWordを活用する
世の中の基本設計書のほとんどが、ExcelやWordで作られています。基本設計書に限らず、何かしらの文章や書類を作成する際に、使われることが多いのがExcelとWordです。
ExcelとWordは非常に便利な機能が多く、ソフトの使い方もインターネットで調べればすぐにわかります。
しかし、ExcelとWordには問題点もあります。使い慣れているソフトを使って機能設計書を作成するのは非常におすすめなのですが、問題点があることも知っておきましょう。
記述ルールやフォーマットの統一が難しい
属人化という言葉があります。これは一つの仕事や物事が特定の人に依存してしまうことです。この属人化にExcelとWordの問題点があるのです。
WordやExcelは自由度が高いので、いくらフォーマットや運用ルールを定めても、そのルールから外れ、独自のやり方で進める人をなくすことが困難なのです。自己流でやりやすい方法で作るほうが早い、という気持ちはよく理解できます。
しかし、管理する側からすると作る人によって基本設計書の書き方やフォーマットが異なるというのは大きな問題です。
フォーマットが異なると、「きちんと関連する項目が反映されているか」「抜け漏れはないか」などのチェックがとても煩雑になります。結果として、品質がバラバラになってしまうというリスクがあります。ある人は手戻りの少ない、良い設計書なのに、別の人はそうではない、なんてことになってしまうと、効率良く開発することができません。
管理が難しい
先ほどご説明した内容に付随しますが、ExcelとWordで書かれた基本設計書は管理が難しいです。設計の途中で仕様変更が起こった場合、基本設計書も変更しなくてはいけません。
ExcelやWordであっても、Micorsoft365（office365）などを利用することでバージョン管理を行うことはできますが、時点の情報として残したい場合、やはりファイルをコピーして管理しないとならないため、デグレしてしまうなどのリスクはやはりあります。
また仕様変更があった際は、関連する複数の設計書を変更しなくてはならないので、どうしても二重三重の手間が発生してしまい、結果として確認する手間も二重三重になってしまいます。
4.2 基本設計書の作成・管理を合理化！「SI Object Browser Designer」
ExcelとWordで作成した基本設計書における問題点を解決できるのが、SI Object Browser Designerです。
SI Object Browser Designerは、設計情報をデータベースで一括管理できます。仕様が変更されたときも、その影響をひと目で確認することが可能です。これによって基本設計書の作成や変更が大幅に楽になります。
また、専用の設計フォームを使って基本設計書を作成することができるので、ExcelとWordのように属人化することがありません。これが大きな違いです。設計情報は連動するようになっているため、画面レイアウトの作成によってコントロール定義表も作成できたりします。うっかり修正を忘れてしまうことが起こらなくなるため、ヒューマンエラーも防止できるのです。
最後に変更履歴もデータベースで管理してくれます。これによっていつ、誰が、何を修正したのかをひと目で確認可能です。
このように、業務の効率化に大きく役立ってくれるのが、SI Object Browser Designerなのです。
まとめ
基本設計書を作成するうえで、不便に感じている点は多いでしょう。多くのエンジニアが不便な状況に耐えながら、基本設計書を作成しています。しかし、作業工数が余分にかかっているだけでなく、トラブルを産む原因にもなっています。
そのため、可能な限り基本設計書の作成業務は効率化しなくてはいけません。そのために、SI Object Browser Designerは非常に役立ってくれます。
今までの方法だけが正しいと考えずに、どんどん新しい方法をとり入れていきましょう。そうすることで、今までの業務がぐっと楽になり、大きなミスやトラブルも減っていきます。
