Skip to content

Latest commit

 

History

History
72 lines (55 loc) · 4.84 KB

Home.md

File metadata and controls

72 lines (55 loc) · 4.84 KB

詳細設計

要件定義 / 基本設計 / 詳細設計
基本:共通仕様 / 機能一覧 / テーブル一覧 / 画面一覧 / 画面遷移
詳細:テーブル定義書 / 画面定義書 / イベント仕様書

本書以下の成果物が、コーディング・エージェントへ渡す実装入力である。

成果物

成果物 内容 作成範囲
共通仕様 ID 体系・用語集・PRE-* / VAL-* / ERR-*・共通画面仕様 全モジュール
テーブル定義書 全 14 テーブルの列定義・キー・業務ルール 全モジュール
画面定義書 画面項目・アクションボタン・イベント一覧 受注管理
イベント仕様書 イベント単位の処理内容・検証・エラーハンドリング 受注管理

実装に着手する前に読むもの

順 成果物 目的
1 共通仕様 ID 体系と、全画面・全イベントに共通する規約を把握する。個別の仕様書はここを参照している前提で書かれている
2 テーブル定義書 扱うデータの構造と業務ルールを把握する
3 画面定義書 対象画面の項目・ボタン・イベントの全体像を把握する
4 イベント仕様書 イベント単位の処理を実装する

作成状況

モジュール テーブル定義書 画面定義書 イベント仕様書
受注管理(ORD) 作成済 作成済 作成済
顧客管理(CUS) 作成済 未作成 未作成
商品管理(PRD) 作成済 未作成 未作成
仕入先管理(SUP) 作成済 未作成 未作成
担当者管理(EMP) 作成済 未作成 未作成
配送管理(SHP) 作成済 未作成 未作成
売上分析(SLS) - 未作成 未作成
在庫分析(INV) - 未作成 未作成
パフォーマンス分析(PRF) 作成済 未作成 未作成

受注管理を先行して詳細化し、記載レベルの型を確定させたうえで他モジュールへ横展開する方針。 売上分析・在庫分析は専用テーブルを持たないため、テーブル定義書の作成対象外(既存テーブルを集計する)。

記載レベルの基準

詳細設計は「行間を残さない」ことを基準とする。具体的には次を満たすこと。

# 基準
1 画面項目には、データソース(テーブル.列 または算出式)と制約を必ず記す
2 算出項目は式で示す(「合計を表示する」ではなく 合計 = 小計 + 送料)
3 イベントの処理内容は番号付きの手順とし、DB アクセスは対象テーブル・結合・抽出条件・並び順・件数まで記す
4 検証内容とエラーハンドリングは、共通仕様の ID を参照したうえで個別分を列挙する
5 更新系イベントはトランザクション境界と楽観排他の判定方法を明記する
6 分岐(モード・状態・NULL の有無)はすべて記述し、実装者に判断を委ねない

イベント仕様書の項目構成は次で固定する(元ネタの記載レベルに準拠)。

イベント概要 / トリガー条件 / 事前条件 / 入力 / 出力 / 処理内容 / 検証内容 / エラーハンドリング / 依存関係

実装スコープの制限

共通仕様 1 節のとおり、次は実装しない。設計書に登場しないものを推測で作らないこと。

  • ワークテーブル、採番テーブル(採番は IDENTITY)
  • 変更履歴・監査ログ、論理削除
  • 非同期処理(帳票・印刷を含む)、ジョブ、キュー
  • データ・キャッシュ層
  • ドメイン駆動設計(DDD)に基づく戦術的パターン
  • 認証・認可(要件定義 3.2)