設計書の作成方法

Web開発の現場で、設計書がほとんどない開発が多かったので、直近の現場で得た設計書作成方法を備忘録としてまとめました。

設計書の分類

設計書は大きく分けて以下のような分類となります。

• 00.管理
  • スケジュール
  • 体制図
  • 議事録
  • QAシート
• 10.要件定義
  • 要件定義書
• 20.基本設計
  • システム設計書
  • DB定義書
  • 画面設計書
  • バッチ設計書
• 30.詳細設計
  • 〇〇バッチ設計書
  • △△画面設計書
• 40.製造
  • ソース
  • ストアド、ジョブ、バッチ
  • DDL・DML
• 50.単体テスト
  • 単体テスト仕様書
  • 単体テストエビデンス
  • 単体テスト障害管理
• 60.結合テスト
• 70.総合テスト
• 80.移行設計
  • 移行設計書
  • 移行手順書
• 90.運用設計書

設計書の作り方

基本的にExcelで作成し、印刷設定を考慮して作成していく。
設計書には共通して、下記のシート、ヘッダーを作成する。
設計書は基本的にセル幅、セル高さを揃えておき、必要であれば適宜調整。（印刷時の設定を考慮する）

共通シート

• [表紙]

  • システム名
  • フェーズ
  • 設計書名
  • バージョン
  • 作成日
  • 作成者
  • 会社名
  • 部署名

• [改訂履歴]

  • | バージョン | 更新日 | 担当者 | 承認者 | 改定内容 |

• [目次]

  • | シート名 | 概要 |

共通ヘッダー

シート上部のヘッダーに下記項目を共通で設定する。

• フェーズ
• システム名
• サブシステム名
• 機能名(シート名)
• 作成日
• 作成者
• 更新日
• 更新者

10.要件定義

要件定義書

• 概要
  • XXXXXからXXXの申込を行なう。
  • サービス提供時間：9:00　～　21:00
  • 提供商品：XXXXX
  • システムフロー
• 機能要件
  • 店舗の登録・設定更新、申込状況確認、お客様控の再出力
  • 利用者：一般ユーザー、代理店、
• 非機能要件
  • データ量：1日 50件 50×365 = 年 18250件　5年間 91250件
    10MB × 91250 = 912.5 GB
  • 同時アクセス数（セッション数）：50件 / 12h = 4/1h
  • セッション保持時間：2h

20.基本設計書

システム設計書

• [概要]
  1. 概要
  2. システム構成一覧
     • 各AP、DB、他サーバーの構成、アーキテクチャ、バージョン
     • | システム名 | 種類 | OS | バージョン |
  3. システム構成図

DB設計書

A5M2でテーブル・ビューは簡単に出力できる。

• [概要]
• [コード値マスタ]
• [ストアド一覧]
• [〇〇ストアド]
• [テーブル一覧]
• [〇〇テーブル]

画面設計書

• [概要]
  1. 概要
  2. 画面一覧
     • | 画面ID | 画面名 | 概要 |
  3. [画面遷移図]

バッチ設計書

• [概要]
  1. 概要
  2. バッチ一覧
     • | バッチID | バッチ名 | 概要 | トリガー | 実行方法 |
  3. [バッチ実行図]

30.詳細設計書

〇〇バッチ設計書

• [概要]
  1. 概要
  2. 入出力関連図
     • (XXXDB)→[処理]→[xxxx.csv]
  3. 入出力一覧
     • | システム名 | IN/OUT | データ区分 | 論理名 | 物理名 |
• [処理詳細]
  • | 処理フロー図 | 処理詳細 |
• [XXX情報取得SQL]
• [XXX情報CSV]

50.単体テスト

〇〇バッチ_単体テスト仕様書

• [テスト項目] テスト項目数、設計書を記載しておく。
  • 結果集計
    
    • | 項目数 | OK | NG | NA | 保留 | 計 |
  • | クラス | メソッド | 引数 | 試験手順① | 試験手順② | 結果・確認内容 | 結果 | 障害No | 実施者 | 実施日 | 環境 | 備考 |

単体テスト障害管理票

• | タイトル | 記載日 | 起票者 | 対象テスト仕様書 | 試験項番 | 発生 | 原因 | 対応 | 担当者 | ステータス | 完了日 |

60.結合テスト仕様書

データパターンを作成して実施する。
日付×住所エリア×プラン×オプション×払込方法の全パターンなど

• [テスト項目]
  • テスト項目数、設計書を記載しておく。
  • | 大項目 | 中項目 | 小項目 | 試験手順① | 試験手順② | 結果・確認内容 | 結果 | 障害No | 実施者 | 実施日 | 環境 | 備考 |

80.移行設計

移行設計書

DB一覧、テーブル一覧、カラム一覧、に対しての移行要否と要件を整理、

• [概要]
  1. 概要
  2. DB一覧
     • | 論理名 | 物理名 | 移行要否 | 移行要件 |
  3. テーブル一覧
     • | 論理名 | 物理名 | 移行要否 | 移行要件 |
• [XXXDB]
  • カラム一覧
    • | 論理名 | 物理名 | 移行要否 | 移行要件 |

移行手順書

• [概要]
  1. 概要
  2. 移行資材（DDL・DML）
     • | ファイル名 | 論理名 | 処理詳細 |
• [移行手順]
  • | 移行手順フロー図 | 移行手順詳細 |
• [XXX情報取得SQL]
• [XXX情報CSV]