基本設計書のテンプレートを無料配布｜構成要素や書き方、サンプルを紹介

 
システム開発プロジェクトで「新しくアサインされたメンバーが設計書の書き方を毎回ゼロから覚えている」「担当者によってフォーマットや記述の粒度がバラバラで、レビューのたびに指摘が発生する」「前の担当者が作った設計書を引き継いだが、どれが最新版かわからない」
こうした問題を抱えているチームは少なくありません。

これらはすべて、基本設計書が「個人の経験と判断で毎回作られる文書」になっており、チームの作業標準として整備・運用されていないことが原因です。

基本設計書をテンプレート化し、誰が担当しても同じ構成・同じ品質で作れる手順として整備することで、新メンバーのオンボーディング期間を短縮し、設計工程全体の品質を均一化できます。

本記事では、基本設計書の構成要素・書き方を解説するとともに、すぐに使えるテンプレートを無料で提供します。テンプレートを「一度きりの雛形」ではなくチームで育てる作業標準として活用するポイントも合わせてご確認ください。

 

基本設計書テンプレートが属人化すると何が起きるか

基本設計書のテンプレートが標準化されていない開発現場では、次のような問題が繰り返し起きます。

• 担当者Aが作る設計書には詳細なER図と画面遷移図が含まれているが、担当者Bの設計書には含まれておらず、レビュアーが毎回「ER図を追加してください」と指摘する羽目になる
• 新人エンジニアが「どこまで書けばよいか」「この項目はどう記述するのか」と先輩に都度確認しながら進めるため、先輩の工数がプロジェクトごとに一定量消費され続ける
• 設計書のバージョン管理がファイル名頼みになり、「基本設計書最終版修正済み_v3」のようなファイルが複数存在し、どれが最新版かわからなくなる
• プロジェクトをまたいだ設計書の流用や参照ができず、過去の成果物が次のプロジェクトに活かされないまま埋もれていく

これらの問題の根本は、「基本設計書が個人の経験と判断で毎回ゼロから作られており、チームの作業標準として整備されていない」ことにあります。テンプレートを整備し、構成・記述粒度・バージョン管理のルールを標準化することで、担当者が変わっても同品質の設計書が作れる状態を目指すことが、設計工程の属人化を解消する第一歩です。

 

基本設計書とは？（開発チームの「作業標準書」として機能する文書）

基本設計書は、システムの外部設計について記載する文書です。外部設計とは、画面デザインや操作方法など、ユーザーが直接見たり触れたりする部分の設計を指します。プロジェクトの初期段階で作成され、クライアントやエンドユーザーの要件をもとに、システム全体の概要や基本的な動作を示します。

基本設計書は、システム開発の道しるべとなるものであり、プロジェクトメンバーが共通の理解をもつための重要なドキュメントです。基本設計書にもとづいて、次の工程である詳細設計や開発が進められます。

基本設計書を通して初期の設計段階でクライアントの合意を得ることで、開発中のミスや手戻りが減るメリットがあります。そのため、基本設計書はシステム開発のプロセスにおいて重要な工程であり、慎重に作成を進めることが大切です。

さらに、基本設計書はチームの「作業標準書」として位置づけて整備することが重要です。エンジニアが代わっても同品質の設計書が作れる状態を目指して構成・記述粒度・バージョン管理のルールを文書化しておくことで、新メンバーが加わった際のオンボーディングコストを削減し、設計工程全体の品質を均一化する第一歩になります。

基本設計書と詳細設計書の違い（それぞれどの工程の手順を文書化するか）

システム開発で作成する設計書には、外部設計をまとめる基本設計書と内部設計をまとめる詳細設計書の2種類があります。詳細設計書に記載する内部設計とは、機能ごとの処理フローや処理項目など、ユーザーの目に見えない部分の設計のことです。

基本設計書でシステム開発の全体像をまとめ、そのあとに内部設計を決めて詳細設計書にまとめます。詳細設計書を作成する際は、基本設計書をもとにシステムの各部分を具体的に設計し、実装に必要な技術的な仕様を細かく記述します。

 

つまり、基本設計書がシステム全体の「設計図」だとすれば、詳細設計書は「施工図」ともいえるでしょう。エンジニアが詳細設計書を見ただけで開発を進められるよう、細かい部分まで落とし込むのが詳細設計書の特徴です。

両文書をあらかじめテンプレート化しておくことで、工程ごとに何を文書化すべきかが明確になり、担当者が変わっても手順の抜け漏れが起きにくくなります。基本設計・詳細設計それぞれのテンプレートを整備し、チームの作業標準として運用することが、設計工程全体の品質均一化につながります。

設計書と仕様書の違い

設計書と仕様書は、それぞれ役割が異なります。設計書は、システムの構造や機能の実現方法についての詳細な設計を記述したものです。これに対して、仕様書はシステムが満たすべき要件や機能についての記述に焦点を当てています。

