指定したSQLファイル(PL/pgSQL関数)に対して 機能設計書(インデント付き・親子構造あり) を生成する際に使用した プロンプトの例 です。
機能設計書生成用プロンプト(汎用)
次のSQLファイル(PL/pgSQL関数)をもとに、以下の形式で機能設計書を作成してください:
- 出力形式は **日本語のテキスト**
- 各項目は **箇条書き**
- 子要素には **インデント4スペース**
- 機能全体の目的、処理概要、使用テーブル、条件、出力内容、その他の構成を含む
【機能設計書のセクション】
1. 関数名
2. 関数の目的
3. 主な処理概要(番号付きの構造化された説明)
4. 主な使用テーブル
5. 検出ロジックの条件
6. 出力・登録内容
7. その他
--- 対象SQL ---
<<ここにSQL全文を貼り付け>>
この形式を流用すれば、他のSQL関数についても同様に構造的な機能設計書を生成できます。.txtファイルとしてダウンロードを要求してください。
TODO
コメントの内容を積極の取り込めるように指示をする。
テーブル設計書(日本語論理名付き)または、CREATE文も一緒に提供すれば、内容がもっと充実になるか確認が必要。
例
以下の PL/pgSQL 関数ファイル(create_function_***.sql)について、それぞれの「機能設計書」を作成してください。
【目的】
各関数が行う監査処理の目的・ロジック・対象データ・出力内容を明確にし、開発・運用・保守に役立つドキュメントを作成します。
【前提】
- 使用されるテーブル定義はすべて「ddl_create_table.sql」に記述されています。
- そのテーブル定義の **カラム名・日本語コメント・主キー** を必ず参照し、設計書の内容に反映してください。
- テーブル名に含まれる `_YYYYMM` は文字列ではなく年月フォーマットであり、実行時に該当年月(例:`202504`)に置換されて動的に使用されます。
【出力形式】
- 出力は日本語テキストの箇条書き形式(インデント4スペース)で作成
- ファイル名は以下の形式:機能設計書_<関数名>_v1.txt(例:機能設計書_abc_test1関数_v1.txt)
【設計書の構成項目】
1. 関数名
2. 関数の目的(どのようなログを分析・検出し、何を記録するか)
3. 主な処理概要(処理の流れを段階的に詳細記述)
4. 主な使用テーブルと項目(DDLコメントから意味を明確化)
5. 検出ロジックの条件(SQLのWHERE句やJOIN条件をベースに記載)
6. 出力・登録内容(監査記録や履歴に登録される項目と意味)
7. その他(動的テーブル使用、トランザクション制御など)
【対象関数ファイル】
- create_function_abc_test1.sql
- create_function_abc_test2.sql
- create_function_abc_test3.sql
- create_function_abc_test4.sql
- create_function_abc_test5.sql
【DDL定義ファイル】
- ddl_create_table.sql(PostgreSQL形式でCREATE TABLEとCOMMENT ONが定義されている)
【補足】
- 関数内部の `mySQL :=` に含まれるSQL文字列も読み取り、処理ロジック・フィルタ条件・JOIN構成を解析して設計書に反映してください。
コメント