format future musle partner directory (#168)

future-architect · Sep 2, 2024 · 00b6db7 · 00b6db7
1 parent 13eb200
commit 00b6db7
Show file tree

Hide file tree

Showing 19 changed files with 46 additions and 14 deletions.
diff --git a/documents/forMarkdown/README.md b/documents/forMarkdown/README.md
@@ -48,8 +48,6 @@ Markdown に限った話では無いが、どういった内容を設計書に
 
 構成例を次にあげる。
 
-<!-- TODO 【相談】フロントエンド系、もっとまとめたほうが良いか？Figmaパスだけだとあれですよねぇ。画面遷移図も内容が薄い。 -->
-
 ```sh
 docs
 ├── 01_キャッチアップ # ドメイン知識など抑えておくべき前提知識

diff --git a/documents/forMarkdown/future_muscle_partner/README.md b/documents/forMarkdown/future_muscle_partner/README.md
@@ -1,6 +1,6 @@
 # Future Muscle Partner
 
-～いきつけのジムでパーソナルトレーニングを受けよう～ のFuture Muscle Partnerのリポジトリ。
+「いきつけのジムでパーソナルトレーニングを受けよう」のFuture Muscle Partnerのリポジトリ。
 
 ## サービスコンセプト
 

diff --git a/documents/forMarkdown/future_muscle_partner/docs/01_環境構築/README.md b/documents/forMarkdown/future_muscle_partner/docs/01_環境構築/README.md
diff --git a/documents/forMarkdown/future_muscle_partner/docs/01_画面/README.md b/documents/forMarkdown/future_muscle_partner/docs/01_画面/README.md
@@ -0,0 +1,11 @@
+# 画面
+
+* Figma URL: xxx
+
+## 画面一覧
+
+| ID | 論理名 | 備考 |
+| -- | --- | --- |
+| UI01 | xx | xx |
+| UI02 | xx | xx |
+| UI03 | xx | xx |
diff --git a/...e_muscle_partner/docs/04_WebAPI/README.md → ...e_muscle_partner/docs/02_WebAPI/README.md b/...e_muscle_partner/docs/04_WebAPI/README.md → ...e_muscle_partner/docs/02_WebAPI/README.md
@@ -9,4 +9,3 @@
 | API01 | xxxx | GET | [API01設計書](API01)|
 | API02 | xxxx | GET | [API02設計書](API02)|
 | API03 | xxxx | GET | [API03設計書](API03)|
-
diff --git a/...uscle_partner/docs/04_WebAPI/openapi.yaml → ...uscle_partner/docs/02_WebAPI/openapi.yaml b/...uscle_partner/docs/04_WebAPI/openapi.yaml → ...uscle_partner/docs/02_WebAPI/openapi.yaml
diff --git a/documents/forMarkdown/future_muscle_partner/docs/02_開発規約/README.md b/documents/forMarkdown/future_muscle_partner/docs/02_開発規約/README.md
diff --git a/documents/forMarkdown/future_muscle_partner/docs/03_データ/README.md b/documents/forMarkdown/future_muscle_partner/docs/03_データ/README.md
@@ -0,0 +1,5 @@
+# テーブル一覧
+
+[A5:SQL Mk-2](https://a5m2.mmatsubara.com/) で管理している。
+
+- [erd.a5er](erd.a5er) を参照
diff --git a/...uture_muscle_partner/docs/05_データ/erd.a5er → ...uture_muscle_partner/docs/03_データ/erd.a5er b/...uture_muscle_partner/docs/05_データ/erd.a5er → ...uture_muscle_partner/docs/03_データ/erd.a5er
diff --git a/documents/forMarkdown/future_muscle_partner/docs/03_画面/README.md b/documents/forMarkdown/future_muscle_partner/docs/03_画面/README.md
diff --git a/documents/forMarkdown/future_muscle_partner/docs/04_IF/README.md b/documents/forMarkdown/future_muscle_partner/docs/04_IF/README.md
@@ -0,0 +1,6 @@
+# システムI/F
+
+| ID | 名称 | 備考 |
+| ---| --- | --- |
+| IF01 | xxx | xxx |
+| IF02 | xxx | xxx |
diff --git a/documents/forMarkdown/future_muscle_partner/docs/05_データ/README.md b/documents/forMarkdown/future_muscle_partner/docs/05_データ/README.md
diff --git a/documents/forMarkdown/future_muscle_partner/docs/05_バッチ/README.md b/documents/forMarkdown/future_muscle_partner/docs/05_バッチ/README.md
@@ -0,0 +1,6 @@
+# バッチ
+
+| ID | 名称 | 備考 |
+| ---| --- | --- |
+| BT01 | xxx | xxx |
+| BT02 | xxx | xxx |
diff --git a/documents/forMarkdown/future_muscle_partner/docs/06_IF/README.md b/documents/forMarkdown/future_muscle_partner/docs/06_IF/README.md
diff --git a/documents/forMarkdown/future_muscle_partner/docs/06_帳票/README.md b/documents/forMarkdown/future_muscle_partner/docs/06_帳票/README.md
@@ -0,0 +1,6 @@
+# 帳票
+
+| ID | 名称 | 備考 |
+| ---| --- | --- |
+| RP01 | xxx | xxx |
+| RP02 | xxx | xxx |
diff --git a/documents/forMarkdown/future_muscle_partner/docs/07_バッチ/README.md b/documents/forMarkdown/future_muscle_partner/docs/07_バッチ/README.md
diff --git a/documents/forMarkdown/future_muscle_partner/docs/08_帳票/README.md b/documents/forMarkdown/future_muscle_partner/docs/08_帳票/README.md
diff --git a/documents/forMarkdown/future_muscle_partner/docs/09_インフラ/README.md b/documents/forMarkdown/future_muscle_partner/docs/09_インフラ/README.md
diff --git a/documents/forMarkdown/future_muscle_partner/docs/README.md b/documents/forMarkdown/future_muscle_partner/docs/README.md
@@ -1,20 +1,21 @@
 # docs
 
-設計書を管理する。
+設計ドキュメントを管理する。
 
 ## フォルダ階層
 
 ```sh
 docs
-├── 01_環境構築  # 開発環境の構築手順
-├── 02_開発規約  # 開発ガイドライン、リリース手順など
-├── 03_画面      # Figma、画面アクション
-├── 04_WebAPI   # api.yaml、API処理設計
-├── 05_データ    # ERD、区分値
-├── 06_IF       # I/F定義＋受信/送信BL設計
-├── 07_バッチ    # タイマー、イベント起動の非同期処理のBL設計
-├── 08_帳票      # 業務、システム担当者向けのレポート
-├── 09_インフラ  # ネットワーク設計、監視設計、通知設計、システム構成図、サービス構成図
+├── 01_画面      # Figma、画面アクション
+├── 02_WebAPI   # api.yaml、API処理設計
+├── 03_データ    # ERD、区分値
+├── 04_IF       # I/F定義＋受信/送信BL設計
+├── 05_バッチ    # タイマー、イベント起動の非同期処理のBL設計
+├── 06_帳票      # 業務、システム担当者向けのレポート
 ├── ...
 └── README.md
 ```
+
+## システム構成図
+
+TODO