跳轉到

Naming Rules（前端規格展開與 UI 生成）

文件治理欄位

  • 文件名稱：naming-rules.md
  • 文件用途：定義 repo、module、screen、field、api 與模板命名規則
  • 適用對象：PM、SA、前端工程師、AI 協作 Agent
  • 適用範圍：docs/、templates/、<模組>/99_Delivery/ 與 Skill 觸發語句
  • 可見性等級：internal
  • 是否為 SSOT：否（命名治理；業務契約仍以模組分析文件為準）
  • 上游依據文件：docs/governance/prototype-governance-summary.md
  • 下游引用文件：docs/operations/ai-collaboration-workflow.md、templates/frontend-sdd/*.md
  • 待確認事項：中文別名是否統一放在 frontmatter aliases

1. 通用規則

  1. 檔名使用 kebab-case，副檔名為 .md。
  2. 不在檔名放日期、版號、人名。
  3. 範本類文件必含 -template。
  4. 清單/盤點類文件優先使用 -inventory。
  5. 規劃草稿使用 -planning 或 -notes。

2. 固定英文檔名 + 中文別名

  • 英文檔名：系統主鍵，不可任意變更。
  • 中文別名：允許，供人員辨識、Notion 顯示與 AI 觸發。
  • 建議欄位：在文件 frontmatter 使用 aliases:（可多值）。

範例：

aliases:
  - 雛形治理總結
  - 前端規格治理總覽

3. 識別碼規則

  • module_code：[A-Z]{3}（例：IMP）
  • screen_id：<MODULE>_<3碼序號>（例：IMP_310）
  • field_key：snake_case（例：buyer_tax_id）
  • action_key：verb_noun（例：save_draft）
  • api_name：<domain>.<resource>.<action>（例：invoice.header.get）

4. 建議固定核心文件名

  • prototype-governance-summary.md
  • naming-rules.md
  • ai-collaboration-workflow.md
  • screen-package-template.md
  • fields-template.md
  • actions-template.md
  • api-map-template.md
  • acceptance-template.md
  • frontend-handoff-structure.md

5. AI 觸發語句命名原則

  1. 優先中文自然語句，不要求記英文 skill 名。
  2. 每類任務至少保留 2 個穩定觸發語句。
  3. 觸發語句應指向固定輸出（模板與目錄）。

範例：

  • 「幫我展開畫面交付包」→ screen-package-template.md
  • 「幫我整理欄位規格」→ fields-template.md
  • 「幫我整理前端 handoff」→ frontend-handoff-structure.md
  • 「幫我補 API 對照」→ api-map-template.md
  • 「幫我補驗收條件」→ acceptance-template.md