From 00b6db78c946ad4de5afa2919a25fd1c430662d6 Mon Sep 17 00:00:00 2001 From: Junki Mano Date: Mon, 2 Sep 2024 14:30:35 +0900 Subject: [PATCH] format future musle partner directory (#168) --- documents/forMarkdown/README.md | 2 -- .../future_muscle_partner/README.md | 2 +- .../README.md" | 0 .../01_\347\224\273\351\235\242/README.md" | 11 ++++++++++ .../docs/{04_WebAPI => 02_WebAPI}/README.md | 1 - .../{04_WebAPI => 02_WebAPI}/openapi.yaml | 0 .../README.md" | 0 .../README.md" | 5 +++++ .../erd.a5er" | 0 .../03_\347\224\273\351\235\242/README.md" | 0 .../docs/04_IF/README.md | 6 ++++++ .../README.md" | 0 .../README.md" | 6 ++++++ .../docs/06_IF/README.md | 0 .../06_\345\270\263\347\245\250/README.md" | 6 ++++++ .../README.md" | 0 .../08_\345\270\263\347\245\250/README.md" | 0 .../README.md" | 0 .../future_muscle_partner/docs/README.md | 21 ++++++++++--------- 19 files changed, 46 insertions(+), 14 deletions(-) delete mode 100644 "documents/forMarkdown/future_muscle_partner/docs/01_\347\222\260\345\242\203\346\247\213\347\257\211/README.md" create mode 100644 "documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/README.md" rename documents/forMarkdown/future_muscle_partner/docs/{04_WebAPI => 02_WebAPI}/README.md (99%) rename documents/forMarkdown/future_muscle_partner/docs/{04_WebAPI => 02_WebAPI}/openapi.yaml (100%) delete mode 100644 "documents/forMarkdown/future_muscle_partner/docs/02_\351\226\213\347\231\272\350\246\217\347\264\204/README.md" create mode 100644 "documents/forMarkdown/future_muscle_partner/docs/03_\343\203\207\343\203\274\343\202\277/README.md" rename "documents/forMarkdown/future_muscle_partner/docs/05_\343\203\207\343\203\274\343\202\277/erd.a5er" => "documents/forMarkdown/future_muscle_partner/docs/03_\343\203\207\343\203\274\343\202\277/erd.a5er" (100%) delete mode 100644 "documents/forMarkdown/future_muscle_partner/docs/03_\347\224\273\351\235\242/README.md" create mode 100644 documents/forMarkdown/future_muscle_partner/docs/04_IF/README.md delete mode 100644 "documents/forMarkdown/future_muscle_partner/docs/05_\343\203\207\343\203\274\343\202\277/README.md" create 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/06_IF/README.md create mode 100644 "documents/forMarkdown/future_muscle_partner/docs/06_\345\270\263\347\245\250/README.md" delete mode 100644 "documents/forMarkdown/future_muscle_partner/docs/07_\343\203\220\343\203\203\343\203\201/README.md" delete mode 100644 "documents/forMarkdown/future_muscle_partner/docs/08_\345\270\263\347\245\250/README.md" delete mode 100644 "documents/forMarkdown/future_muscle_partner/docs/09_\343\202\244\343\203\263\343\203\225\343\203\251/README.md" diff --git a/documents/forMarkdown/README.md b/documents/forMarkdown/README.md index 94bc02c9..e68ab85b 100644 --- a/documents/forMarkdown/README.md +++ b/documents/forMarkdown/README.md @@ -48,8 +48,6 @@ Markdown に限った話では無いが、どういった内容を設計書に 構成例を次にあげる。 - - ```sh docs ├── 01_キャッチアップ # ドメイン知識など抑えておくべき前提知識 diff --git a/documents/forMarkdown/future_muscle_partner/README.md b/documents/forMarkdown/future_muscle_partner/README.md index 55050b68..4334bff8 100644 --- 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_\347\222\260\345\242\203\346\247\213\347\257\211/README.md" "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\222\260\345\242\203\346\247\213\347\257\211/README.md" deleted file mode 100644 index e69de29b..00000000 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" new file mode 100644 index 00000000..a4f716e8 --- /dev/null +++ "b/documents/forMarkdown/future_muscle_partner/docs/01_\347\224\273\351\235\242/README.md" @@ -0,0 +1,11 @@ +# 画面 + +* Figma URL: xxx + +## 画面一覧 + +| ID | 論理名 | 備考 | +| -- | --- | --- | +| UI01 | xx | xx | +| UI02 | xx | xx | +| UI03 | xx | xx | diff --git a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI/README.md b/documents/forMarkdown/future_muscle_partner/docs/02_WebAPI/README.md similarity index 99% rename from documents/forMarkdown/future_muscle_partner/docs/04_WebAPI/README.md rename to documents/forMarkdown/future_muscle_partner/docs/02_WebAPI/README.md index db55472e..de1a91a2 100644 --- a/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI/README.md +++ b/documents/forMarkdown/future_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/documents/forMarkdown/future_muscle_partner/docs/04_WebAPI/openapi.yaml b/documents/forMarkdown/future_muscle_partner/docs/02_WebAPI/openapi.yaml similarity index 100% rename from documents/forMarkdown/future_muscle_partner/docs/04_WebAPI/openapi.yaml rename to documents/forMarkdown/future_muscle_partner/docs/02_WebAPI/openapi.yaml diff --git "a/documents/forMarkdown/future_muscle_partner/docs/02_\351\226\213\347\231\272\350\246\217\347\264\204/README.md" "b/documents/forMarkdown/future_muscle_partner/docs/02_\351\226\213\347\231\272\350\246\217\347\264\204/README.md" deleted file mode 100644 index e69de29b..00000000 diff --git "a/documents/forMarkdown/future_muscle_partner/docs/03_\343\203\207\343\203\274\343\202\277/README.md" "b/documents/forMarkdown/future_muscle_partner/docs/03_\343\203\207\343\203\274\343\202\277/README.md" new file mode 100644 index 00000000..7a415556 --- /dev/null +++ "b/documents/forMarkdown/future_muscle_partner/docs/03_\343\203\207\343\203\274\343\202\277/README.md" @@ -0,0 +1,5 @@ +# テーブル一覧 + +[A5:SQL Mk-2](https://a5m2.mmatsubara.com/) で管理している。 + +- [erd.a5er](erd.a5er) を参照 diff --git "a/documents/forMarkdown/future_muscle_partner/docs/05_\343\203\207\343\203\274\343\202\277/erd.a5er" "b/documents/forMarkdown/future_muscle_partner/docs/03_\343\203\207\343\203\274\343\202\277/erd.a5er" similarity index 100% rename from "documents/forMarkdown/future_muscle_partner/docs/05_\343\203\207\343\203\274\343\202\277/erd.a5er" rename to "documents/forMarkdown/future_muscle_partner/docs/03_\343\203\207\343\203\274\343\202\277/erd.a5er" diff --git "a/documents/forMarkdown/future_muscle_partner/docs/03_\347\224\273\351\235\242/README.md" "b/documents/forMarkdown/future_muscle_partner/docs/03_\347\224\273\351\235\242/README.md" deleted file mode 100644 index e69de29b..00000000 diff --git a/documents/forMarkdown/future_muscle_partner/docs/04_IF/README.md b/documents/forMarkdown/future_muscle_partner/docs/04_IF/README.md new file mode 100644 index 00000000..8b362f1d --- /dev/null +++ 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_\343\203\207\343\203\274\343\202\277/README.md" "b/documents/forMarkdown/future_muscle_partner/docs/05_\343\203\207\343\203\274\343\202\277/README.md" deleted file mode 100644 index e69de29b..00000000 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" new file mode 100644 index 00000000..3a2dd0db --- /dev/null +++ "b/documents/forMarkdown/future_muscle_partner/docs/05_\343\203\220\343\203\203\343\203\201/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 deleted file mode 100644 index e69de29b..00000000 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" new file mode 100644 index 00000000..801e5e2b --- /dev/null +++ "b/documents/forMarkdown/future_muscle_partner/docs/06_\345\270\263\347\245\250/README.md" @@ -0,0 +1,6 @@ +# 帳票 + +| ID | 名称 | 備考 | +| ---| --- | --- | +| RP01 | xxx | xxx | +| RP02 | xxx | xxx | diff --git "a/documents/forMarkdown/future_muscle_partner/docs/07_\343\203\220\343\203\203\343\203\201/README.md" "b/documents/forMarkdown/future_muscle_partner/docs/07_\343\203\220\343\203\203\343\203\201/README.md" deleted file mode 100644 index e69de29b..00000000 diff --git "a/documents/forMarkdown/future_muscle_partner/docs/08_\345\270\263\347\245\250/README.md" "b/documents/forMarkdown/future_muscle_partner/docs/08_\345\270\263\347\245\250/README.md" deleted file mode 100644 index e69de29b..00000000 diff --git "a/documents/forMarkdown/future_muscle_partner/docs/09_\343\202\244\343\203\263\343\203\225\343\203\251/README.md" "b/documents/forMarkdown/future_muscle_partner/docs/09_\343\202\244\343\203\263\343\203\225\343\203\251/README.md" deleted file mode 100644 index e69de29b..00000000 diff --git a/documents/forMarkdown/future_muscle_partner/docs/README.md b/documents/forMarkdown/future_muscle_partner/docs/README.md index 93ccb882..3e6c949b 100644 --- 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