外部設計書(基本設計書)
外部設計書(基本設計書とも呼ばれます)は、要件定義で決まった「やりたいこと」を、**「システムのユーザーから見える形」**に落とし込む作業です。
「プログラムをどう書くか」ではなく、**「ユーザーが何を触り、何を見るか」**を確定させるのが目的です。
🛠️ 外部設計書の構成要素と作成ポイント¶
外部設計で作成される主な成果物と、作成時のコツをまとめました。
1. 画面一覧・画面遷移図¶
- 内容: システムに存在する全画面のリストと、ボタンを押した際にどの画面へ移動するかを示す図。
- ポイント: ユーザーの業務の流れ(ストーリー)に矛盾がないかを確認します。
2. 画面レイアウト(ワイヤーフレーム)¶
- 内容: 各画面のボタン、入力フォーム、表示項目などの配置図。
- ポイント: * 入力制限: 「ここは数値のみ」「20文字以内」といった制約を明記します。
- エラー表示: 入力ミスがあった際、どこにどんなメッセージを出すかも定義します。
3. 帳票一覧・レイアウト¶
- 内容: PDFやExcelで出力されるレポートや請求書などのデザイン。
- ポイント: 印字されるデータの最大文字数を考慮し、枠からはみ出さないかなどを確認します。
4. 外部インターフェース設計¶
- 内容: 他のシステムとデータをやり取りする場合のルール(API仕様やファイル形式)。
- ポイント: 連携のタイミング(リアルタイムか、1日1回のバッチか)を明確にします。
5. データモデル(ER図)¶
- 内容: システムで扱うデータの構造。
- ポイント: ユーザーが管理したい項目(名前、住所、注文日など)がすべて網羅されているかを確認します。
💡 実際の作成における3つのコツ¶
- 「ユーザーが合意できるか」を最優先する 内部の技術的な話(サーバーの構成など)は最小限にし、ユーザーが「これなら仕事ができる」とイメージできる表現を使いましょう。
- 正常系だけでなく「異常系」を定義する 「保存ボタンを押した時に通信エラーになったらどうするか?」といった、困った時の挙動をここで決めておくと、後のトラブルが激減します。
- 用語集を共通化する 「顧客」「クライアント」「取引先」など、人によって呼び方がバラバラだと設計が混乱します。呼び名を統一して記載しましょう。
🔗 サンプル・テンプレートの参考URL¶
Web上で公開されている、信頼性の高いテンプレートやサンプルをいくつかご紹介します。
- IPA(情報処理推進機構)- 03_基本設計書.doc
-
日本の標準的なドキュメント構成を知るのに最適です。
-
解説付きで、現場で使いやすいモダンな構成のヒントになります。
- 個人のエンジニアが公開しているExcelテンプレートなども多く、実務的な書き方の参考になります。
次は、開発者向けのより詳細な**「内部設計書」**との違いや、具体的な書き分けについて深掘りしましょうか?