Skip to content

Commit

Permalink
update modal document (#174)
Browse files Browse the repository at this point in the history
  • Loading branch information
@ma91n
ma91n authored Sep 25, 2024
1 parent 2655c9d commit a42dca5
Show file tree
Hide file tree
Showing 11 changed files with 52 additions and 107 deletions.
6 changes: 3 additions & 3 deletions documents/forMarkdown/future_muscle_partner/docs/01_画面/UIM01/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@

機能目的:

- xxx
- ログインや会員登録導線を提供する

機能概要:

- xxx
- xxx
- ログイン処理
- 会員登録への導線

## イベント概要

Expand Down
27 changes: 22 additions & 5 deletions documents/forMarkdown/future_muscle_partner/docs/01_画面/UIM02/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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）表示
15 changes: 10 additions & 5 deletions documents/forMarkdown/future_muscle_partner/docs/01_画面/UIM03/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,27 @@

機能目的:

- xxx
- トレーニーやパーソナルトレーナの空き時間を表示し、予約を行えるようにする

機能概要:

- xxx
- xxx
- 本日以降の週間カレンダーを表示する
- すでに予約済みの時間がわかるようにする

## イベント概要

| No | イベント名 | イベント分類 | 処理説明 |
|----|-----------|--------|-------------------------------------|
| 1 | 初期表示 | 初期表示 | xxxx |
| 2 | xxx | ボタン押下 | xxx |
| 2 | 日時設定 | カレンダーを選択 | xxx |
| 3 | 日時指定 | 設定された日時で予約を指定する | xxx |

## イベント詳細

### 1. 初期表示

### 2. xxx
### 2. 日時設定

### 3. 日時指定

UIM04 を起動する。
14 changes: 9 additions & 5 deletions documents/forMarkdown/future_muscle_partner/docs/01_画面/UIM04/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,26 @@

機能目的:

- xxx
- トレーニング予約内容を表示し、決済によって確定する

機能概要:

- xxx
- xxx
- トレーニングのコース／日時／料金を表示
- クレジット決済に必要な項目の入力
- 決済の確定

## イベント概要

| No | イベント名 | イベント分類 | 処理説明 |
|----|-----------|--------|-------------------------------------|
| 1 | 初期表示 | 初期表示 | xxxx |
| 2 | xxx | ボタン押下 | xxx |
| 2 | 日時指定に戻る | ボタン押下 | xxx |
| 2 | 決済する | ボタン押下 | xxx |

## イベント詳細

### 1. 初期表示

### 2. xxx
### 2. 日時指定に戻る

### 3. 決済
8 changes: 3 additions & 5 deletions documents/forMarkdown/future_muscle_partner/docs/01_画面/UIS01/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,15 @@
| 1 | 初期表示 | 初期表示 | ログイン済みである場合、「会員登録／ログイン」が「マイページ」に変わる |
| 2 | トレーナーを探す | ボタン押下 | パーソナルトレーナー検索モーダル起動 |
| 3 | 会員登録／ログイン | ボタン押下 | ログインモーダル起動 |
| 4 | トレーナー検索 | ボタン押下 | 入力された条件で検索 |
| 5 | ログイン | ボタン押下 | ログインを実施 |

## イベント詳細

### 1. 初期表示

### 2. トレーナーを探す

### 3. 会員登録／ログイン
UIM02 呼び出し

### 4. トレーナー検索
### 3. 会員登録／ログイン

### 5. ログイン
UIM01 呼び出し
26 changes: 4 additions & 22 deletions documents/forMarkdown/future_muscle_partner/docs/01_画面/UIS02/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,8 @@
|----|----------|--------|--------------------------------|
| 1 | 初期表示 | 初期表示 | 初期検索条件に従いAPIを実行し、履歴表示する |
| 2 | トレーナーを探す | ボタン押下 | パーソナルトレーナー検索モーダル起動 |
| 3 | トレーナー検索 | ボタン押下 | 入力された条件で検索 |
| 4 | 受講完了確認 | ボタン押下 | 予約済みトレーニングを受講完了に切り替えるためのモーダル起動 |
| 5 | 受講完了 | ボタン押下 | 予約済みトレーニングを完了済みのトレーニングに更新 |
| 3 | 受講完了確認 | ボタン押下 | 予約済みトレーニングを受講完了に切り替えるためのモーダル起動 |
| 4 | 受講完了 | ボタン押下 | 予約済みトレーニングを完了済みのトレーニングに更新 |

## イベント詳細

Expand Down Expand Up @@ -63,32 +62,15 @@

### 2. トレーナーを探す

「パーソナルトレーナー検索モーダル」を起動する。

### 3. トレーナー検索

利用API:

| ID | URL | Parameter |
| --- | --- | -- |
| API-007 | GET /trainers | モーダルに指定された値をクエリパラメータに設定する |

画面表示制御:

- 入力チェック
- favorite_gym_name, store_nameが未設定の場合は、フロントエンド側でチェックし「行きつけのジム名・店舗名は必須項目です」と表示する
- 応答が0件の場合
- 「条件に一致するコーチは存在しませんでした」と表示する
- HTTPステータスが200以外
- メッセージID（MSG_BIZ_111）表示
UIM02 を起動。

### 3. 受講完了確認

「`${トレーニングメニュー}` は完了しましたか？」ダイアログを表示する。

キャンセルの場合は閉じる。

### 3. 受講完了
### 4. 受講完了

「`${トレーニングメニュー}` は完了しましたか？」ダイアログがOKの場合。

Expand Down
15 changes: 1 addition & 14 deletions documents/forMarkdown/future_muscle_partner/docs/01_画面/UIS04/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@
|--- |-----------------------------------------|---------------|------------------------------------------------|
| 1 | 初期表示 | 初期表示 | 初期検索条件に従いAPIを実行し、履歴表示する |
| 2 | トレーニングコース決定 | ボタン押下 | カレンダーを起動 |
| 3 | 日時指定 | ボタン押下 | カレンダー操作し日時を指定する |
| 4 | 日時再指定 | ボタン押下 | カレンダー操作し日時を指定する |
| 5 | 決済 | ボタン押下 | 決済し予約を確定する |

## イベント詳細

Expand All @@ -29,14 +26,4 @@ xxx

### 2. トレーニングコース決定

### 3. 日時指定

xxx

### 4. 日時再指定

xxx

### 5. 決済

xxx
UIM03 を起動する。
21 changes: 0 additions & 21 deletions documents/forMarkdown/future_muscle_partner/docs/04_IF/README.md
View file

This file was deleted.

12 changes: 0 additions & 12 deletions documents/forMarkdown/future_muscle_partner/docs/05_バッチ/README.md
View file

This file was deleted.

12 changes: 0 additions & 12 deletions documents/forMarkdown/future_muscle_partner/docs/05_帳票/README.md
View file

This file was deleted.

3 changes: 0 additions & 3 deletions documents/forMarkdown/future_muscle_partner/docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down

0 comments on commit a42dca5

Please sign in to comment.