画面仕様書
一覧、詳細、登録、編集、検索、ボタン、権限を画面単位で整理します。
画面仕様書は、業務システムの各画面で何を表示し、何を入力し、どの操作を許可するかを画面単位で整理するためのドキュメントです。Roundtableでは、一覧、詳細、登録、編集、検索、ボタン、権限、公開側との違いを同じ形式でまとめ、発注者、実装者、AIに指示する人が同じ画面イメージを見ながら実装範囲を確認できます。
この機能でできること
画面名、利用者、表示項目、入力項目、検索条件、ページボタン、行ボタン、ダイアログ、サイドパネル、権限、公開側で見せる範囲を整理できます。画面ごとに仕様を分けることで、DB項目、一覧、フォーム、通知、CSV/PDF、権限の実装範囲を確認しやすくなります。
「どの画面で何ができるか」を実装前に揃えます。
画面単位で一覧、詳細、登録、編集、検索、ボタン、権限を確認しておくと、標準画面で足りる範囲と、個別実装が必要な範囲を分けやすくなります。
よくある利用場面
新規画面の実装前確認
顧客一覧、案件詳細、申込登録、請求編集など、画面ごとに表示項目と操作を決めます。
管理側と公開側の切り分け
管理者だけが編集する項目、公開ユーザーにも見せる項目、公開フォームで入力させる項目を分けます。
権限やボタンの確認
ロールごとに表示、追加、編集、削除、CSV、通知、承認などの操作可否を確認します。
プロンプト例
対象画面、利用者、表示項目、検索条件、操作ボタン、権限、管理側と公開側の違いをまとめて伝えると、実装に使いやすい画面仕様書になります。
プロンプト
案件管理に画面仕様書を追加してください。顧客一覧、案件一覧、案件詳細、案件登録、案件編集、対応履歴、公開問い合わせフォームについて、画面名、目的、利用者、表示項目、入力項目、検索条件、ページボタン、行ボタン、ダイアログ、サイドパネル、権限、管理側と公開側の違いを画面単位で整理してください。実装者が標準画面で作る範囲と個別実装が必要な範囲を判断できる内容にしてください。
この機能を使うときのポイント
画面の目的一覧で探す画面、詳細を見る画面、登録する画面、承認する画面など、役割を先に分けます。
表示項目と入力項目見るだけの項目、入力する項目、自動計算する項目、非表示で保存する項目を分けます。
操作ボタンページボタン、行ボタン、ダイアログ内ボタン、一括操作ボタンを画面ごとに確認します。
権限と公開範囲管理者、担当者、閲覧者、公開ユーザーで、表示や編集の可否が変わる部分を明示します。
この機能を実装するときのコツ
実装では、画面定義を画面名、対象テーブル、表示項目、検索条件、ボタン、権限、補足仕様に分けて保存できる形にすると扱いやすくなります。標準画面で実装する画面は screen_fields、検索、db_additionals、post_action_class へつなげ、公開ページや特殊なUIが必要な画面は別途 public_pages や Original Screen の対象として切り分けます。画面仕様書から直接、テストケースやAIへの追加指示に展開できる粒度で残すのが実用的です。