Skip to content

format future musle partner directory #168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 2, 2024
Merged

format future musle partner directory #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions documents/forMarkdown/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,6 @@ Markdown に限った話では無いが、どういった内容を設計書に

構成例を次にあげる。

<!-- TODO 【相談】フロントエンド系、もっとまとめたほうが良いか？Figmaパスだけだとあれですよねぇ。画面遷移図も内容が薄い。 -->

```sh
docs
├── 01_キャッチアップ # ドメイン知識など抑えておくべき前提知識
Expand Down
2 changes: 1 addition & 1 deletion documents/forMarkdown/future_muscle_partner/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Future Muscle Partner

～いきつけのジムでパーソナルトレーニングを受けよう～ のFuture Muscle Partnerのリポジトリ。
「いきつけのジムでパーソナルトレーニングを受けよう」のFuture Muscle Partnerのリポジトリ。

## サービスコンセプト

Expand Down
Empty file removed documents/forMarkdown/future_muscle_partner/docs/01_環境構築/README.md
View file
Open in desktop
Empty file.
11 changes: 11 additions & 0 deletions documents/forMarkdown/future_muscle_partner/docs/01_画面/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# 画面

* Figma URL: xxx

## 画面一覧

| ID | 論理名 | 備考 |
| -- | --- | --- |
| UI01 | xx | xx |
| UI02 | xx | xx |
| UI03 | xx | xx |
1 change: 0 additions & 1 deletion ...e_muscle_partner/docs/04_WebAPI/README.md → ...e_muscle_partner/docs/02_WebAPI/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,3 @@
| API01 | xxxx | GET | [API01設計書](API01)|
| API02 | xxxx | GET | [API02設計書](API02)|
| API03 | xxxx | GET | [API03設計書](API03)|

0 ...uscle_partner/docs/04_WebAPI/openapi.yaml → ...uscle_partner/docs/02_WebAPI/openapi.yaml
View file
Open in desktop
File renamed without changes.
Empty file removed documents/forMarkdown/future_muscle_partner/docs/02_開発規約/README.md
View file
Open in desktop
Empty file.
5 changes: 5 additions & 0 deletions documents/forMarkdown/future_muscle_partner/docs/03_データ/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# テーブル一覧

[A5:SQL Mk-2](https://a5m2.mmatsubara.com/) で管理している。

- [erd.a5er](erd.a5er) を参照
0 ...uture_muscle_partner/docs/05_データ/erd.a5er → ...uture_muscle_partner/docs/03_データ/erd.a5er
View file
Open in desktop
File renamed without changes.
Empty file removed documents/forMarkdown/future_muscle_partner/docs/03_画面/README.md
View file
Open in desktop
Empty file.
6 changes: 6 additions & 0 deletions documents/forMarkdown/future_muscle_partner/docs/04_IF/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# システムI/F

| ID | 名称 | 備考 |
| ---| --- | --- |
| IF01 | xxx | xxx |
| IF02 | xxx | xxx |
Empty file removed documents/forMarkdown/future_muscle_partner/docs/05_データ/README.md
View file
Open in desktop
Empty file.
6 changes: 6 additions & 0 deletions documents/forMarkdown/future_muscle_partner/docs/05_バッチ/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# バッチ

| ID | 名称 | 備考 |
| ---| --- | --- |
| BT01 | xxx | xxx |
| BT02 | xxx | xxx |
Empty file removed documents/forMarkdown/future_muscle_partner/docs/06_IF/README.md
View file
Open in desktop
Empty file.
6 changes: 6 additions & 0 deletions documents/forMarkdown/future_muscle_partner/docs/06_帳票/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# 帳票

| ID | 名称 | 備考 |
| ---| --- | --- |
| RP01 | xxx | xxx |
| RP02 | xxx | xxx |
Empty file removed documents/forMarkdown/future_muscle_partner/docs/07_バッチ/README.md
View file
Open in desktop
Empty file.
Empty file removed documents/forMarkdown/future_muscle_partner/docs/08_帳票/README.md
View file
Open in desktop
Empty file.
Empty file removed documents/forMarkdown/future_muscle_partner/docs/09_インフラ/README.md
View file
Open in desktop
Empty file.
21 changes: 11 additions & 10 deletions documents/forMarkdown/future_muscle_partner/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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