1. 設計書には基本設計書と詳細設計書がある
設計書とは？
「設計書」とは、システム開発において「何を、どのように作るか」を関係者全員に共有するためのドキュメントです。ユーザー・エンジニア・テスター・保守運用チームなど、多くの関係者が読むことを前提としているため、正確かつ分かりやすい表現が求められます。
基本設計書と詳細設計書の違い
2. 設計書に書かれている項目について
基本設計書の記載項目（主に外部設計）
基本設計書では、まず「システム全体の概要」や「開発の目的」といった前提情報が明記されます。これにより、関係者全員が共通認識を持つことができます。
次に、「機能一覧」では各画面やバッチ処理などの主要な機能が整理され、それぞれの役割や連携の概要が記載されます。利用者の視点から見た「業務フロー」や「データフロー」も図などを用いて表現されることが多く、業務全体の流れやデータの動きが視覚的に理解できるようにします。
また、「画面設計書」では、各画面のレイアウト、入力項目、出力内容、そして画面遷移などが定義され、ユーザーインターフェースの仕様がまとめられます。
さらに、「外部インターフェース仕様」では、他システムとの連携に必要な情報（APIの仕様やデータ連携形式など）が記載され、非機能要件としてはセキュリティ要件、同時接続数、レスポンス速度などの性能面も設計段階で明示します。
詳細設計書の記載項目
詳細設計書では、基本設計よりも具体的かつ技術的な情報が記述されます。まず、「クラス設計」ではモジュールやクラスの構成、責任範囲、相互関係などが図や文章で定義されます。これにより、開発者が実装すべき構造が明確になります。
次に、「データベース設計書」では、テーブルごとのカラム定義、データ型、主キーや外部キーの関係、制約条件などが詳しく記述されます。ER図を用いて視覚的に表現されることも一般的です。
「API設計書」では、各APIエンドポイントのURL、HTTPメソッド（GETやPOSTなど）、リクエストパラメータ、レスポンス形式、ステータスコード、エラーメッセージなどが記述され、フロントエンドや他システムとの連携に必要な仕様が網羅されます。
また、バリデーションに関する仕様では、必須入力条件、有効桁数、正規表現などの入力制限が明記され、処理フローに関する記述では、擬似コードやフローチャート、シーケンス図などを用いてロジックの流れが表現されます。
エラーハンドリング設計では、発生しうる例外や障害パターン、ログ出力のルール、ユーザーへの通知内容などが明示され、実装やテストに必要な情報が揃えられます。
最後に、設計上の前提条件や制限事項（例：使用するミドルウェア、対応ブラウザ、運用時間など）も記述されることで、環境に依存する要素をあらかじめ明確にしておくことができます。
3. 設計書におけるチェックポイントについて
設計書レビュー時の主なチェックポイント
品質の高い設計書を作るコツ
・視覚的に整理する → 表・図・フロー図を効果的に活用。特に業務フローは BPMN や UML 活用がおすすめ。
・読み手を意識する → 誰が読むかを想定し、「背景」や「前提条件」も丁寧に書く。
・コメント・メモ欄を残す → なぜこの設計にしたのかの理由を明記。設計意図が伝わりやすくなる。
・チェックリストを作る → 自動レビュー・人間レビューともに「チェックリスト方式」で行うと漏れが少ない。
設計書レビュー時の便利なツール
・Backlog／Confluence：共同編集＆履歴管理に最適
・PlantUML：クラス図やシーケンス図を簡単に描ける
・Draw.io／Lucidchart：フローチャートや画面設計の図を美しく整理
・Google Docs／Excel Online：複数人で同時編集・コメントが可能
設計書は、システム開発における「設計の見える化」を実現するための最も重要な資料です。基本設計書と詳細設計書を適切に使い分けることで、要件と実装のズレを防ぎ、関係者全員が同じ方向を向いて開発を進めることができます。さらに、設計書の品質を高めるには、読み手を意識した表現、図やフローの活用、そしてチェックリストによるレビュー体制の構築が不可欠です。日々変化する技術やビジネス要件に柔軟に対応するためにも、設計書の書き方や考え方を今一度見直し、誰もが理解しやすく、保守性の高い設計を目指していきましょう。
