1. 設計書とは

システム開発における「設計書」とは、システムをどのように作るかを定義した設計情報の集合体です。開発者はもちろん、プロジェクトマネージャーやテスター、顧客との認識を合わせるためにも欠かせない資料です。

 

設計書には「基本設計書」と「詳細設計書」がある



両方の設計書をしっかり作ることで、仕様漏れや認識齟齬による手戻りを防ぎ、開発効率を大きく高めることができます。

 

2. 基本設計書の書き方

基本設計書は、顧客と開発チームの橋渡しをする重要なドキュメントです。ユーザー視点に立ち、ビジネスの流れや画面の使いやすさなどを重視して書く必要があります。

 

基本設計書の7つの項目

機能一覧

要件定義で挙げた業務上のニーズをベースに、システムが提供すべき機能を一覧化します

例:ログイン、商品検索、購入処理、レポート出力など。

・補足: 機能に優先度をつけることで、リリースのスケジューリングや段階開発がしやすくなります。

 

業務フロー図・システム構成図

・業務フロー図:顧客の業務プロセスを視覚化(BPMNなど)

・システム構成図:どのサーバーで何が動くか(API、DB、外部連携など)

補足:ステークホルダーにとって「全体像」が把握できるため、誤解が生まれにくくなります。

 

画面設計図

ワイヤーフレーム、プロトタイプ(Figma等)で、UIの構成、操作性、画面遷移を設計。

ポイント:

・入力必須項目、制限文字数、入力チェック仕様を明示

・モバイル対応ならレスポンシブ設計にも配慮

帳票設計図

帳票の名称、項目、並び順、印刷サイズ、出力形式(PDF, Excel)などを明確化します。

・活用例:会計、在庫、発注履歴など、業務系システムには必須。

 

バッチ設計図

定期的に実行されるバックグラウンド処理の設計。夜間集計やデータ転送などが該当します。

記述項目

・処理名・目的

・入力データ・出力データ

・実行時間・スケジューラー設定

・エラーハンドリング方式

データベース設計図

ER図(Entity Relationship Diagram)やテーブル定義書で、データ構造を視覚化。

 

注意点: データの整合性・正規化・インデックス設計も意識しましょう。

 

外部インターフェース設計図

APIや外部システム連携の仕様定義。JSON/XML形式、認証方式、タイムアウト設定などを明記。

 

基本設計書の書き方のポイント

・第三者が見ても理解できること(図解・注釈の活用)

・顧客・業務側との認識を一致させること

・変更履歴や未確定項目を明記すること

 

3. 詳細設計書の書き方

詳細設計書は、プログラマーが仕様通りにコーディングできるレベルまで落とし込んだドキュメントです。正確さ・具体性が重要です。

 

詳細設計書の4つの項目

クラス図

クラス、属性(フィールド)、メソッド、アクセス修飾子、継承関係などをUMLで設計。

→ オブジェクト指向開発(Java, C#等)では特に重要。

 

モジュール構成図

アプリケーションを構成する各モジュール(機能単位)を明確にし、責務を分離して設計します。モジュール間の依存関係も視覚化しておくと、保守性・再利用性が高まります。

 

アクティビティ図

条件分岐、ループ、ユーザーの操作に応じた処理フローを図解。フローチャートに近い。

・目的:開発者やレビュー担当が「どんな順序で処理されるか」を把握しやすくなる。

 

シーケンス図

各オブジェクト間のやり取りを「時系列」で表現。メソッド呼び出しや応答などの流れを明示。

 

詳細設計書の書き方のポイント

・命名ルール、ディレクトリ構成、バージョン管理の指針も記述

・エラーパターンも含めて設計し、「例外に強い」システムへ

・図と文章のバランスを意識し、誰でも読みやすくする

 

設計書は、プロジェクト成功のための「設計図」であり、品質・スピード・チーム連携の土台となる存在です。基本設計書でユーザー視点の全体像を描き、詳細設計書で開発者視点の具体的な構築方針を示すことで、仕様漏れや手戻りを防ぐことができます。しっかりと設計フェーズに時間をかけることで、結果的に開発全体がスムーズに進行し、保守性や拡張性にも優れたシステムが構築できます。