業務流程模板
# <流程名稱>
文件狀態:草稿 / 已對 legacy / 已對 new API / 已實測
最後驗證:YYYY-MM-DD
來源:legacy code / new code / PHPUnit / staging curl / DB baseline / access log
## 目的
這份文件回答什麼使用者動作或系統流程。
## 不回答什麼
- 不放 migration status。
- 不放一次性測試 ID。
- 不重寫單張 table 的完整欄位定義。
- 不重寫 queue payload 或付款 provider 細節。
## 入口
| 項目 | 內容 |
|---|---|
| API | `<method> <path>` |
| Actor | consumer / provider / admin / worker |
| Auth | API key / session / security hash |
| Legacy | `<controller>::<action>()` |
| New API | `<Endpoint>::<action>()` |
| Domain method | `<Model>::<method>()` |
## 主流程
```text
request
-> auth / actor guard
-> domain method
-> main table update
-> activity / transaction / queue / log
-> response
```
## Guard
列出會阻擋流程的主要條件,不必貼完整 code。
## 成功 side effect
### DB
- `<table>.<field> = <value>`
### Activity
- `<activity type>`
### Queue / Event
- `<event_key>`
- queue 驗證接受 queue 或 log 任一存在。
### Payment
- 若有付款,連到付款文件。
## 失敗 side effect
列出主要錯誤路徑與不應發生的副作用。
## 第一輪排查
1. 查 application log。
2. 查主 table 狀態。
3. 查 activity。
4. 查 transaction。
5. 查 queue / log。
## 相關文件
- [[../資料表流程/README]]
- [[../付款與扣款流程/README]]
- [[../Queue 與 Event 系統/README]]
- [[../Log 與告警流程/README]]