name: 07-design-02-detail-design description: 詳細設計書を作成するためのスキルです。システム全体の構成図、機能・モジュール構成、画面設計、バッチ処理設計、業務ロジック・処理フロー詳細、プログラムファイルの詳細、設定ファイルの詳細をHTML形式で記載します。
フォルダ構成(必須)
- 詳細設計書は
07_Design/02_DetailDesign/html/配下にHTML形式で作成してください。 - これ以外の場所に詳細設計書を配置してはいけません。
書式・表示(必須)
- すべての詳細設計書はPCのEdgeブラウザで正しく表示できるHTML形式で作成してください。
- トップページのファイル名は必ず
07_Design/02_DetailDesign/html/index.htmlとしてください。 - 全ページでマテリアルデザインの配色・文字サイズを統一し、視認性・可読性を重視してください。
- UML・図の作成は、
umlスキルで作成して、HTMLのIMGタグで表示してください。
参照できる情報(必須)
- 詳細設計書は、以下の情報を必ず反映してください。
08_Project配下のソースコード
- これ以外の情報のみを根拠に設計書を作成してはいけません。
トップページ(index.html)の構成(必須)
- ページタイトルは「システム名 詳細設計書」としてください。
- 上部にシステム名・ロゴ・作成日付を必ず配置してください。
- 記載項目は以下の通りです。
- システム概要・前提条件
- 機能構成・モジュール構成
- 画面設計
- バッチ処理設計
- 業務ロジック・処理フロー詳細
- 使用フレームワーク・ライブラリ一覧
各項目の記載ルール(必須)
システム概要・前提条件
- システム全体の構成図
- 全体構成図としてクラス図とシーケンス図で全体像を示してください。
- 対象システムの概要説明
- 前提条件(利用環境、依存システム、制約事項)
機能構成・モジュール構成
- 機能一覧
- モジュール構成図
- 各モジュールの役割
- 処理単位の分割方針
画面設計
- 画面一覧
- 画面遷移図
- 各画面のレイアウト
- 入力項目仕様(型、桁数、バリデーション)
- 表示項目仕様
- エラーメッセージ仕様
バッチ処理設計
- バッチ一覧
- 実行タイミング
- 入出力データ
- 処理フロー
- リトライ・エラー処理
業務ロジック・処理フロー詳細
- 各機能の処理手順
- フローチャート
- 例外処理
- 分岐条件
- アルゴリズムの詳細
- 状態遷移図(必要に応じて)
禁止事項
- ルールに記載されていない独自の判断で内容を追加・削除・省略してはいけません。
- 配置場所・ファイル名・記載内容を勝手に変更してはいけません。
- 公開版の詳細設計書に「(暫定)」等の暫定表記を残したままにしてはいけません。
推奨事項
- ページ内の説明や表現は、誰が読んでも誤解しないよう具体的かつ簡潔に記載してください。
- 横断設計項目は基本設計書と用語を揃え、相互リンクを設定してください(例: 基本設計の各ページから本書の該当セクションへリンク)。
プログラムファイルの詳細ページ(必須)
- ファイルまたはモジュール毎の詳細には以下を必ず記載してください:
- ファイル概要
- 処理詳細
- 入出力仕様
- 例外・バリデーション仕様
- クラス図
- シーケンス図(必要に応じて)
- 不要な図がある場合は、その理由をページ内に明記してください。
- トップページへ戻るボタンを必ず設置してください。
- 設定ファイル詳細ページとデザイン・レイアウトを統一してください。
設定ファイルの詳細ページ(必須)
- プロジェクト内の全propertiesファイルを対象としてください。
- 各項目について「項目名」「値」「概要」を表形式で記載してください。
- ファイル概要・処理詳細をページ上部に記載してください。
- トップページへ戻るボタンを必ず設置してください。
- ファイル詳細ページとデザイン・レイアウトを統一してください。
クラス図・シーケンス図生成ルール(必須)
- UMLの作成ルールについては、
umlスキルを参照してください。
役割分担・重複回避(必須)
- 本書(詳細設計)は「実装の正」とし、以下を詳細に記載します。
- クラス/メソッドの振る舞い、I/O仕様、例外/バリデーションの詳細、ログ出力の具体形式、終了コードの発生条件。
- 「基本設計書」は横断方針・全体像を正とし、同内容の再定義は行いません。必要があれば基本設計への参照リンクを付すこと。
- 同一内容を両設計書に重複記載しないでください(片方に定義し、もう片方は参照)。
禁止事項
- ルールに記載されていない独自の判断で内容を追加・削除・省略してはいけません。
- 配置場所・ファイル名・記載内容を勝手に変更してはいけません。