Bremen
/
emma-hermes
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
emma-hermes/docs/gateway-resilience/gateway-entrypoint.md

4.7 KiB
Raw Blame History

Gateway Resilience 首頁索引 / 單頁入口

用途：這是一頁式操作入口。當你只知道「我要改 gateway」或「update 後好像壞了」，但不知道該先翻哪份文件時，先看這頁就夠。

1. 我現在是哪種情況？

A. 我要開始改 code / config / routing

先看：

  1. gateway-functional-contract.md
  2. gateway-change-impact-checklist.md
  3. gateway-team-usage-policy.md

B. 我剛 update / merge / restart 完，要驗收

先看：

  1. gateway-update-restart-sop.md
  2. gateway-validation-template-full.md
  3. gateway-validation-template-compact.md

C. 現在已經壞了，要快速定位

先看：

  1. gateway-recovery-playbook.md
  2. gateway-state-and-sequence.md
  3. gateway-regression-matrix.md

D. 我在看治理後台 / principal / quota / admin 問題

先看：

  1. gateway-admin-ui-api-matrix.md
  2. gateway-governance-admin-platform.md
  3. gateway-team-usage-policy.md

E. 我只想快速回報結果

先看：

  1. gateway-validation-template-compact.md
  2. examples-principal-profile-routing-validation-compact.md

2. 最常見問題 → 對應文件

問題：我改了 code，不知道該跑哪些測試

看：

  • gateway-change-impact-checklist.md

問題：我 update 完，不知道驗收順序

看：

  • gateway-update-restart-sop.md

問題：我只想知道功能本來應該怎樣

看：

  • gateway-functional-contract.md

問題：我想知道整條流程到底怎麼跑

看：

  • gateway-state-and-sequence.md

問題：壞了，不知道先查哪一層

看：

  • gateway-recovery-playbook.md

問題：想知道 governance 到底是 API-only 還是有前端 UI

看：

  • gateway-admin-ui-api-matrix.md

問題：我要留完整驗收紀錄

看：

  • gateway-validation-template-full.md

問題：我要貼 Telegram / LINE / email 回報

看：

  • gateway-validation-template-compact.md

問題：我不知道模板怎麼填

看：

  • examples-principal-profile-routing-validation-full.md
  • examples-principal-profile-routing-validation-compact.md

問題：我想知道團隊規則到底是什麼

看：

  • gateway-team-usage-policy.md

3. 最短操作路徑

路徑 1：我要改 code

  1. 讀 gateway-functional-contract.md
  2. 勾 gateway-change-impact-checklist.md
  3. 改 code / docs
  4. 跑 gateway-update-restart-sop.md
  5. 填 gateway-validation-template-full.md
  6. 回報用 gateway-validation-template-compact.md

路徑 2：update 後出問題

  1. 跑 gateway-update-restart-sop.md
  2. 若 fail，翻 gateway-recovery-playbook.md
  3. 若牽涉治理，翻 gateway-admin-ui-api-matrix.md
  4. 用 gateway-validation-template-compact.md 回報

路徑 3：只做 restart 驗收

  1. 跑 gateway-update-restart-sop.md 的快速健康檢查
  2. 做核心 smoke
  3. 填 gateway-validation-template-compact.md

4. 四條主線壞了各看哪份

綁定 / handoff 壞了

  • gateway-functional-contract.md
  • gateway-recovery-playbook.md
  • gateway-update-restart-sop.md

LINE 長任務 / pending / replay 壞了

  • gateway-state-and-sequence.md
  • gateway-recovery-playbook.md
  • gateway-change-impact-checklist.md

LINE quota fallback / email 改寄壞了

  • gateway-functional-contract.md
  • gateway-state-and-sequence.md
  • gateway-recovery-playbook.md

email 附件 / 副檔名 / 下載連結壞了

  • gateway-functional-contract.md
  • gateway-recovery-playbook.md
  • gateway-regression-matrix.md

principal / quota / role / admin 後台壞了

  • gateway-admin-ui-api-matrix.md
  • gateway-governance-admin-platform.md
  • gateway-team-usage-policy.md

5. 哪些文件是「一定常用」

如果你不想一次記住 14 份，先記這 5 份就夠：

  1. gateway-change-impact-checklist.md
  2. gateway-update-restart-sop.md
  3. gateway-recovery-playbook.md
  4. gateway-validation-template-compact.md
  5. gateway-team-usage-policy.md

這 5 份的分工

  • 改前：gateway-change-impact-checklist.md
  • 驗收：gateway-update-restart-sop.md
  • 出錯：gateway-recovery-playbook.md
  • 回報：gateway-validation-template-compact.md
  • 制度：gateway-team-usage-policy.md

6. 新人 / 非原作者最安全的進入方式

如果不是原作者，或剛接手這塊，最安全順序是：

  1. 先讀這份首頁索引
  2. 再讀 gateway-team-usage-policy.md
  3. 再讀 gateway-functional-contract.md
  4. 改前先勾 gateway-change-impact-checklist.md
  5. 驗收照 gateway-update-restart-sop.md
  6. 回報直接用模板，不要自由發揮

7. 一句話版

改前看 impact，改後跑 SOP，出錯翻 playbook，回報用模板，團隊規則看 usage policy。