設計書は「どうやって作るか」を記述する文書であり、主にエンジニア向けに作成するものです。一方、仕様書は「何を作るか」を定義するもので、主にクライアントや関係者向けに作成します。両者は、システム開発の過程で密接に関連しています。

＞関連記事：ドキュメント作成ツールおすすめ6選！選び方や作成のコツを解説

【無料配布】基本設計書テンプレートの構成要素と書き方（誰が作っても同品質に仕上げるための項目設計）

基本設計書には以下の項目を記載します。

基本設計書は項目に沿って記載することで完成するため、書き方に迷ったら項目を埋めるイメージで作成を進めましょう。

基本設計書のテンプレート

ここで紹介するテンプレートは基本設計書の基本型です。テンプレートを基準にカスタマイズしてお使いください。

＞このテンプレートをNotePMで使ってみる（無料）

基本設計書の作成例（新メンバーが参照するだけで書き始められる記入サンプル）

新しくプロジェクトにアサインされたメンバーが、このサンプルを参照するだけで設計書の記述を開始できるレベルを基準に作成しています。テンプレートと併用することで、先輩への確認工数を減らしながら設計書の品質を均一化できます。

プロジェクトの内容に応じて項目を追加・調整しながら活用してください。前述したテンプレートをもとに作成した例文は以下の通りです。

【参考】各機関で配布されているサンプル・ガイドライン

基本設計書を作成する際に参考になる資料が各機関で公開されています。基本設計書のサンプルやガイドラインとして、以下の資料をご活用ください。

• 農林水産省『システム構成図』
• 国立研究開発法人『見守り情報管理システム 基本設計書』
• 国立研究開発法人『eコミマップ 基本設計書』
• IPA『機能要件の合意形成ガイド』
• デジタル庁『デジタル・ガバメント推進標準ガイドライン 実践ガイドブック』

これらの資料は、基本設計書作成のイメージを掴むのに有効です。とくに、基本設計書の具体的な書き方が記載されているIPA『機能要件の合意形成ガイド』は参考になります。

担当者が変わっても品質がぶれない基本設計書を作るためのポイント

基本設計書を作成する際は、以下のポイントを意識しましょう。

• 要件定義書を正確に反映し、手順の抜け漏れをなくす
• 誰が読んでも同じ作業を再現できる表現で書く
• 図解・画面遷移図を使って操作手順を視覚的に伝える

ポイントを踏まえて作成することで、プロジェクト全体のスムーズな進行が期待できます。それぞれ詳しく見ていきましょう。

要件定義書を正確に反映し、手順の抜け漏れをなくす

基本設計書を作成する際は、要件定義書を正確に反映することを意識しましょう。要件定義書には、クライアントやステークホルダーがシステムに求める機能や性能が詳細に記載されています。

要件定義書の内容を正しく基本設計書に落とし込むことで、開発チームが具体的な設計や実装に移る際に、方向性のズレや手順の抜け漏れが発生するのを防げます。要件定義書との不一致があると修正に時間を要するだけでなく、担当者交代時に引き継ぎの基準が崩れる原因にもなるため、設計段階で適切に反映させることが重要です。

＞関連記事：要件定義の進め方とは？必要なプロセスと効率良く進めるポイントを解説

誰が読んでも同じ作業を再現できる表現で書く

新しくプロジェクトに加わったエンジニアが設計書を読んだだけで開発作業を開始できるレベルを基準にして記述します。口頭説明なしで作業を再現できる記述を目指すことが、OJTへの依存を減らす第一歩です。
専門用語を使う場合は注釈を加え、記述の粒度がメンバーによってばらつかないよう、テンプレートに「記述例」を含めておくことが有効です。「このくらいの詳しさで書けばよい」という基準を設計書自体に埋め込むことで、レビュー工数の削減にもつながります。

＞関連記事：【例文付き】ビジネス文書のルールやテンプレートを紹介！社内文書・社外文書それぞれの書き方とは？

図解・画面遷移図を使って操作手順を視覚的に伝える

画面遷移図やシーケンス図を設計書に含めることで、開発メンバーが操作フローを口頭説明なしで把握でき、教育コストを削減できます。各種図のテンプレートをあらかじめ用意しておくことで、新たにアサインされたメンバーでも図の作成から均一化された品質で着手できます。基本設計書で使用する図には以下のような種類があります。

• システム構成図
• ER図
• データフロー図
• クラス図
• シーケンス図
• フローチャート
• ネットワーク図
• コンポーネント図
• 画面遷移図

基本設計書に視覚的な要素を取り入れることで、コミュニケーションミスを減らし、設計書のクオリティを高められるでしょう。例で列挙したように、基本設計書で使用する図は種類が多くあります。一つひとつの図をゼロベースで作成すると時間がかかるため、各種テンプレートを用意しておくことをおすすめします。

たとえば、ドキュメント作成・ナレッジ共有ツール『NotePM』なら図解もテンプレートで簡単に作成可能です。リンクを添付している図に関しては無料でダウンロードできるため、基本設計書作成の際にご活用ください。

