

高岡智則
年齢:33歳 性別:男性 職業:Webディレクター(兼ライティング・SNS運用担当) 居住地:東京都杉並区・永福町の1LDKマンション 出身地:神奈川県川崎市 身長:176cm 体系:細身〜普通(最近ちょっとお腹が気になる) 血液型:A型 誕生日:1992年11月20日 最終学歴:明治大学・情報コミュニケーション学部卒 通勤:京王井の頭線で渋谷まで(通勤20分) 家族構成:一人暮らし、実家には両親と2歳下の妹 恋愛事情:独身。彼女は2年いない(本人は「忙しいだけ」と言い張る)
設計文書・とは?初心者が知っておく基本の解説
設計文書とは、あるプロジェクトで作るものの「何を作るか」「どう作るか」を整理して書き残す文書です。目的は関係者の認識をそろえ、作業の進み方を共有することです。ソフトウェアだけでなく、建築や機械の設計でも使われます。設計文書を正しく作ると、途中で仕様がぶれてしまうことを防ぎ、後から振り返って学ぶ資料にもなります。
設計文書と要件定義書の違いを理解することが大切です。要件定義が「何を満たすべきか」を決めるのに対し、設計文書はその要件を現実にどう実現するかの道筋を示します。読み手は開発者だけでなく、業務部門の担当者やテスト担当者も含まれます。したがって読みやすく、具体的で、誰が読んでも同じ解釈になるように書く必要があります。
設計文書の具体的な役割には三つの側面があります。第一に共有です。設計文書を通じてチーム全員が同じ要件像と実装方針を把握します。第二に証拠です。後で検証や技術的な意思決定の根拠として参照できます。第三にガイドです。新しいメンバーがプロジェクトに参加する時の手引きとして機能します。
設計文書の主な構成
以下は一般的な構成例です。実際には組織ごとにフォーマットが異なります。
| 項目 | 内容の例 |
|---|---|
| 概要 | プロジェクトの目的と背景を短くまとめる |
| 範囲と前提 | 対象範囲と実行条件、制約 |
| 機能要件 | 実現する機能と振る舞いの説明 |
| 非機能要件 | 性能、信頼性、セキュリティなど |
| データ設計 | データの定義、関係性、データモデル |
| 画面設計・UI | 画面のレイアウト方針、主要な画面の説明 |
| 技術・設計方針 | 使う技術、開発手法、設計の原則 |
| テスト方針 | テストの範囲と方法、受け入れ基準 |
| 承認・配布 | 承認者、版管理、公開手順 |
実務ではこの表に自分たちなりの項目を追加していきます。
設計文書を書き始める手順
最初は要点だけを紙に書き出してから、各項目を詳しく肉付けします。読み手を想定して、専門用語を避け、具体的な例を盛り込みます。図やワイヤーフレームを添えると理解が早くなります。
最後に、設計文書は完成品ではなく、開発の過程で更新される生きた文書です。新機能が追加されたり仕様が変わるたびに、最新版を関係者に共有し、履歴を残す習慣をつけましょう。
初心者向けのポイント
初めて設計文書を作る人は、最初から完璧を求めず、読み手の視点を最優先に、伝わる文章と図を意識します。読みやすさのコツは、長い段落を分割し、見出しを使い、具体例を入れることです。
実務での活用例
ある機能を作る前に、設計文書を読んだだけで開発者は「何を作るか」を、テスターは「どの機能を確認するか」を理解できます。仕様変更があっても、最新版の設計文書を参照すれば原因を追いやすい。このような記録を残すことが、長期的な品質向上につながります。
また設計文書は新規メンバーのオンボーディングにも役立ちます。チームが小さいうちは、私たちはプロジェクトの全体像をこの文書を通じて共有します。新しい参加者はこの文書を読んで、すぐに会話へ参加できます。
結論
設計文書はプロジェクトの地図です。読み手を想定した明確さ、具体性、そして更新の履歴管理が、成功のカギです。
設計文書の同意語
- 設計書
- 設計全体の方針や構造、仕様をまとめた正式な文書。要件を満たす設計情報を一つに集約します。
- 設計仕様書
- 設計の仕様を詳しく定めた文書。機能要件やデータ仕様、インターフェース、動作条件などを具体的に記述します。
- 仕様書
- 仕様を定義する文書の総称。要件と設計の両方を扱うことがあり、設計文書の中核になることが多いです。
- 機能仕様書
- 各機能が満たすべき要件を個別に定義した文書。入出力、処理の流れ、エラーハンドリングを詳述します。
- アーキテクチャ設計書
- システム全体の構造や相互作用を整理して記した文書。アーキテクチャの選択と全体像を示します。
- アーキテクチャ仕様書
- アーキテクチャの仕様を明確化した文書。部品間のインタフェース、境界、品質要件を定義します。
- システム設計書
- システム全体の設計方針と要件をまとめた文書。データの流れや外部連携、運用面の要件を記述します。
- 基本設計書
- 開発の初期段階で作成する大枠の設計をまとめた文書。機能の分割、データモデル、外部設計の指針を記します。
- 詳細設計書
- 基本設計を受けて、実装レベルの設計を具体化した文書。モジュール・クラス・データ定義・インタフェースを詳述します。
- ソフトウェア設計書
- ソフトウェア開発向けの設計情報をまとめた文書。モジュール構成、データ設計、インタフェース、設計基準を記述します。
- 技術設計書
- 特定技術に焦点を当てた設計をまとめた文書。採用技術や実装手法、運用設計を詳述します。
- 設計資料
- 設計に関する図表・説明文・根拠資料など、設計情報を集めた資料群。共有用の素材として使われます。
- 設計ドキュメント
- 設計を文書化した総称。Design Document に近い形で、開発チーム間の共通資料として用いられます。
- 設計図
- 設計の図面・図表を含む文書。ハードウェアの設計情報を表す場合が多いですが、ソフトウェア分野でも高レベルの設計情報を指すことがあります。
設計文書の対義語・反対語
- 実装コード
- 設計文書が示す抽象的な仕様を、実際に動くプログラムへ変換したコードの集合です。設計の成果物がどう動くべきかを記述するのに対して、実装コードはそれを実際に動作させる具体的な形です。
- ソースコード
- 人が読めるプログラミング言語で書かれた命令の集まりです。実装の中心となる実体で、設計文書を実装する際の核となります。
- プログラム
- 特定の機能を実現するために動作するソフトウェアの集合体。設計文書が何を作るかを示すのに対し、プログラムは実際にどう動くかを示します。
- 要件定義書
- システムが満たすべき機能や制約を定義した文書です。設計文書の前段にあたり、要件が確定すると設計の方向性が決まります。
- 要件定義
- 要件の定義そのものを指す概念です。機能や性能などの要件を整理し、設計の出発点となる情報を提供します。
- 運用手順書
- システムを日常的に運用する際の手順や操作ルールをまとめた文書です。設計文書が作るべき構造とは別の現場での運用手順を示します。
- 運用マニュアル
- 運用担当者が日々の作業を円滑に進めるための案内書です。設計の設計図ではなく現場運用の実務ガイドです。
- テスト仕様書
- 品質保証のための検証計画とテスト項目を記述した文書です。設計が意図する仕様が正しく実装されているかを検証する観点の文書です。
- 保守ガイド
- システムの障害対応や修正を行う際の方針や手順をまとめた文書です。設計段階の設計情報とは別の長期的な保守のための実務資料です。
- 実装仕様書
- 実装時の具体的な振る舞いと制約を定義した文書です。設計文書が抽象的な仕様を示すのに対し、実装仕様書は実装時点の細かな仕様を記述します。
- コードベース
- ソースコードを含むリポジトリ全体のことです。設計文書が示す目標を現実の動作として形にした実装の現物です。
設計文書の共起語
- 要件定義書
- システムに求める機能と条件を整理し、関係者の合意を取り付ける基礎文書。機能・性能・制約などを体系的にまとめます。
- 仕様書
- 機能の動作や入力・出力・境界条件など、実装の指針となる仕様を具体的に記述した文書。
- 機能仕様書
- 各機能の振る舞いを細かく定義した文書。どんな入力を受け、どんな処理を行い、どんな出力を返すかを明示します。
- 非機能要件
- 性能・信頼性・セキュリティ・可用性など、機能以外の品質要件を整理する項目。
- 画面設計書
- 画面レイアウト・UI要素・操作フロー・エラーメッセージなど、画面の見た目と挙動を設計します。
- アーキテクチャ設計書
- システム全体の構造と技術方針、主要コンポーネントとその責任を示す文書。
- データ設計書
- データの意味・構造・制約を定義する文書。データ型、制約、リレーションの基本を整理します。
- データベース設計書
- DBのスキーマ設計をまとめた文書。ER図・正規化・キー設計・インデックス方針などを記述。
- ER図
- エンティティとリレーションを視覚化した図。データベース設計の核となる関係を表します。
- データモデル
- データの意味づけと関係を抽象化した設計モデル。実装データの整合性を保つ指針になります。
- API仕様書
- 外部や内部サービスとの通信仕様を定義する文書。エンドポイント・リクエスト・レスポンス・認証・エラーハンドリングを記します。
- インターフェース仕様
- モジュール間やシステム間の接続仕様を定義。データ形式・契約・タイミングを明示します。
- ユースケース
- 利用者がシステムをどのように使うかを場面別に記述するストーリー形式。機能の要件を具体化します。
- ユースケース図
- ユースケースとアクターの関係を図で示す図。要件の全体像を俯瞰するのに役立ちます。
- UML仕様
- Unified Modeling Languageに基づく設計表現の総称。クラス図・シーケンス図などを組み合わせて表現します。
- クラス図
- クラスとその属性・メソッド、関係を図示した設計図。オブジェクト指向の構造を視覚化します。
- シーケンス図
- 処理の順序と相互作用を時系列で表す図。動作の流れを明確化します。
- アーキテクチャ図
- システム全体の構造を視覚化した図。レイヤ構造や依存関係を一目で把握できます。
- コンポーネント設計
- システムを構成する部品(コンポーネント)の責任範囲とインターフェースを定義します。
- ソフトウェア設計書
- ソフトウェア全体の設計方針・構造・モジュール間の関係をまとめた文書。
- システム設計書
- ハードウェアとソフトウェアを含むシステム全体の設計を記述する文書。非機能要件との整合を扱います。
- クラス設計
- クラスの責任・属性・メソッド、相互作用を具体的に定義した設計。
- テスト計画書
- テストの目的・範囲・方針・実施手順を整理する文書。品質保証の計画版です。
- テスト仕様書
- 個々のテストケースを詳細に記述する文書。入力条件・期待結果・実行条件を明記します。
- 変更管理
- 設計変更の承認・追跡・適用を統括するプロセスと記録。
- 変更履歴
- 仕様・設計の変更内容と日付・担当者を記録する履歴。追跡性を高めます。
- 受け入れ基準
- 納品物を受け入れるための基準を明確化する文書。顧客要件の満足を測定します。
- 画面遷移図
- 画面間の遷移関係を矢印で示す図。ユーザーの操作フローを可視化します。
- ワイヤーフレーム
- 画面の大まかなレイアウトを示す下書き。デザインの初期段階で使います。
- 実装ガイド
- コーディング規約・推奨実装パターン・共通処理のガイドをまとめた文書。
- 技術仕様
- 採用技術の選択理由・環境要件・ライブラリ・フレームワークの詳細を記述します。
- 品質保証
- 品質を確保するための検証・評価方法と基準をまとめた文書。
- 仕様ガイドライン
- 仕様作成時の標準ルール・命名規約・表現方法などの指針を示します。
- ドキュメント管理
- 設計文書の保管・名称付け・版管理・検索性を整える運用を示します。
- ドキュメンテーション
- 設計情報を適切に記録・共有する作業とその方針。
- レビュー結果
- 設計案を第三者がチェックした結果と指摘、対応策をまとめた文書。
- 仕様書テンプレート
- 仕様書作成時のひな形。項目構成とフォーマットを標準化します。
- 要件追跡性マトリクス
- 要件と設計要素の対応関係を追跡する表。変更時の影響範囲を把握します。
- バージョン管理
- 設計文書を含むすべてのファイルの履歴管理と変更の統制を行う仕組み
設計文書の関連用語
- 設計文書
- ソフトウェア開発における設計方針と仕様を正式にまとめた文書。全体設計・基本設計・詳細設計などの根拠となる。
- 要件定義書
- ビジネス要件・利用者要件・制約条件を整理し、何を作るかを明確化する文書。
- 基本設計書
- システム全体の構成、データの流れ、外部インターフェースなどを高レベルで整理する設計文書。
- 詳細設計書
- 各機能の実装方法・データ構造・アルゴリズム・API仕様などを具体的に記述する文書。
- システム設計書
- システム全体の設計方針・構成要素・モジュール間の連携を記載する文書。
- アーキテクチャ設計書
- ソフトウェアのアーキテクチャ(層構造、技術選択、境界)を決定・記録する文書。
- API設計書
- 公開/内部 API のエンドポイント、HTTPメソッド、リクエスト/レスポンス、認証・エラーハンドリングを定義する文書。
- データベース設計書
- データベースのスキーマ・正規化・制約を設計する。
- データ辞書
- データ要素の意味、型、制約、デフォルト値などを統一して管理する用語集。
- ER図
- Entity-Relationship 図。実体と関係を視覚的に表し、データモデルを整理する図。
- データモデリング
- 業務データを抽象化してモデル化する作業。データ構造を決める基盤。
- データ移行計画
- 新システムへデータを安全に移行する手順と検証方法。
- 画面設計書
- 画面レイアウト、UI要素、入力・出力の配置と動作を仕様化した文書。
- ユースケース仕様
- ユーザー視点での機能の動作を、具体的なシナリオとして記述する仕様。
- ユースケース図
- アクターとユースケースの関係を図で表現する図。
- ワイヤーフレーム
- 画面の骨組みを低忠実度で示すレイアウト案。
- プロトタイプ
- 実際に動く簡易モデルを作成して、UI/挙動を検証するための試作品。
- インターフェース設計書
- モジュール間・外部システムとの接続仕様、データ形式、契約を定義する文書。
- 外部仕様書
- ユーザーや他システムへ提供する機能・振る舞いを記述した仕様書。
- 内部仕様書
- 開発者向けに、実装の詳細・データの扱い・アルゴリズムを記した仕様書。
- 機能仕様
- 各機能が満たすべき要件と、入出力・振る舞いを具体的に示す仕様。
- 非機能要件
- 機能以外の品質要件。性能・信頼性・セキュリティ・可用性などを含む。
- パフォーマンス要件
- 応答時間、処理量、資源使用量など、性能に関する要件。
- セキュリティ要件
- 認証・認可・データ保護・監査・脆弱性対策など、セキュリティの要件。
- 可用性要件
- システムが継続的に稼働するための要件。冗長化や障害時対応を含む。
- 信頼性要件
- 故障率の低減、MTTR短縮、バックアップ・復旧の要件。
- 拡張性/保守性要件
- 将来的な機能追加や保守作業のしやすさを確保する要件。
- 品質保証計画
- 品質目標と検証・評価の方法・責任分担を定める計画。
- テスト計画書
- どのテストをいつ実施するか、範囲・方法・資源・スケジュールを整理。
- 単体テスト仕様
- 各部品・関数の正しい動作を検証するためのテストケースの仕様。
- 統合テスト仕様
- 複数の部品の連携を検証するテストケースの仕様。
- 受け入れテスト計画
- 顧客視点の受け入れ条件と検証方法を定義する計画。
- テストケース/テストシナリオ
- 実施する具体的な手順と期待結果を列挙したテストケース群。
- 変更管理/変更履歴
- 変更の申請・承認・実施・記録を管理する仕組み。
- バージョン管理
- コード・ドキュメントの履歴を追跡・管理する仕組み(例 Git)。
- トレーサビリティマトリクス
- 要件と設計・実装・検証を結びつけ、追跡可能にする表。
- 設計審査/レビュー
- 設計内容を複数人で検討・承認するレビュープロセス。
- 仕様変更手順
- 仕様を変更する際の申請・承認・周知・適用の手順。
- ドキュメント標準/テンプレート
- 文書作成の統一ルールや雛形を提供する指針。
- レビュープロセス
- 文書の品質を保つためのレビューの流れと責任。
- リリースノート
- 新バージョンの変更点・影響範囲を分かりやすく記載した報告書。
- デプロイ計画
- 本番環境へのリリース手順・実施時の作業を整理した計画。
- バックアップ設計
- データ保護のためのバックアップ方針・手順を設計。
- 災害復旧計画
- 大規模障害時の復旧手順・優先順位を定める計画。
- ログ設計
- 運用・障害対応のためのログ収集・保存・解析方針を設計。
- 監視設計
- 稼働状況を監視する指標・閾値・通知ルールを設計。
- 運用設計
- 日常運用の手順・監視・保守作業を整理した設計。
- 保守設計
- 障害対応・修正・機能追加を容易にする設計思想。
- デザイン規約/スタイルガイド
- UI/UXとコーディングの統一ルールを定める規約。
- UX要件
- 使いやすさ・体験の品質に関する要求を具体化。
- クラウド設計ドキュメント
- クラウド環境での構成・セキュリティ・運用方針を記す。
- マイクロサービス設計書
- マイクロサービスの責務・通信方式・データ分離を定義する設計書。
- モバイル設計仕様
- モバイルアプリの画面・操作・適合性を規定する仕様。
- UI/ウェブデザイン仕様
- Web UIの見た目・操作・アクセシビリティの仕様。
- 画面遷移図
- 画面間の遷移を図解して、ユーザー到達経路を示す図。
- リリース計画
- リリーススケジュール・作業内容・担当を整理する計画。
- 監査要件
- 監査対応に必要なログ・証跡・手順を定義。
- 互換性要件
- 既存システムやデータ形式との互換性を確保する要件。
- 依存関係管理
- 外部ライブラリ・モジュールの依存性を管理する仕組み。
- 仕様書の版管理
- 仕様書の版数・改訂履歴を管理する仕組み。
- リファクタリング方針
- コードの改善方針・手順・影響範囲を定義。
- 互換性テスト方針
- 互換性を検証するテストの方針・範囲を定義。
- 運用マニュアル
- 日常の運用作業手順・対応例を記載したマニュアル。
- デザイン規約/スタイルガイドの補足
- 最新のデザイン基準・UI要素の利用指針を補足。
設計文書のおすすめ参考サイト
- 概要設計書とは?作成や管理に役立つシステムをご紹介!
- 基本設計はどこまでする?概要や基本設計書の内容などを紹介
- プログラム設計書とは?役割や書き方を詳しく解説【サンプル付き】
- システム設計における2つの設計書とは?概要や書き方、注意点を解説
- SEが作る設計書について #初心者 - Qiita



















