Skip to main content

​
仕様書の読み方・確認ガイド

AIとの対話後に生成される仕様書は、アプリの設計図です。ビルド前に内容を確認することで、意図と異なる実装を防げます。このガイドでは、非エンジニアの方でも仕様書を理解できるよう解説します。

​
仕様書の構成

仕様書は以下のセクションで構成されています。
セクション内容確認の重要度
データモデルアプリで扱うデータの構造⭐⭐⭐ 高
ルーティング画面の一覧と遷移⭐⭐⭐ 高
コンポーネント画面の部品定義⭐⭐ 中
ワークフロー処理の流れ（API）⭐⭐ 中
テーマデザイン設定⭐ 低
言語・地域多言語設定⭐ 低

​
各セクションの読み方

​
データモデル（最重要）

データモデルは、アプリで扱うデータの構造を定義します。Excelの表をイメージすると分かりやすいです。 例：顧客データモデル 
顧客（Customer）
├── id: 一意のID（自動生成）
├── company_name: 会社名（テキスト、必須）
├── contact_name: 担当者名（テキスト、必須）
├── email: メールアドレス（メール形式、必須）
├── phone: 電話番号（テキスト）
├── status: ステータス（選択肢：見込み/商談中/成約/失注）
├── created_at: 作成日時（自動）
└── updated_at: 更新日時（自動）
伝えた要件に含まれる項目がすべて定義されているか確認しましょう。チェック例：
  • ✅ 会社名がある
  • ✅ 担当者名がある
  • ❌ 住所がない → 必要なら追加を依頼
必須項目（入力しないと登録できない）と任意項目（空でもOK）の設定を確認しましょう。よくある修正：
  • 「電話番号は任意にして」
  • 「メールアドレスは必須にして」
ステータスやカテゴリなどの選択肢が、実際の業務フローと合っているか確認しましょう。修正例： 「ステータスに『保留』を追加して」

​
ルーティング（画面一覧）

ルーティングは、アプリにどんな画面があり、どのURLでアクセスできるかを定義します。 例：
パス画面名説明
/ダッシュボードトップページ
/customers顧客一覧顧客の一覧表示
/customers/new顧客登録新規顧客の登録
/customers/:id顧客詳細顧客の詳細表示
/customers/:id/edit顧客編集顧客情報の編集
要件で伝えた機能に対応する画面がすべてあるか確認しましょう。チェック例：
  • ✅ 一覧画面がある
  • ✅ 登録画面がある
  • ❌ レポート画面がない → 必要なら追加を依頼

​
ワークフロー（処理の流れ）

ワークフローは、データの登録・更新・削除などの処理を定義します。APIとも呼ばれます。 例：顧客登録ワークフロー 
顧客登録（createCustomer）
1. 入力データを受け取る
2. バリデーション（入力チェック）
   - 会社名が空でないこと
   - メールアドレスが正しい形式であること
3. データベースに保存
4. 登録完了を返す
  • 登録、編集、削除の処理があるか
  • 検索やフィルターの処理があるか
  • 集計やレポートの処理があるか

​
コンポーネント（画面部品）

コンポーネントは、画面を構成する部品（ボタン、入力フォーム、テーブルなど）を定義します。 例：顧客一覧テーブル 
顧客一覧テーブル（CustomerTable）
- 表示項目：会社名、担当者名、ステータス、登録日
- 操作ボタン：詳細、編集、削除
- 検索機能：会社名で検索
- ソート機能：登録日順
一覧画面やテーブルに表示される項目が、必要なものになっているか確認しましょう。

​
ビルド前の確認チェックリスト

以下のチェックリストを使って、ビルド前に仕様書を確認しましょう。
1

データモデルの確認

  • 必要なデータモデルがすべて定義されている
  • 各データモデルに必要な項目がある
  • 必須/任意の設定が正しい
  • 選択肢の内容が正しい
2

画面の確認

  • 必要な画面がすべて定義されている
  • 画面の遷移が自然である
  • ダッシュボードに必要な情報がある
3

機能の確認

  • 登録・編集・削除ができる
  • 検索・フィルターができる
  • 必要なレポート・集計がある
4

リンク切れチェック

チャットで以下を入力して、仕様書の整合性をチェックしましょう：
仕様書にリンク切れがないかチェックして

​
修正の依頼方法

仕様書に問題を見つけたら、AIに修正を依頼しましょう。

​
修正依頼の例

顧客データモデルに「住所」項目を追加して。任意項目でOK。

​
よくある質問

用語集で、仕様書に出てくる技術用語を解説しています。参照しながら確認してください。
最低限確認すべき：
  • データモデルの項目
  • 画面の一覧
余裕があれば確認：
  • ワークフローの処理内容
  • コンポーネントの表示項目
細かい部分はビルド後にプレビューで確認し、修正することもできます。
まずはデータモデルと画面一覧だけ確認してビルドし、プレビューで動作を見てから修正する方法もあります。ただし、データモデルの大きな変更はビルドし直しになるため、データモデルは最初に確認することをおすすめします。

プロンプトウィザードの使い方

基本的な操作方法に戻る

プレビュー機能の使い方

ビルド後の確認方法