docs: add M4 notification protocol — standardize response format
This commit is contained in:
77
docs_v1.0/M4_workspace/M4_NOTIFICATION_PROTOCOL.md
Normal file
77
docs_v1.0/M4_workspace/M4_NOTIFICATION_PROTOCOL.md
Normal file
@@ -0,0 +1,77 @@
|
||||
# M4 通知規範
|
||||
|
||||
**Date**: 2026-05-13
|
||||
**Version**: 1.0
|
||||
|
||||
---
|
||||
|
||||
## 固定方式
|
||||
|
||||
通知 M4 的唯一固定管道:**在 `M4_workspace/` 建立回覆文件,標題包含日期與主題,然後提交 git commit。**
|
||||
|
||||
不需口頭通知、不需即時訊息、不需額外郵件。
|
||||
|
||||
---
|
||||
|
||||
## 命名規則
|
||||
|
||||
```
|
||||
docs_v1.0/M4_workspace/YYYY-MM-DD_<topic>_response.md (回覆 M4 問題)
|
||||
docs_v1.0/M4_workspace/YYYY-MM-DD_<topic>.md (主動通報)
|
||||
```
|
||||
|
||||
範例:
|
||||
|
||||
```
|
||||
2026-05-13_deploy_script_response.md ← 回覆 deploy script 問題
|
||||
2026-05-13_111614_test_report.md ← 主動通知新包測試
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 觸發時機
|
||||
|
||||
| 情境 | 動作 |
|
||||
|------|------|
|
||||
| M4 提交問題報告到 `M4_workspace/` | 修復後,回覆 `*_response.md` |
|
||||
| 完成 M4 要求的任務 | 回覆 `*_response.md` |
|
||||
| 重大變更(模型替換、架構變更) | 主動通知 `*.md` |
|
||||
| 新測試包產出 | `*_test_report.md` |
|
||||
|
||||
---
|
||||
|
||||
## 文件模板
|
||||
|
||||
```markdown
|
||||
# {主題}
|
||||
|
||||
**Date**: YYYY-MM-DD
|
||||
**From**: M5
|
||||
**To**: M4
|
||||
**Ref**: `YYYY-MM-DD_source_file.md`
|
||||
|
||||
---
|
||||
|
||||
## 已完成
|
||||
|
||||
| # | 項目 | 狀態 |
|
||||
|---|------|:--:|
|
||||
| 1 | 問題 A 修復 | ✅ |
|
||||
| 2 | 功能 B 新增 | ✅ |
|
||||
|
||||
## 檔案變更
|
||||
|
||||
| 檔案 | 說明 |
|
||||
|------|------|
|
||||
| `path/to/file` | 改動摘要 |
|
||||
|
||||
## 備註
|
||||
```
|
||||
---
|
||||
|
||||
## 交付檢查清單
|
||||
|
||||
1. 文件寫入 `M4_workspace/`
|
||||
2. `git add` 包含該文件
|
||||
3. `git commit` 含相關變更
|
||||
4. M4 透過 git log 查看
|
||||
Reference in New Issue
Block a user