From a42dca578a900359f44957465be383e767250434 Mon Sep 17 00:00:00 2001 From: Junki Mano Date: Wed, 25 Sep 2024 15:00:10 +0900 Subject: [PATCH] update modal document (#174) --- .../UIM01/README.md" | 6 ++--- .../UIM02/README.md" | 27 +++++++++++++++---- .../UIM03/README.md" | 15 +++++++---- .../UIM04/README.md" | 14 ++++++---- .../UIS01/README.md" | 8 +++--- .../UIS02/README.md" | 26 +++--------------- .../UIS04/README.md" | 15 +---------- .../docs/04_IF/README.md | 21 --------------- .../README.md" | 12 --------- .../05_\345\270\263\347\245\250/README.md" | 12 --------- .../future_muscle_partner/docs/README.md | 3 --- 11 files changed, 52 insertions(+), 107 deletions(-) delete mode 100644 documents/forMarkdown/future_muscle_partner/docs/04_IF/README.md delete mode 100644 "documents/forMarkdown/future_muscle_partner/docs/05_\343\203\220\343\203\203\343\203\201/README.md" delete mode 100644 "documents/forMarkdown/future_muscle_partner/docs/05_\345\270\263\347\245\250/README.md" diff --git "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIM01/README.md" "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIM01/README.md" index 22d7c078..e736e8ed 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIM01/README.md" +++ "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIM01/README.md" @@ -4,12 +4,12 @@ 機能目的: -- xxx +- ログインや会員登録導線を提供する 機能概要: -- xxx -- xxx +- ログイン処理 +- 会員登録への導線 ## イベント概要 diff --git "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIM02/README.md" "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIM02/README.md" index 51f66870..4c0bfcba 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIM02/README.md" +++ "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIM02/README.md" @@ -4,22 +4,39 @@ 機能目的: -- xxx +- パーソナルトレーナーを検索する 機能概要: -- xxx -- xxx +- 行きつけのジムの絞り込み +- 店舗名の検索 +- トレーニング時間／予算の絞り込み +- トレーニングコースの絞り込み ## イベント概要 | No | イベント名 | イベント分類 | 処理説明 | |----|-----------|--------|-------------------------------------| | 1 | 初期表示 | 初期表示 | xxxx | -| 2 | xxx | ボタン押下 | xxx | +| 2 | 検索 | 検索ボタン押下 | xxx | ## イベント詳細 ### 1. 初期表示 -### 2. トレーナーを探す +### 2. 検索 + +利用API: + +| ID | URL | Parameter | +| --- | --- | -- | +| API-007 | GET /trainers | モーダルに指定された値をクエリパラメータに設定する | + +画面表示制御: + +- 入力チェック + - favorite_gym_name, store_nameが未設定の場合は、フロントエンド側でチェックし「行きつけのジム名・店舗名は必須項目です」と表示する +- 応答が0件の場合 + - 「条件に一致するコーチは存在しませんでした」と表示する +- HTTPステータスが200以外 + - メッセージID（MSG_BIZ_111）表示 diff --git "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIM03/README.md" "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIM03/README.md" index 693fc229..a6a9e575 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIM03/README.md" +++ "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIM03/README.md" @@ -4,22 +4,27 @@ 機能目的: -- xxx +- トレーニーやパーソナルトレーナの空き時間を表示し、予約を行えるようにする 機能概要: -- xxx -- xxx +- 本日以降の週間カレンダーを表示する +- すでに予約済みの時間がわかるようにする ## イベント概要 | No | イベント名 | イベント分類 | 処理説明 | |----|-----------|--------|-------------------------------------| | 1 | 初期表示 | 初期表示 | xxxx | -| 2 | xxx | ボタン押下 | xxx | +| 2 | 日時設定 | カレンダーを選択 | xxx | +| 3 | 日時指定 | 設定された日時で予約を指定する | xxx | ## イベント詳細 ### 1. 初期表示 -### 2. xxx +### 2. 日時設定 + +### 3. 日時指定 + +UIM04 を起動する。 diff --git "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIM04/README.md" "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIM04/README.md" index 95ee61bd..2c6e5b0c 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIM04/README.md" +++ "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIM04/README.md" @@ -4,22 +4,26 @@ 機能目的: -- xxx +- トレーニング予約内容を表示し、決済によって確定する 機能概要: -- xxx -- xxx +- トレーニングのコース／日時／料金を表示 +- クレジット決済に必要な項目の入力 +- 決済の確定 ## イベント概要 | No | イベント名 | イベント分類 | 処理説明 | |----|-----------|--------|-------------------------------------| | 1 | 初期表示 | 初期表示 | xxxx | -| 2 | xxx | ボタン押下 | xxx | +| 2 | 日時指定に戻る | ボタン押下 | xxx | +| 2 | 決済する | ボタン押下 | xxx | ## イベント詳細 ### 1. 初期表示 -### 2. xxx +### 2. 日時指定に戻る + +### 3. 決済 diff --git "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS01/README.md" "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS01/README.md" index c8a75dd9..9323ab16 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS01/README.md" +++ "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS01/README.md" @@ -18,8 +18,6 @@ | 1 | 初期表示 | 初期表示 | ログイン済みである場合、「会員登録／ログイン」が「マイページ」に変わる | | 2 | トレーナーを探す | ボタン押下 | パーソナルトレーナー検索モーダル起動 | | 3 | 会員登録／ログイン | ボタン押下 | ログインモーダル起動 | -| 4 | トレーナー検索 | ボタン押下 | 入力された条件で検索 | -| 5 | ログイン | ボタン押下 | ログインを実施 | ## イベント詳細 @@ -27,8 +25,8 @@ ### 2. トレーナーを探す -### 3. 会員登録／ログイン +UIM02 呼び出し -### 4. トレーナー検索 +### 3. 会員登録／ログイン -### 5. ログイン +UIM01 呼び出し diff --git "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS02/README.md" "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS02/README.md" index 69b89831..8818ecd5 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS02/README.md" +++ "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS02/README.md" @@ -17,9 +17,8 @@ |----|----------|--------|--------------------------------| | 1 | 初期表示 | 初期表示 | 初期検索条件に従いAPIを実行し、履歴表示する | | 2 | トレーナーを探す | ボタン押下 | パーソナルトレーナー検索モーダル起動 | -| 3 | トレーナー検索 | ボタン押下 | 入力された条件で検索 | -| 4 | 受講完了確認 | ボタン押下 | 予約済みトレーニングを受講完了に切り替えるためのモーダル起動 | -| 5 | 受講完了 | ボタン押下 | 予約済みトレーニングを完了済みのトレーニングに更新 | +| 3 | 受講完了確認 | ボタン押下 | 予約済みトレーニングを受講完了に切り替えるためのモーダル起動 | +| 4 | 受講完了 | ボタン押下 | 予約済みトレーニングを完了済みのトレーニングに更新 | ## イベント詳細 @@ -63,24 +62,7 @@ ### 2. トレーナーを探す -「パーソナルトレーナー検索モーダル」を起動する。 - -### 3. トレーナー検索 - -利用API: - -| ID | URL | Parameter | -| --- | --- | -- | -| API-007 | GET /trainers | モーダルに指定された値をクエリパラメータに設定する | - -画面表示制御: - -- 入力チェック - - favorite_gym_name, store_nameが未設定の場合は、フロントエンド側でチェックし「行きつけのジム名・店舗名は必須項目です」と表示する -- 応答が0件の場合 - - 「条件に一致するコーチは存在しませんでした」と表示する -- HTTPステータスが200以外 - - メッセージID（MSG_BIZ_111）表示 +UIM02 を起動。 ### 3. 受講完了確認 @@ -88,7 +70,7 @@ キャンセルの場合は閉じる。 -### 3. 受講完了 +### 4. 受講完了 「`${トレーニングメニュー}` は完了しましたか？」ダイアログがOKの場合。 diff --git "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS04/README.md" "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS04/README.md" index 564529a5..5bd8ea96 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS04/README.md" +++ "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS04/README.md" @@ -17,9 +17,6 @@ |--- |-----------------------------------------|---------------|------------------------------------------------| | 1 | 初期表示 | 初期表示 | 初期検索条件に従いAPIを実行し、履歴表示する | | 2 | トレーニングコース決定 | ボタン押下 | カレンダーを起動 | -| 3 | 日時指定 | ボタン押下 | カレンダー操作し日時を指定する | -| 4 | 日時再指定 | ボタン押下 | カレンダー操作し日時を指定する | -| 5 | 決済 | ボタン押下 | 決済し予約を確定する | ## イベント詳細 @@ -29,14 +26,4 @@ xxx ### 2. トレーニングコース決定 -### 3. 日時指定 - -xxx - -### 4. 日時再指定 - -xxx - -### 5. 決済 - -xxx +UIM03 を起動する。 diff --git a/documents/forMarkdown/future_muscle_partner/docs/04_IF/README.md b/documents/forMarkdown/future_muscle_partner/docs/04_IF/README.md deleted file mode 100644 index c7d881f3..00000000 --- a/documents/forMarkdown/future_muscle_partner/docs/04_IF/README.md +++ /dev/null @@ -1,21 +0,0 @@ -# システムI/F - -::: warning 注意 - -[サンプル定義書](../../../IF定義書.md)と同様のため、各I/F設計書の例示は省略する - -::: - -## 送信I/F - -| ID | 名称 | 備考 | -| ---| --- | --- | -| IFS01 | xxx | xxx | -| IFS02 | xxx | xxx | - -## 受信I/F - -| ID | 名称 | 備考 | -| ---| --- | --- | -| IFR01 | xxx | xxx | -| IFR02 | xxx | xxx | diff --git "a/documents/forMarkdown/future_muscle_partner/docs/05_\343\203\220\343\203\203\343\203\201/README.md" "b/documents/forMarkdown/future_muscle_partner/docs/05_\343\203\220\343\203\203\343\203\201/README.md" deleted file mode 100644 index 4171a1bb..00000000 --- "a/documents/forMarkdown/future_muscle_partner/docs/05_\343\203\220\343\203\203\343\203\201/README.md" +++ /dev/null @@ -1,12 +0,0 @@ -# バッチ - -::: warning 注意 - -[サンプル定義書](../../../プログラム設計書.md)と同様のため、各設計書の例示は省略する - -::: - -| ID | 名称 | 備考 | -| ---| --- | --- | -| BAT01 | xxx | xxx | -| BAT02 | xxx | xxx | diff --git "a/documents/forMarkdown/future_muscle_partner/docs/05_\345\270\263\347\245\250/README.md" "b/documents/forMarkdown/future_muscle_partner/docs/05_\345\270\263\347\245\250/README.md" deleted file mode 100644 index e6d5d602..00000000 --- "a/documents/forMarkdown/future_muscle_partner/docs/05_\345\270\263\347\245\250/README.md" +++ /dev/null @@ -1,12 +0,0 @@ -# 帳票 - -::: warning 注意 - -帳票で定義すべきことは、バッチやI/Fの定義書に近いのため、各設計書の例示は省略する - -::: - -| ID | 名称 | 備考 | -| ---| --- | --- | -| RPT01 | xxx | xxx | -| RPT02 | xxx | xxx | diff --git a/documents/forMarkdown/future_muscle_partner/docs/README.md b/documents/forMarkdown/future_muscle_partner/docs/README.md index ab7cbe7c..25d11531 100644 --- a/documents/forMarkdown/future_muscle_partner/docs/README.md +++ b/documents/forMarkdown/future_muscle_partner/docs/README.md @@ -9,9 +9,6 @@ docs ├── 01_画面 # Figma、画面アクション ├── 02_WebAPI # openapi.yaml、API処理設計 ├── 03_データ # erd.a5er（ERD）、区分値 -├── 04_IF送信 # I/F定義＋送信BL設計 -├── 05_IF受信 # I/F定義＋受信BL設計 -├── 06_バッチ # タイマー、イベント起動の非同期処理のBL設計 ├── ... └── README.md ```