基本設計書を整備・改訂するフロー（テンプレートをチームで育てる工程として捉える）

基本設計書は、システム開発の「基本設計」の段階で作成します。そのため、基本設計のプロセスを把握しておくと、基本設計書の作成工程をイメージするのに役立つでしょう。基本設計の業務フローは、主に以下の8ステップで進みます。

基本設計のステップ	成果物
1. 要件定義の確認	・要件定義書 ・リスク管理計画書
2. システム全体の構造設計	・システム構成図 ・業務フロー図
3. 機能設計	・機能仕様書（機能一覧） ・画面設計書 ・帳票設計書
4. データベース設計	・データベース設計書（ER図含む）
5. インターフェース設計	・インターフェース設計書 ・バッチ設計図
6. 非機能要件設計	・非機能要件設計書 ・テスト計画書
7. レビューとフィードバック	・プロトタイプ ・リスク管理計画書（更新版）
8. 詳細設計への移行準備	・システム構成図（最終版） ・機能仕様書（最終版） ・データベース設計書（最終版）

基本設計書は、ステップ2「システム全体の構造設計」以降の段階から作成を進めます。各ステップで作成される成果物は、次の詳細設計以降のプロセスで必要な資料です。

各ステップで作成した成果物を基本設計書のテンプレートとして保存・蓄積していく習慣を持つことで、プロジェクトを重ねるたびにテンプレート資産が育ち、次のプロジェクトのオンボーディングコストを下げていけます。業務フローを「設計書を一度作って終わり」の工程としてではなく、「テンプレートを改訂・蓄積していく工程」として捉え直すことが、設計工程全体の標準化につながります。

基本設計書の成果物一覧

成果物とは、基本設計書を作成した結果として得られる資料のことです。基本設計書における成果物は「基本設計書を作ったことにより、具体的に何が完成したのか」を意味します。基本設計書の成果物は、以下の通りです。

「基本設計書を構成する要素」は基本設計書に何を書くかを示し、「成果物」はそれを書いた結果として何が完成するかを示すのです。基本設計書の成果物を知っておくことで、基本設計の段階で作成される資料が把握できるでしょう。

表からもわかるように、基本設計書の成果物はさまざまです。これらをすべてゼロベースで作成すると、時間も労力も要します。事前にテンプレートを用意しておくと、文書や図解作成の工程が楽になります。

たとえば、NotePMなら成果物のテンプレート作成・管理が可能です。テンプレートを活用し、基本設計のプロセスを効率的に進めてみてはいかがでしょうか。

 

基本設計書のテンプレート管理・改訂管理をNotePMで一元化する

「基本設計書のテンプレートを整備しても、共有フォルダの奥に埋もれて誰も参照しない」「『最終版_2』」のようなファイル名管理で最新版がどれかわからなくなる、という状況では作業標準として機能しません。テンプレートが形骸化する最大の原因は、「整備した場所」と「実際に使う場所」が分断されていることです。

NotePMは、設計書テンプレートの作成・保管・改訂管理を一元化できるドキュメント・ナレッジ管理ツールです。主に以下の3点で、基本設計書テンプレートの標準化運用を支援します。

改訂履歴の自動記録：ページを更新するたびに変更履歴が自動で蓄積されるため、「誰が・いつ・何を変えたか」がファイル名管理なしで追跡できます。旧バージョンを参照した設計ミスや、引き継ぎ時の「どれが最新？」という混乱を防げます。

強力な全文検索：PDFやExcelの中身も含めた全文検索により、過去プロジェクトの基本設計書を素早く参照できます。「前回の類似案件ではどう設計したか」を新しいプロジェクト開始直後に確認でき、テンプレートへの流用が容易になります。

テンプレート機能による標準化の定着：NotePMのテンプレート機能を使うことで、基本設計書の構成・記述粒度をチーム全体で統一できます。新しくプロジェクトにアサインされたメンバーが「NotePMのテンプレートを開いて書き始める」という導線を作ることで、書き方を先輩に確認するOJTコストを削減できます。

テンプレートをNotePMに集約することで、設計書の品質均一化とオンボーディング短縮を同時に実現できます。

＞関連記事：【導入事例】システム開発情報を一元管理。情報を残す企業文化に – 株式会社クラベス

基本設計書はテンプレートの活用で効率よく作れる

基本設計書の作成は、システム開発において重要な工程であるため、作成には時間と労力を要します。効率的に作成するためには、テンプレートの活用が有効です。基本設計書のテンプレートはもちろん、文書内で使用する図解や成果物のテンプレートも準備しておくとより効率的に文書作成が進められるでしょう。

複数のテンプレートを一括管理するなら、マニュアル作成・ナレッジ管理ツール「NotePM」の導入がおすすめです。NotePMにテンプレートを集約すれば、基本設計書の作成が簡単になります。

NotePMでは、30日間無料でお試しできる期間を設けています。基本設計書を含むドキュメント・テンプレートの作成・管理を効率化したい方は、選択肢のひとつとしてツールの導入を検討してみてください。