diff --git "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/README.md" "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/README.md" index e3b87d26..7426e49b 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/README.md" +++ "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/README.md" @@ -2,11 +2,20 @@ * Figma URL: xxx -## 画面一覧 +## 標準画面 | ID | 論理名 | 備考 | |--------------|----------|----| -| [UI01](UR01) | トップページ | | -| [UI02](UR02) | マイページ | | -| [UI03](UR03) | トレーナー一覧 | | -| [UI04](UR04) | トレーナー詳細 | | +| [UIS01](UIS01) | トップページ | | +| [UIS02](UIS02) | マイページ | | +| [UIS03](UIS03) | トレーナー一覧 | | +| [UIS04](UIS04) | トレーナー詳細 | | + +## モーダル画面 + +| ID | 論理名 | 備考 | +|--------------|----------|----| +| [UIM01](UIM01) | xxx | | +| [UIM02](UIM02) | xx | | +| [UIM03](UIM03) | xx | | +| [UIM04](UIM04) | xxx | | 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" new file mode 100644 index 00000000..22d7c078 --- /dev/null +++ "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIM01/README.md" @@ -0,0 +1,25 @@ +# [UIM01] ログイン + +## 概要 + +機能目的: + +- xxx + +機能概要: + +- xxx +- xxx + +## イベント概要 + +| No | イベント名 | イベント分類 | 処理説明 | +|----|-----------|--------|-------------------------------------| +| 1 | 初期表示 | 初期表示 | xxxx | +| 2 | xxx | ボタン押下 | xxx | + +## イベント詳細 + +### 1. 初期表示 + +### 2. 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" new file mode 100644 index 00000000..51f66870 --- /dev/null +++ "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIM02/README.md" @@ -0,0 +1,25 @@ +# [UIM02] トレーナー検索 + +## 概要 + +機能目的: + +- xxx + +機能概要: + +- xxx +- xxx + +## イベント概要 + +| No | イベント名 | イベント分類 | 処理説明 | +|----|-----------|--------|-------------------------------------| +| 1 | 初期表示 | 初期表示 | xxxx | +| 2 | xxx | ボタン押下 | xxx | + +## イベント詳細 + +### 1. 初期表示 + +### 2. トレーナーを探す 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" new file mode 100644 index 00000000..693fc229 --- /dev/null +++ "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIM03/README.md" @@ -0,0 +1,25 @@ +# [UIM03] カレンダー予約 + +## 概要 + +機能目的: + +- xxx + +機能概要: + +- xxx +- xxx + +## イベント概要 + +| No | イベント名 | イベント分類 | 処理説明 | +|----|-----------|--------|-------------------------------------| +| 1 | 初期表示 | 初期表示 | xxxx | +| 2 | xxx | ボタン押下 | xxx | + +## イベント詳細 + +### 1. 初期表示 + +### 2. xxx 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" new file mode 100644 index 00000000..95ee61bd --- /dev/null +++ "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIM04/README.md" @@ -0,0 +1,25 @@ +# [UIM04] 決済 + +## 概要 + +機能目的: + +- xxx + +機能概要: + +- xxx +- xxx + +## イベント概要 + +| No | イベント名 | イベント分類 | 処理説明 | +|----|-----------|--------|-------------------------------------| +| 1 | 初期表示 | 初期表示 | xxxx | +| 2 | xxx | ボタン押下 | xxx | + +## イベント詳細 + +### 1. 初期表示 + +### 2. xxx diff --git "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UI01/UI01.md" "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS01/README.md" similarity index 97% rename from "documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UI01/UI01.md" rename to "documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS01/README.md" index abf8c0dd..c8a75dd9 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UI01/UI01.md" +++ "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS01/README.md" @@ -1,4 +1,4 @@ -# [UI01] トップページ +# [UIS01] トップページ ## 概要 diff --git "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UI02/UI02.md" "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS02/README.md" similarity index 99% rename from "documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UI02/UI02.md" rename to "documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS02/README.md" index c8187d1e..69b89831 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UI02/UI02.md" +++ "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS02/README.md" @@ -1,4 +1,4 @@ -# [UI02] マイページ +# [UIS02] マイページ ## 概要 diff --git "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UI03/UI03.md" "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS03/README.md" similarity index 97% rename from "documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UI03/UI03.md" rename to "documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS03/README.md" index 1f3377de..34dad51a 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UI03/UI03.md" +++ "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS03/README.md" @@ -1,4 +1,4 @@ -# [UI03] トレーナー一覧 +# [UIS03] トレーナー一覧 ## 概要 diff --git "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UI04/UI04.md" "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS04/README.md" similarity index 97% rename from "documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UI04/UI04.md" rename to "documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS04/README.md" index 3887f81c..564529a5 100644 --- "a/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UI04/UI04.md" +++ "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/UIS04/README.md" @@ -1,4 +1,4 @@ -# [UI04] トレーナー詳細 +# [UIS04] トレーナー詳細 ## 概要 diff --git a/documents/forMarkdown/future_muscle_partner/docs/02_WebAPI/README.md b/documents/forMarkdown/future_muscle_partner/docs/02_WebAPI/README.md index de1a91a2..b2564194 100644 --- a/documents/forMarkdown/future_muscle_partner/docs/02_WebAPI/README.md +++ b/documents/forMarkdown/future_muscle_partner/docs/02_WebAPI/README.md @@ -6,6 +6,28 @@ | ID | 機能名 | メソッド | 詳細 | | -- | --- | --| --| -| API01 | xxxx | GET | [API01設計書](API01)| -| API02 | xxxx | GET | [API02設計書](API02)| -| API03 | xxxx | GET | [API03設計書](API03)| +| API01 | xxxx | GET | [設計書](API01)| +| API02 | xxxx | GET | 設計書| +| API03 | xxxx | GET | 設計書| +| API04 | xxxx | GET | 設計書| +| API05 | xxxx | GET | 設計書| +| API06 | xxxx | GET | 設計書| +| API07 | xxxx | GET | 設計書| +| API08 | xxxx | GET | 設計書| +| API09 | xxxx | GET | 設計書| +| API10 | xxxx | GET | 設計書| +| API11 | xxxx | GET | 設計書| +| API12 | xxxx | GET | 設計書| +| API13 | xxxx | GET | 設計書| +| API14 | xxxx | GET | 設計書| +| API15 | xxxx | GET | 設計書| +| API16 | xxxx | GET | 設計書| +| API17 | xxxx | GET | 設計書| +| API18 | xxxx | GET | 設計書| +| API19 | xxxx | GET | 設計書| +| API20 | xxxx | GET | 設計書| +| API21 | xxxx | GET | 設計書| +| API22 | xxxx | GET | 設計書| +| API23 | xxxx | GET | 設計書| +| API24 | xxxx | GET | 設計書| +| API25 | xxxx | GET | 設計書| diff --git a/documents/forMarkdown/future_muscle_partner/docs/02_WebAPI/openapi.yaml b/documents/forMarkdown/future_muscle_partner/docs/02_WebAPI/openapi.yaml index 1e8b2e0b..3212cdc2 100644 --- a/documents/forMarkdown/future_muscle_partner/docs/02_WebAPI/openapi.yaml +++ b/documents/forMarkdown/future_muscle_partner/docs/02_WebAPI/openapi.yaml @@ -25,7 +25,7 @@ paths: post: tags: - account - summary: API-001 ログイン + summary: API001 ログイン operationId: login security: [] requestBody: @@ -47,7 +47,7 @@ paths: post: tags: - account - summary: API-002 ログアウト + summary: API002 ログアウト operationId: logout security: [] responses: @@ -69,7 +69,7 @@ paths: post: tags: - account - summary: API-003 会員登録 + summary: API003 会員登録 operationId: signup security: [] requestBody: @@ -91,7 +91,7 @@ paths: delete: tags: - account - summary: API-004 会員退会 + summary: API004 会員退会 operationId: deleteAccount responses: '200': @@ -108,7 +108,7 @@ paths: get: tags: - profile - summary: API-005 プロフィール表示 + summary: API005 プロフィール表示 operationId: getUserProfile responses: '200': @@ -126,7 +126,7 @@ paths: put: tags: - profile - summary: API-006 プロフィール更新 + summary: API006 プロフィール更新 operationId: putUserProfile parameters: - name: trainee_id @@ -154,7 +154,7 @@ paths: get: tags: - trainer - summary: API-007 パーソナルトレーナー検索 + summary: API007 パーソナルトレーナー検索 operationId: searchTrainers security: [] parameters: @@ -210,7 +210,7 @@ paths: get: tags: - trainer - summary: API-008 トレーニングメニュー取得 + summary: API008 トレーニングメニュー取得 operationId: getTrainingMenu security: [] parameters: @@ -240,7 +240,7 @@ paths: get: tags: - trainer - summary: API-009 トレーナープロフィール取得 + summary: API009 トレーナープロフィール取得 operationId: getTrainerProfile security: [] parameters: @@ -269,7 +269,7 @@ paths: get: tags: - trainer - summary: API-010 トレーナー口コミ取得 + summary: API010 トレーナー口コミ取得 operationId: getTrainerReviews security: [] parameters: @@ -298,7 +298,7 @@ paths: get: tags: - trainer - summary: API-011 トレーナースケジュール取得 + summary: API011 トレーナースケジュール取得 operationId: getTrainerSchedule security: [] parameters: @@ -327,7 +327,7 @@ paths: post: tags: - booking - summary: API-012 トレーニング予約(仮登録) + summary: API012 トレーニング予約(仮登録) operationId: bookTraining requestBody: required: true @@ -354,7 +354,7 @@ paths: get: tags: - booking - summary: API-013 予約済みトレーニング取得 + summary: API013 予約済みトレーニング取得 operationId: getBookings parameters: - name: trainee_id @@ -390,7 +390,7 @@ paths: delete: tags: - booking - summary: API-014 トレーニング予約削除 + summary: API014 トレーニング予約削除 operationId: deleteBooking parameters: - name: booking_id @@ -416,7 +416,7 @@ paths: post: tags: - booking - summary: API-015 トレーニング予約(本登録) + summary: API015 トレーニング予約(本登録) operationId: confirmBooking parameters: - name: booking_id @@ -450,7 +450,7 @@ paths: put: tags: - booking - summary: API-016 トレーニング受講ステータス変更 + summary: API016 トレーニング受講ステータス変更 operationId: updateTrainingStatus parameters: - name: booking_id @@ -486,7 +486,7 @@ paths: post: tags: - payment - summary: API-017 決済 + summary: API017 決済 operationId: makePayment requestBody: required: true @@ -513,7 +513,7 @@ paths: post: tags: - review - summary: API-018 口コミ登録 + summary: API018 口コミ登録 operationId: postReview requestBody: required: true @@ -528,7 +528,7 @@ paths: put: tags: - review - summary: API-019 口コミ修正 + summary: API019 口コミ修正 operationId: putReview parameters: - name: review_id @@ -549,7 +549,7 @@ paths: delete: tags: - review - summary: API-020 口コミ削除 + summary: API020 口コミ削除 operationId: deleteReview parameters: - name: review_id @@ -565,7 +565,7 @@ paths: post: tags: - provider - summary: API-021 トレーナー登録 + summary: API021 トレーナー登録 operationId: postTrainer requestBody: required: true @@ -579,7 +579,7 @@ paths: put: tags: - provider - summary: API-022 トレーナー属性更新 + summary: API022 トレーナー属性更新 operationId: putTrainer requestBody: required: true @@ -594,7 +594,7 @@ paths: post: tags: - provider - summary: API-023 トレーニングメニュー登録 + summary: API023 トレーニングメニュー登録 operationId: postTrainingMenu requestBody: required: true @@ -609,7 +609,7 @@ paths: put: tags: - provider - summary: API-024 トレーニングメニュー更新 + summary: API024 トレーニングメニュー更新 operationId: putTrainingMenu parameters: - name: menu_id @@ -630,7 +630,7 @@ paths: delete: tags: - provider - summary: API-025 トレーニングメニュー削除 + summary: API025 トレーニングメニュー削除 operationId: deleteTrainingMenu parameters: - name: menu_id diff --git a/documents/forMarkdown/future_muscle_partner/docs/04_IF/README.md b/documents/forMarkdown/future_muscle_partner/docs/04_IF/README.md index 8b362f1d..c7d881f3 100644 --- a/documents/forMarkdown/future_muscle_partner/docs/04_IF/README.md +++ b/documents/forMarkdown/future_muscle_partner/docs/04_IF/README.md @@ -1,6 +1,21 @@ # システムI/F +::: warning 注意 + +[サンプル定義書](../../../IF定義書.md)と同様のため、各I/F設計書の例示は省略する + +::: + +## 送信I/F + +| ID | 名称 | 備考 | +| ---| --- | --- | +| IFS01 | xxx | xxx | +| IFS02 | xxx | xxx | + +## 受信I/F + | ID | 名称 | 備考 | | ---| --- | --- | -| IF01 | xxx | xxx | -| IF02 | xxx | xxx | +| 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" index 3a2dd0db..4171a1bb 100644 --- "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" @@ -1,6 +1,12 @@ # バッチ +::: warning 注意 + +[サンプル定義書](../../../プログラム設計書.md)と同様のため、各設計書の例示は省略する + +::: + | ID | 名称 | 備考 | | ---| --- | --- | -| BT01 | xxx | xxx | -| BT02 | xxx | xxx | +| 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" new file mode 100644 index 00000000..e6d5d602 --- /dev/null +++ "b/documents/forMarkdown/future_muscle_partner/docs/05_\345\270\263\347\245\250/README.md" @@ -0,0 +1,12 @@ +# 帳票 + +::: warning 注意 + +帳票で定義すべきことは、バッチやI/Fの定義書に近いのため、各設計書の例示は省略する + +::: + +| ID | 名称 | 備考 | +| ---| --- | --- | +| RPT01 | xxx | xxx | +| RPT02 | xxx | xxx | diff --git "a/documents/forMarkdown/future_muscle_partner/docs/06_\345\270\263\347\245\250/README.md" "b/documents/forMarkdown/future_muscle_partner/docs/06_\345\270\263\347\245\250/README.md" deleted file mode 100644 index 801e5e2b..00000000 --- "a/documents/forMarkdown/future_muscle_partner/docs/06_\345\270\263\347\245\250/README.md" +++ /dev/null @@ -1,6 +0,0 @@ -# 帳票 - -| ID | 名称 | 備考 | -| ---| --- | --- | -| RP01 | xxx | xxx | -| RP02 | xxx | xxx | diff --git a/documents/forMarkdown/future_muscle_partner/docs/README.md b/documents/forMarkdown/future_muscle_partner/docs/README.md index 42785615..ab7cbe7c 100644 --- a/documents/forMarkdown/future_muscle_partner/docs/README.md +++ b/documents/forMarkdown/future_muscle_partner/docs/README.md @@ -9,13 +9,34 @@ docs ├── 01_画面 # Figma、画面アクション ├── 02_WebAPI # openapi.yaml、API処理設計 ├── 03_データ # erd.a5er(ERD)、区分値 -├── 04_IF # I/F定義+受信/送信BL設計 -├── 05_バッチ # タイマー、イベント起動の非同期処理のBL設計 -├── 06_帳票 # 業務、システム担当者向けのレポート +├── 04_IF送信 # I/F定義+送信BL設計 +├── 05_IF受信 # I/F定義+受信BL設計 +├── 06_バッチ # タイマー、イベント起動の非同期処理のBL設計 ├── ... └── README.md ``` -## システム構成図 +## コード体系 -TODO +機能IDのコード体系は以下に従う。 + +| 種別 | 種別 | 例 | 備考 | +|-----|------------|-------------|----------------------| +| UIS | 通常画面 | UIS01、UIS02 | UI Standard から | +| UIM | モーダル画面 | UIM01、UIM02 | UI Mordal から | +| API | Web API | API01、API02 | | +| IFS | システムI/F 送信 | IFS01、IFS02 | InterFace Send から | +| IFR | システムI/F 受信 | IFR01、IFR02 | InterFace Receive から | +| BAT | バッチ | BAT01、BAT02 | BATch から | +| RPT | 帳票 | RPT01、RPT02 | RePorT から | + +コード体系について補足: + +- UISであれば、 `UIS(0[1-9]{1}|[0-9]{2}` といったフォーマットに従うこと +- Future Muscle Partnerのプロダクト規模であれば、機能数が爆発しないという想定で2桁とする + - 万が一あぶれた場合、16進数と見なしてA~Fを導入する拡張を行う + +機能IDの採番について注意点: + +- 採番後の変更は許可しない +- 連番とする(数字部分に新しい体系を作らない)