Skip to content

画面設計書のサンプルMarkdownを追加 #107

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 2 commits into from
Mar 22, 2024
Merged

画面設計書のサンプルMarkdownを追加 #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ca4e37
画面遷移図、画面設計書
ma91n Mar 22, 2024
7dcb260
画面設計書を追加
ma91n Mar 22, 2024
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
26 changes: 10 additions & 16 deletions documents/forMarkdown/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,14 @@ docs
├── 01_キャッチアップ # ドメイン知識など抑えておくべき前提知識
├── 02_環境構築 #
├── 03_開発規約 # GitFlowなど、リリース方式、CI／CD周り
├── 04_ユーザーストーリー #
├── 05_画面レイアウト # Figmaのパスなど
├── 06_画面遷移図 #
├── 07_画面アクション
├── 08_API設計書 # OpenAPIのパス＋各BL設計
├── 09_データモデル # ERD, テーブル定義
├── 10_IF設計書 # I/F定義＋受信/送信BL設計
├── 11_バッチ設計書 # タイマー、イベント起動の非同期処理のBL設計
├── 12_インフラ設計 # 監視、キャパシティサイジング、コスト
├── 04_ユーザーストーリー
├── 05_UI設計 # Figmaのパスなど
├── 06_画面設計書
├── 07_API設計書 # OpenAPIのパス＋各BL設計
├── 08_データモデル # ERD, テーブル定義
├── 09_IF設計書 # I/F定義＋受信/送信BL設計
├── 10_バッチ設計書 # タイマー、イベント起動の非同期処理のBL設計
├── 11_インフラ設計 # 監視、キャパシティサイジング、コスト
├── ...
└── README.md
```
Expand All @@ -74,13 +73,8 @@ TODO 論理, 物理, etc.

## フロントエンド

### 画面遷移

TODO

### 画面 xxx

TODO
- UI設計(Figma)
- [](画面設計書.md)

## バックエンド

Expand Down
62 changes: 62 additions & 0 deletions documents/forMarkdown/画面設計書.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# [機能ID] xxx売上履歴表示

## 概要

機能目的:

- 確認ステータス、スキップステータスをもとに、過去のxxx売上履歴を確認する

機能概要:

- 過去１年分の売上履歴を対象に、検索表示する
- スキップ設定や確認ステータスの更新を行う

## イベント概要

| No | イベント名 | イベント分類 | 　 　 処理説明 |
|--- |-----------------------------------------|---------------|------------------------------------------------|
| 1 | 初期表示 | 初期表示 | 初期検索条件に従いAPIを実行し、履歴表示する |
| 2 | 履歴検索 | ボタン押下 | 検索条件エリアの条件に従い、履歴の検索を行う |
| 3 | 保存 | ボタン押下 | 履歴テーブルで書き込んだ、スキップ、確認済の保存を行う |
| 4 | 検索結果 ページ送り/戻し | ボタン押下 | テーブルあたりの行数プルダウンで設定された行数に応じて表示切替する |
| 5 | 検索結果 ページ送り（100件以降データ） | ボタン押下 | 検索結果の表で、ページ送りする際、100件以降のデータの場合は再度APIに問い合わせ描画する |
| 6 | 画面入力値チェック | ボタン押下 | 検索条件のバリデーションチェックを行う |

## イベント詳細

### 1. 初期表示

起動パラメータ:

| Name | Value | Memo |
| --- | --- | --- |
| userState | {/* 略 */} | xxx状態 |

初期表示イベント:

- xxx

利用API:

| ID | オプション |
| --- | --- |
| API031 | /v1/salesresult?q=xxxx&date=${current_ymd} |

画面表示制御:

- 0件時
- 空テーブル表示（メッセージは表示しない）
- HTTPステータスが200以外
- メッセージID（MSG_BIZ_111）表示

### 2. 履歴検索

/v1/salesresult?q=xxxx&date=${current_ymd}

### 3. 保存

### 4. 検索結果 ページ送り/戻し

### 5. 検索結果 ページ送り（100件以降データ）

### 6. 画面入力値チェック