基本設計書は、システム開発において重要な役割を果たす文書です。システムの全体像を記載する文書であり、実際にシステムを開発する際の指針になります。クライアントとの認識のすり合わせにも使用されるため、わかりやすく丁寧な作成が重要です。
一方「作成するのが難しい」「少しでも楽に作成したい」「どのように書けばいいかわからない」など、基本設計書の作成に課題を抱える方も多いのではないでしょうか。複雑な資料作成を効率的に進めるには、テンプレートの活用がおすすめです。
本記事では、基本設計書の重要性や構成要素、具体的な作成方法について詳しく説明します。また、無料でダウンロードできるテンプレートも提供しているので、ぜひご活用ください。
Web上で簡単に基本設計書の作成・管理を行えるツール「NotePM」
目次
基本設計書とは?
基本設計書は、システムの外部設計について記載する文書です。外部設計とは、画面デザインや操作方法など、ユーザーが直接見たり触れたりする部分の設計を指します。プロジェクトの初期段階で作成され、クライアントやエンドユーザーの要件をもとに、システム全体の概要や基本的な動作を示します。
基本設計書は、システム開発の道しるべとなるものであり、プロジェクトメンバーが共通の理解をもつための重要なドキュメントです。基本設計書にもとづいて、次の工程である詳細設計や開発が進められます。
基本設計書を通して初期の設計段階でクライアントの合意を得ることで、開発中のミスや手戻りが減るメリットがあります。そのため、基本設計書はシステム開発のプロセスにおいて重要な工程であり、慎重に作成を進めることが大切です。
基本設計書と詳細設計書の違い
システム開発で作成する設計書には、外部設計をまとめる基本設計書と内部設計をまとめる詳細設計書の2種類があります。詳細設計書に記載する内部設計とは、機能ごとの処理フローや処理項目など、ユーザーの目に見えない部分の設計のことです。
基本設計書でシステム開発の全体像をまとめ、そのあとに内部設計を決めて詳細設計書にまとめます。詳細設計書を作成する際は、基本設計書をもとにシステムの各部分を具体的に設計し、実装に必要な技術的な仕様を細かく記述します。
つまり、基本設計書がシステム全体の「設計図」だとすれば、詳細設計書は「施工図」ともいえるでしょう。エンジニアが詳細設計書を見ただけで開発を進められるよう、細かい部分まで落とし込むのが詳細設計書の特徴です。
設計書と仕様書の違い
設計書と仕様書は、それぞれ役割が異なります。設計書は、システムの構造や機能の実現方法についての詳細な設計を記述したものです。これに対して、仕様書はシステムが満たすべき要件や機能についての記述に焦点を当てています。
設計書は「どうやって作るか」を記述する文書であり、主にエンジニア向けに作成するものです。一方、仕様書は「何を作るか」を定義するもので、主にクライアントや関係者向けに作成します。両者は、システム開発の過程で密接に関連しています。
>関連記事:ドキュメント作成ツールおすすめ6選!選び方や作成のコツを解説
Web上で簡単に基本設計書の作成・管理を行えるツール「NotePM」
【無料配布】基本設計書のテンプレートと書き方
基本設計書には以下の項目を記載します。
- システム概要
- アーキテクチャ図
- 機能仕様
- ER図
- ビジネスロジック
- ユーザーインターフェース
- セキュリティ要件
- インフラストラクチャ
- 外部インターフェース
- テスト要件
- 変更管理
基本設計書は項目に沿って記載することで完成するため、書き方に迷ったら項目を埋めるイメージで作成を進めましょう。
基本設計書のテンプレート
ここで紹介するテンプレートは基本設計書の基本型です。テンプレートを基準にカスタマイズしてお使いください。
基本設計書 テンプレート1. 表紙
- システム名
- 文書タイトル (基本設計書)
- 作成日
- 作成者
- バージョン番号
2. 目次
- 各章のタイトルとページ番号
3. システム概要
- システムの目的: システムが解決する課題や目的を簡潔に説明。
- 対象範囲: システムがカバーする業務範囲や対象ユーザー。
- システムの特徴: 他システムとの違いや利点。
4. アーキテクチャ図
- システム全体の構造: ハードウェア、ネットワーク、ソフトウェア構成を含むシステムの全体像を図示。
- アーキテクチャの説明: 使用する技術スタック(サーバー、フレームワーク、DBMSなど)の簡単な解説。
5. 機能仕様
- 機能一覧: システムが提供する機能のリスト(機能名、概要、優先度)。
- 機能詳細: 各機能の入力・出力、動作フロー、関連する業務要件。
6. ER図
- データベース設計: システムで使用するデータベースのエンティティやリレーションを図示。
- テーブル定義: 各テーブルのカラム、データ型、制約事項。
7. ビジネスロジック
- 業務ルール: システム内で実行されるビジネスロジックや計算ロジックの詳細を記載。
- フロー図: 各ビジネスプロセスの流れを図示。
8. ユーザーインターフェース
- 画面一覧: システム内で提供されるユーザーインターフェース(UI)の概要。
- UI設計詳細: 画面ごとのレイアウト、機能、ユーザーフローの説明。モックアップやワイヤーフレームを含む。
9. セキュリティ要件
- 認証・認可設計: ユーザー認証、アクセス制御の方法(例:OAuth、JWT)。
- データ保護: データの暗号化、ログ管理、監査ログの保存方法など。
10. インフラストラクチャ
- ネットワーク構成図: システムのネットワーク構成を図示。
- サーバー・ストレージ: 使用するサーバーやストレージの種類と配置。
- 運用・監視: システムの監視方法、運用フロー。
11. 外部インターフェース
- 外部システムとの連携: 外部システムとのデータ交換やAPIの概要。
- インターフェース仕様: データ形式、通信プロトコル、エラーハンドリングなどの詳細。
12. テスト要件
- テスト項目一覧: 機能テスト、非機能テスト、結合テスト、ユーザーテストなどのテスト計画。
- テストの進行方法: テストのスケジュールや実施手順、合格基準。
13. 変更管理
- 変更履歴: 変更内容、実施日、担当者、バージョン番号を記録。
- 変更プロセス: 変更要望の提出方法、承認フロー、変更実施のプロセス。
基本設計書の作成例
具体的な作成例を見ることで、基本設計書の書き方がさらにイメージしやすくなります。ここでは、実際のプロジェクトを想定した作成例を用意しました。
作成例を参考にしながら、プロジェクトに応じて適切な項目を追加・調整してみてください。前述した基本設計書のテンプレートをもとに作成した例文は以下の通りです。
基本設計書 テンプレート(例文)1. 表紙
システム名: XYZ営業管理システム
文書タイトル: XYZ営業管理システム 基本設計書
作成日: 2024年9月26日
作成者: 田中太郎
バージョン番号: 1.0
2. 目次
- システム概要
- アーキテクチャ図
- 機能仕様
- ER図
- ビジネスロジック
- ユーザーインターフェース
- セキュリティ要件
- インフラストラクチャ
- 外部インターフェース
- テスト要件
- 変更管理
3. システム概要
システムの目的
XYZ営業管理システムは、営業部門の案件管理と進捗管理を効率化するために開発されます。営業担当者がリアルタイムで案件の状況を共有し、上司が進捗を簡単に確認できるようにすることが目的です。
対象範囲
本システムは、営業部門の全社員を対象とし、案件管理、顧客情報管理、契約書管理をサポートします。
4. アーキテクチャ図
アーキテクチャ概要
システムは3層アーキテクチャを採用します。クライアント側はウェブブラウザを使用し、アプリケーション層はJavaをベースに開発、データベースにはMySQLを使用します。
使用する技術
- フロントエンド:HTML, CSS, JavaScript
- バックエンド:Java, Spring Framework
- データベース:MySQL
5. 機能仕様
案件管理機能
営業担当者は、案件情報を新規登録、編集、削除できます。案件の進捗状況(例: 初期商談、提案中、成約済み)をリアルタイムで更新できます。
顧客管理機能
顧客情報(企業名、連絡先、担当者名)を一元管理し、検索・編集が可能です。
6. ER図
ER図の概要
本システムでは、以下のテーブルを使用してデータを管理します。主なエンティティは「案件」「顧客」「契約書」で、それぞれのリレーションは以下の通りです。
テーブル定義例
- 顧客テーブル:顧客ID(主キー)、企業名、住所、電話番号
- 案件テーブル:案件ID(主キー)、顧客ID(外部キー)、案件名、進捗状況
7. ビジネスロジック
営業プロセスの流れ
営業担当者は、顧客から問い合わせを受けたらシステムに案件を登録します。案件の進捗が進むごとにシステムでステータスを更新します。提案書が提出された場合、案件のステータスが「提案中」に変更され、成約時には「成約済み」に更新されます。
8. ユーザーインターフェース
案件管理画面
営業担当者は、案件一覧画面で全案件の進捗状況を確認できます。案件ごとの詳細ページでは、進捗の更新やコメントを入力できます。
UI設計詳細例
- 案件一覧ページには、案件名、担当者名、進捗状況が表示されます。
- 詳細ページには、「進捗更新」「コメント追加」ボタンが表示され、ユーザーが簡単に操作できるようになっています。
9. セキュリティ要件
認証設計
ユーザーは、個別に発行されたIDとパスワードでログインします。パスワードはSHA-256でハッシュ化してデータベースに保存します。
データ保護
システムはSSL証明書を使用して、すべての通信を暗号化します。顧客情報や案件データはバックアップを毎日実施します。
10. インフラストラクチャ
ネットワーク構成図
インターネット経由でアクセスするユーザーは、DMZに配置されたWebサーバーに接続します。バックエンドはプライベートネットワーク内で運用され、外部からのアクセスはファイアウォールで保護されます。
11. 外部インターフェース
API連携
本システムは、他社のCRMシステムとAPIを通じて連携し、顧客データをリアルタイムで共有します。RESTful APIを採用し、データ形式はJSONを使用します。
12. テスト要件
単体テスト
各機能の動作確認を行います。たとえば、案件管理機能では、案件を新規作成し、正しく保存・表示されることを確認します。
結合テスト
顧客情報と案件情報が連携して動作するかどうか、複数の機能を組み合わせたテストを実施します。
13. 変更管理
変更履歴の記録
- 2024/09/26 – 初版作成(田中太郎)
- 2024/10/01 – 案件管理機能に新しいフィルタ機能を追加(佐藤花子)
変更プロセス
新しい機能の要望があった場合、営業部門が要望をシステム管理者に提出し、開発チームが実施計画を作成します。要件が承認された後、開発とテストを経てシステムに反映されます。
【参考】各機関で配布されているサンプル・ガイドライン
基本設計書を作成する際に参考になる資料が各機関で公開されています。基本設計書のサンプルやガイドラインとして、以下の資料をご活用ください。
- 農林水産省『システム構成図』
- 国立研究開発法人『見守り情報管理システム 基本設計書』
- 国立研究開発法人『eコミマップ 基本設計書』
- IPA『機能要件の合意形成ガイド』
- デジタル庁『デジタル・ガバメント推進標準ガイドライン 実践ガイドブック』
これらの資料は、基本設計書作成のイメージを掴むのに有効です。とくに、基本設計書の具体的な書き方が記載されているIPA『機能要件の合意形成ガイド』は参考になります。
基本設計書を作成する際のポイント
基本設計書を作成する際は、以下のポイントを意識しましょう。
- 要件定義書を正確に反映する
- 誰が読んでも理解できる表現で書く
- 図表を活用して視覚的に伝える
ポイントを踏まえて作成することで、プロジェクト全体のスムーズな進行が期待できます。それぞれ詳しく見ていきましょう。
要件定義書を正確に反映する
基本設計書を作成する際は、要件定義書を正確に反映することを意識しましょう。要件定義書には、クライアントやステークホルダーがシステムに求める機能や性能が詳細に記載されています。
要件定義書の内容を正しく基本設計書に落とし込むことで、開発チームが具体的な設計や実装に移る際に、方向性のズレが発生するのを防げます。要件定義書との不一致があると、修正に時間を要する可能性があるため、設計段階で適切に反映させることが重要です。
>関連記事:要件定義の進め方とは?必要なプロセスと効率良く進めるポイントを解説
誰が読んでも理解できる表現で書く
基本設計書は、開発チームだけでなくプロジェクトに関わる多くのメンバーが参照する文書です。そのため、誰が読んでも理解できる表現を使うことが求められます。専門用語や技術的な記述が必要な場合も、可能な限り簡潔にまとめる意識をもちましょう。
適宜注釈や解説を加えることで、システム開発に詳しくない人でも内容を把握できるようになります。設計書の承認やレビューに関わる関係者が内容をスムーズに理解できれば、プロジェクト全体の進行が滞りなく進むでしょう。
具体的かつわかりやすい文章を書くことで誤解や認識のズレを減らせるので、基本設計書は誰でも理解できる文章の執筆を意識してください。
>関連記事:【例文付き】ビジネス文書のルールやテンプレートを紹介!社内文書・社外文書それぞれの書き方とは?
図表を活用して視覚的に伝える
基本設計書は複雑な情報を扱うことが多いため、図表を活用して視覚的に情報を伝えることが重要です。文章だけでは理解が難しい内容も、図解やフローチャートを用いることで、理解しやすくなります。基本設計書で使用する図の例は、以下の通りです。
基本設計書に視覚的な要素を取り入れることで、コミュニケーションミスを減らし、設計書のクオリティを高められるでしょう。例で列挙したように、基本設計書で使用する図は種類が多くあります。一つひとつの図をゼロベースで作成すると時間がかかるため、各種テンプレートを用意しておくことをおすすめします。
たとえば、ドキュメント作成・ナレッジ共有ツール『NotePM』なら図解もテンプレートで簡単に作成可能です。リンクを添付している図に関しては無料でダウンロードできるため、基本設計書作成の際にご活用ください。
Web上で簡単に基本設計書の作成・管理を行えるツール「NotePM」
基本設計の業務フロー
基本設計書は、システム開発の「基本設計」の段階で作成します。そのため、基本設計のプロセスを把握しておくと、基本設計書の作成工程をイメージするのに役立つでしょう。基本設計の業務フローは、主に以下の8ステップで進みます。
基本設計のステップ | 成果物 |
---|---|
1. 要件定義の確認 | ・要件定義書 ・リスク管理計画書 |
2. システム全体の構造設計 | ・システム構成図 ・業務フロー図 |
3. 機能設計 | ・機能仕様書(機能一覧) ・画面設計書 ・帳票設計書 |
4. データベース設計 | ・データベース設計書(ER図含む) |
5. インターフェース設計 | ・インターフェース設計書 ・バッチ設計図 |
6. 非機能要件設計 | ・非機能要件設計書 ・テスト計画書 |
7. レビューとフィードバック | ・プロトタイプ ・リスク管理計画書(更新版) |
8. 詳細設計への移行準備 | ・システム構成図(最終版) ・機能仕様書(最終版) ・データベース設計書(最終版) |
基本設計書は、ステップ2「システム全体の構造設計」以降の段階から作成を進めます。各ステップで作成される成果物は、次の詳細設計以降のプロセスで必要な資料です。
基本設計書の成果物一覧
成果物とは、基本設計書を作成した結果として得られる資料のことです。基本設計書における成果物は「基本設計書を作ったことにより、具体的に何が完成したのか」を意味します。基本設計書の成果物は、以下の通りです。
- システム構成図
- 要件定義書
- 機能仕様書(機能一覧)
- 非機能要件設計書
- データベース設計書(ER図含む)
- インターフェース設計書
- 画面設計書
- 帳票設計書
- 業務フロー図
- プロトタイプ
- リスク管理計画書
- テスト計画書
- バッチ設計図
「基本設計書を構成する要素」は基本設計書に何を書くかを示し、「成果物」はそれを書いた結果として何が完成するかを示すのです。基本設計書の成果物を知っておくことで、基本設計の段階で作成される資料が把握できるでしょう。
表からもわかるように、基本設計書の成果物はさまざまです。これらをすべてゼロベースで作成すると、時間も労力も要します。事前にテンプレートを用意しておくと、文書や図解作成の工程が楽になります。
たとえば、NotePMなら成果物のテンプレート作成・管理が可能です。テンプレートを活用し、基本設計のプロセスを効率的に進めてみてはいかがでしょうか。
Web上で簡単に基本設計書の作成・管理を行えるツール「NotePM」
簡単に基本設計書を作成するなら『NotePM』のテンプレートがおすすめ
基本設計の工程では、設計図や資料、成果物など、多岐にわたるドキュメントの作成が求められます。このような複雑な作業を効率的に進めるためには、すべての資料や素材を一括管理できるツールが不可欠です。『NotePM』なら、ドキュメントの作成・管理が簡単にできます。
NotePMを実際に導入している企業からは「フォルダ整理がしやすい」「柔軟にアクセス権限が設定できる」といった点で高く評価されています。NotePMを利用すれば、基本設計書作成の負担を軽減し、業務全体を効率的に進められるでしょう。
NotePMの特徴
- マニュアルを含むドキュメントの作成が簡単
- PDFやExcelの中身も全文検索できる強力な検索機能
- 社内FAQ・質問箱、社内ポータルとしても活用可能
- 銀行や大学も導入している高度なセキュリティが魅力
Web上で簡単に基本設計書の作成・管理を行えるツール「NotePM」
>関連記事:【導入事例】システム開発情報を一元管理。情報を残す企業文化に – 株式会社クラベス
基本設計書はテンプレートの活用で効率よく作れる
基本設計書の作成は、システム開発において重要な工程であるため、作成には時間と労力を要します。効率的に作成するためには、テンプレートの活用が有効です。基本設計書のテンプレートはもちろん、文書内で使用する図解や成果物のテンプレートも準備しておくとより効率的に文書作成が進められるでしょう。
複数のテンプレートを一括管理するなら、マニュアル作成・ナレッジ管理ツール「NotePM」の導入がおすすめです。NotePMにテンプレートを集約すれば、基本設計書の作成が簡単になります。
NotePMでは、30日間無料でお試しできる期間を設けています。基本設計書を含むドキュメント・テンプレートの作成・管理を効率化したい方は、選択肢のひとつとしてツールの導入を検討してみてください。
Web上で簡単に基本設計書の作成・管理を行えるツール「NotePM」