残業しないための詳細設計書作成AIプロンプト集
はじめに
詳細設計書の作成は時間がかかる作業ですが、適切なAIプロンプトを使うことで効率化できます。
本記事では、実際の企業フォーマットを想定した詳細設計書作成のプロンプト例を紹介します。
1. 詳細設計書の基本構成
1.1 目的と範囲
プロンプト例:
以下の仕様について詳細設計書を作成してください。
【システム名】顧客管理システム
【対象機能】顧客情報登録機能
【目的】
- 顧客情報を正確に登録・管理する
- データの整合性を保つ
- セキュリティを確保する
【範囲】
- 画面設計
- データベース設計
- API設計
- エラーハンドリング
形式は以下の企業標準フォーマットに従ってください。
- 章番号は「1.」「1.1」「1.1.1」の形式
- 各項目間は4行空白
- 一文一行で記載
1.2 画面設計のプロンプト
プロンプト例:
顧客情報登録画面の詳細設計を作成してください。
【要件】
- 入力項目:顧客名、メールアドレス、電話番号、住所
- バリデーション:必須チェック、形式チェック
- ボタン:登録、キャンセル
【出力形式】
1. 画面レイアウト(テキストベース)
2. 入力項目定義(項目名、型、桁数、必須/任意)
3. バリデーションルール
4. 画面遷移図(テキストベース)
5. エラーメッセージ一覧
各セクション間は4行空白を入れてください。
1.3 データベース設計のプロンプト
プロンプト例:
顧客情報テーブルの詳細設計を作成してください。
【要件】
- テーブル名:customers
- 主キー:customer_id
- 保存項目:顧客名、メール、電話、住所、登録日時、更新日時
【出力形式】
以下の形式でテーブル定義書を作成:
テーブル名: customers
| 論理名 | 物理名 | データ型 | 桁数 | NULL | デフォルト | 備考 |
|--------|--------|----------|------|------|------------|------|
その後、以下を記載:
1. 主キー定義
2. インデックス定義
3. 外部キー制約
4. CHECK制約
各セクションは4行空白で区切ってください。
1.4 API設計のプロンプト
プロンプト例:
顧客情報登録APIの詳細設計を作成してください。
【要件】
- エンドポイント:POST /api/customers
- 認証:JWT認証
- リクエスト:JSON形式
- レスポンス:JSON形式
【出力形式】
1. API概要
2. リクエスト仕様
- HTTPメソッド
- URL
- ヘッダー
- ボディ(JSONスキーマ)
3. レスポンス仕様
- 成功時(200)
- エラー時(400, 401, 500)
4. シーケンス図(テキストベース)
5. エラーハンドリング
一文一行で記載し、各セクション間は4行空白を入れてください。
1.5 テストケース設計のプロンプト
プロンプト例:
顧客情報登録機能のテストケースを作成してください。
【要件】
- 正常系テスト
- 異常系テスト(バリデーションエラー、権限エラー等)
- 境界値テスト
【出力形式】
以下の形式でテストケース一覧を作成:
| No. | テスト項目 | 入力値 | 期待結果 | 優先度 |
|-----|------------|--------|----------|--------|
その後、以下を記載:
1. テスト環境
2. 前提条件
3. テストデータ
4. 実施手順(代表的なケース)
各セクションは4行空白で区切り、一文一行で記載してください。
2. 実践的な応用プロンプト
2.1 既存ドキュメントからの設計書生成
プロンプト例:
以下の要件定義書から詳細設計書を生成してください。
【要件定義書】
(ここに要件定義の内容を貼り付け)
【出力】
当社標準フォーマットに従って以下を作成:
1. 画面設計
2. データベース設計
3. API設計
4. 処理フロー
5. エラーハンドリング
フォーマット規則:
- 章番号は1., 1.1, 1.1.1形式
- 各章の間は4行空白
- 一文一行
- 箇条書きは「・」を使用
2.2 レビュー指摘事項の反映
プロンプト例:
以下の詳細設計書に対するレビュー指摘を反映してください。
【現在の設計書】
(ここに設計書を貼り付け)
【レビュー指摘事項】
1. セキュリティ考慮が不足している
2. エラーハンドリングが具体的でない
3. 性能要件が明記されていない
【出力】
指摘事項を反映した改訂版を作成してください。
変更箇所には「【変更】」マークを付けてください。
当社フォーマット(4行空白、一文一行)を維持してください。
2.3 複数機能の一括設計
プロンプト例:
以下の機能群について、統一フォーマットで詳細設計書を作成してください。
【機能一覧】
1. 顧客登録機能
2. 顧客検索機能
3. 顧客更新機能
4. 顧客削除機能
【共通仕様】
- 認証:JWT
- データベース:PostgreSQL
- フレームワーク:Spring Boot
【出力】
各機能について以下を作成:
- 画面設計
- API設計
- データフロー
- エラーハンドリング
全機能で章番号体系を統一し、4行空白ルールを適用してください。
3. フォーマット統一のためのプロンプト
3.1 既存ドキュメントのフォーマット修正
プロンプト例:
以下のドキュメントを当社標準フォーマットに変換してください。
【変換ルール】
1. 章番号を「1.」「1.1」「1.1.1」形式に統一
2. 各章の間に4行の空白を挿入
3. 一文を一行で記載(長文は適切に分割)
4. 表形式はMarkdown記法を使用
5. 箇条書きは「・」または「-」を使用
【元ドキュメント】
(ここにドキュメントを貼り付け)
4. 時短テクニック
4.1 テンプレート生成プロンプト
プロンプト例:
以下の条件で詳細設計書のテンプレートを作成してください。
【プロジェクト情報】
- システム名:○○システム
- サブシステム名:△△サブシステム
- 機能名:(後で入力)
【テンプレート構成】
1. 概要
2. 画面設計
3. データベース設計
4. API設計
5. 処理フロー
6. エラーハンドリング
7. 非機能要件
8. テストケース
各セクションに記入例を含めてください。
4行空白、一文一行のルールを適用してください。
4.2 差分更新プロンプト
プロンプト例:
既存の詳細設計書を以下の変更内容で更新してください。
【既存設計書】
(ここに既存設計書を貼り付け)
【変更内容】
- 項目追加:生年月日フィールドを追加
- 変更:電話番号を任意項目に変更
- 削除:FAX番号フィールドを削除
【出力】
変更箇所のみを明示した差分版を作成してください。
変更箇所には「【追加】」「【変更】」「【削除】」マークを付けてください。
フォーマットは既存設計書と同じにしてください。
5. まとめ
これらのプロンプトを活用することで、詳細設計書作成の時間を大幅に削減できます。
重要なポイントは以下の通りです。
・会社の標準フォーマットをプロンプトに明記する
・一度作成したプロンプトをテンプレート化する
・レビュー指摘の反映もAIに任せる
・複数機能は一括で設計する
ぜひ自社のフォーマットに合わせてカスタマイズしてご活用ください。