術語與命名規則|Terminology & Naming
本手冊採用「中文主述+英文技術名」命名規則。中文說明用途,英文保留可搜尋、可對照官方文件與錯誤訊息的技術名詞。
為什麼保留英文技術名
技術名詞硬翻成中文會讓查資料、對 log、對官方文件時失真。例如 canonical、redirect、sitemap、Webhook、RLS、OAuth callback、Cloudflare Pages 都應保留英文。
可以翻的是用途與動作,例如:
- 上線檢查
- 錯誤排查
- 金流整合
- 任務交接
- 防禦性網域轉址
Title 命名規則
文件 title 使用:
中文用途|English Technical Name原則:
- 中文放前面,讓協作夥伴先理解用途。
- 英文放後面,保留搜尋與技術對照能力。
- 不要只寫英文。
- 不要把常見技術名詞硬翻成陌生中文。
Sidebar label 命名規則
sidebar label 優先與文件 title 一致,但可以略短。若 title 過長,保留中文用途與核心英文名詞即可。
Prompt title 命名規則
Prompt title 要說清楚 Agent 的任務,不只寫工具名稱。
SEO Migration AuditCloudflare Pages SEO Launch Audit Agent部署錯誤排查|Deployment Debug AgentPrompt 內文要明確要求先 audit、再 fix,並列出輸出格式。
Command title 命名規則
Command title 要描述指令用途,purpose 說明操作階段,expected 說明預期結果。
<CommandBlock title="確認 unknown URL 是真 404" purpose="Soft 404 驗證" expected="HTTP status 應為 404">範例表
| 不建議 | 建議 |
|---|---|
| Cloudflare Pages SEO Launch Checklist | Cloudflare Pages SEO 上線檢查|Launch Checklist |
| Google Search Console Setup | 搜尋主控台設定|Google Search Console |
| WordPress to Pages Migration | WordPress / GoDaddy 搬站|Cloudflare Pages Migration |
| Defensive Domain Redirects | 防禦性網域轉址|Defensive Domain Redirects |
| Cloudflare Redirect Loop | Cloudflare 轉址循環排查|Redirect Loop |
| Pages Soft 404 | Cloudflare Pages 假 404 排查|Soft 404 |
| API Debug Checklist | API 問題排查|Debug Checklist |
| Webhook Idempotency | Webhook 冪等處理|Idempotency |
完成標準
- 文件 title 不是純英文。
- sidebar label 能看出用途。
- 技術名詞保留英文。
- Prompt title 與 Command title 能直接判斷任務。
- 新文件可從 SOP 撰寫模板|SOP Writing Template 複製後套用。