この記事は、「架空プロジェクトを通してシステム開発とドキュメント作成を体験してみる（2022 Late）」の記事の一部です。
基本設計書の概要
一般にはシステムの全体像、外部設計（画面系）、内部設計（I/F、バッチ等）を記述するようですが、私はシステム全体に関連する基本的・共通の技術要素を記述するようにしています。
これは私がアジャイル的な開発をすることが多く、詳細設計については実装が先行しドキュメントは不要か後作成となるため、実装の前に決めておくべき最低限の情報 = 基本設計書として記述しておくことが習慣になっているためです。
| 項目 | 内容 |
|---|---|
| 作成目的 | システムの基本・共通となる技術情報を記載（独自） |
| 記述すべき内容 | 名称定義、方式、（Webの）構成等 |
| 作成タイミング | 基本設計 |
| 対象者 | 技術者 |
| ファイル形式 | パワーポイント、Excel、Word |
| 備考 | 一般的な基本設計書と内容が異なります |
一般的にはどうなのか？が気になる人は後半にある「一般的には（参考）」に先に目を通してもらったほうがいいかもしれません。
サンプルダウンロード
サンプルのダウンロードはこちらから。
サンプルの基本設計書は一般的な基本設計書と記述内容（スコープ）が異なります。
作成してみる
では作成していきましょう。
作成方針・ポイント
概要でも書きましたが、私の基本設計書は一般と少し違います。アジャイル開発でも決めておかないといけない要素を基本設計書に記述し、実装で補う範囲については、ドキュメントを作成しないか、後から詳細設計書を起こすようにしています。
構成（目次）を考える
アジャイル開発をする場合でも、決めておいたほうが良い要素として、サンプルでは下記のような項目を記述してみることにしました。
- システムの構成要素と名称
- 方式設計
- Webサイト構成
一般的な基本設計の構成例が知りたい方は、下段にある実践ガイドの基本設計の構成例を見てみてください。
記述例（サンプルから抜粋）
では、サンプルの主要なページについて少し解説したいと思います。
表紙
特に補足することはありません。
目次
こんな感じ。
基本設計の位置付け
通常の基本設計書とは内容が違うので位置付けを記述。
システムの構成要素と名称
設計するには設計対象に名称をつけないと何かと不自由なので名称定義を最初に行っています。
方式設計
各機能をどういう技術で開発するのかについて定義しています。
Webサイト構成
今回はWebベースのシステムなのでWebサイトとしての構成を定義しています。
基本設計書のサンプルではこの3枚だけです。
この程度の内容であれば、基本設計と詳細設計を無理してわけず、設計書の「基本部分」として記述するのもありだと思います。
一般的には（参考）
実践ガイドブックでは？
実践ガイドブックでは残念ながら「基本設計書」としてのテンプレートは提供されていないようですが、ガイドライン中（第3編7章 設計・開発 P18）に基本設計書の構成例として下記の記述があります。
結構がっつり系の内容になってます。
実は実践ガイドブックには詳細設計に関する具体的な記述やテンプレートが無いため基本設計と詳細設計をどう切り分けるのかという明確な指針はありません・・・。
設計工程をどう分けるかは会社によりことなる例も示されています。
- 基本設計＋詳細設計派
- 外部設計＋内部設計派
- その他派
に大きく分かれるのかな？