設計の覚書き

• 基本設計
• クラス図
• 画面定義書
• API定義書
• 帳票定義書
• IF定義書
• バッチ定義書
• コード定義書
• 物理データモデル
• 詳細設計

基本設計

前提：先にアーキテクチャ設計が済んでいること。

項目定義は共通一覧があるとよい。

クラス図

共通機能の定義ができるとよい。

画面定義書

• 画面レイアウト
• 画面項目(論理名・物理名・タイプ・初期値・placeholder・必須・データ型・フォーマット)
• イベント一覧(イベント・処理順・処理詳細・API名)
• バリデーション(単項目フォーマット・必須・複合条件・エラー条件・メッセージKey/パラメータ)
• (APIによるバックエンド処理でない場合)シーケンス図(画面・DB・外部システム)
• 表示制御マトリクス

API定義書

Swaggerが良い。

• API名
• URL
• 入力項目
  • パスパラメータ(論理名・物理名・データ型)
  • ボディパラメータ(論理名・物理名・データ型・階層)
• 出力項目(論理名・物理名・データ型・階層)
• シーケンス図(画面・API・DB・外部システム)
• バリデーション(単項目フォーマット・必須、複合条件)
• エラーメッセージ(メッセージCD・概要)

帳票定義書

• 帳票レイアウト
• 帳票項目(論理名・物理名・フォーマット・配置)

IF定義書

• 連携種別(FTP/API/DB/など)
• タイミング
• 文字コード
• 概要
• サンプルデータ
• 項目定義(論理名・物理名・型・フォーマット)

バッチ定義書

• 起動タイミング
• 起動方式
• シーケンス図

コード定義書

• コード詳細(ID・値・概要)

物理データモデル

• ER図
• テーブル一覧
• テーブル定義書(テーブル名・制約・論理名・物理名・データ型・必須・デフォルト・インデックス)
• シーケンス一覧

詳細設計

クラス図・シーケンス図に従い、プログラム仕様書を記載する。
ソースとテストコードでこれが表現できればベスト。