広告 要件定義・設計

【設計シリーズ】システム開発でよく使う設計書 TOP20

【設計シリーズ】システム開発でよく使う設計書 TOP20

概要

フリーランスエンジニア スリーネクスト

システム開発プロジェクトで頻繁に使用される重要な設計書を、ランキング形式で20種類厳選し、その概要と役割を解説するものです。開発の礎となる「要件定義書」、ユーザー視点の仕様を定める「基本設計書」、開発者向けに内部ロジックを記す「詳細設計書」など、上流から下流工程に至るまで各ドキュメントがどのように連携し、プロジェクトの成功に貢献するかが分かります。

さらに、データ構造を定義する「テーブル定義書」やシステム構成を示す「システム構成図」、品質を担保する「テスト仕様書」まで網羅的に紹介。開発者だけでなく、プロジェクトに関わる全ての人が、各成果物の目的を理解し、円滑なコミュニケーションを図るための一助となります。

順位設計書名概要
1要件定義書顧客の要求をまとめ、システムが実現すべき機能や性能、制約条件などを定義する、開発の全ての基礎となる最重要ドキュメント。
2基本設計書 (外部設計書)要件定義書を基に、ユーザーから見える部分(UI/UX)やシステムの外部仕様を定義する。以降の設計書の親ドキュメントとなる。
3画面設計書 (画面レイアウト)ユーザーが操作する各画面のレイアウト、表示項目、ボタン、操作などを具体的に定義する。モックアップやプロトタイプを含む場合もある。
4テーブル定義書 (ER図)データベースに保存するデータの構造を定義する。テーブル、カラム、データ型、制約などを記述し、ER図でエンティティ間の関連を示す。
5詳細設計書 (内部設計書)基本設計を基に、開発者向けにシステムの内部構造や処理ロジックを詳細に記述する。
6テスト仕様書 (テスト計画書)システムが要件を満たしているか検証するためのテストの方針、範囲、項目、手順、期待結果などを定義する。単体、結合、総合テストなどがある。
7API仕様書 (IF設計書)システム間のデータ連携部分の仕様を定義する。リクエスト、レスポンスのデータ形式や認証方式などを記述する。
8シーケンス図オブジェクト間のメッセージのやり取りを時系列で表現する。特定の機能における処理の流れを視覚的に理解するために用いる。
9画面遷移図アプリケーションの画面が、ユーザーの操作によってどのように移り変わるかを示す。システム全体の画面フローを把握するために不可欠。
10システム構成図サーバー、ネットワーク、データベースなど、システムを構成するハードウェアやソフトウェアの物理的、論理的な配置を示す。
11クラス図システムを構成するクラス、その属性、メソッド、クラス間の関係(継承、関連など)を静的に表現する。オブジェクト指向設計の中核。
12運用マニュアルシステムの起動・停止、バックアップ、監視、障害発生時の一次対応など、日々の運用に必要な手順をまとめたドキュメント。
13WBS (作業分解構成図)プロジェクト全体の作業を階層的に分解し、タスクを洗い出す。スケジュール管理や進捗確認の基礎となる。
14バッチ処理設計書夜間や定期的に自動実行される処理の仕様を定義する。処理フロー、実行タイミング、データフロー、異常系処理などを記述する。
15非機能要件定義書性能、信頼性、セキュリティ、保守性など、機能面以外でシステムが満たすべき品質特性を定義する。
16ユースケース図アクター(ユーザーなど)とシステムとのインタラクションを記述し、システムが提供する価値(ユースケース)を明確にする。
17機能一覧システムが持つ全ての機能をリスト形式でまとめたもの。開発範囲の確認や進捗管理に利用する。
18帳票設計書システムから出力される請求書やレポートなどの印刷物のレイアウト、出力項目、計算式などを定義する。
19コーディング規約プログラムの書き方に関するルール。変数名の付け方やインデントのスタイルなどを統一し、コードの可読性や保守性を高める。
20障害管理表テスト工程や本番運用で発生した障害(バグ)の内容、原因、対応状況などを記録・管理するためのリスト。

-要件定義・設計