Wiki Frontmatter 規範

所有 wiki/entities/*.md 檔案的 YAML frontmatter 標準。新增 entity 時請依此規範。


完整模板

---
title: "Entity Name"
aliases: [別名1, 別名2]
domain: it|system|vendor|network|moc
type: troubleshooting|sop|equipment|manual|d3mam|k2|aurora|network|config|moc|reference
status: active|draft|stub|archived
tags: [tag1, tag2]
sources:
  - "原始來源檔路徑.md"
created: YYYY-MM-DD
updated: YYYY-MM-DD
---

欄位說明

必填欄位

欄位說明範例
title完整中文/英文名稱(雙引號)"K2_儲存系統架構圖"
domain大領域system
type細分類network
status生命週期draft
sources原始來源(可空陣列)[]- "Q&A/foo.md"
created建立日期今天日期(用 date +%F 取得,不要照抄範例的舊日期)
updated最後更新日期同上,每次實質修改時更新

⚠️ 日期務必用今天的!新建 entity 時不要照抄既有 entity 模板的舊 created 日期。詳見 CLAUDE.md §「日期處理規範」。

選填欄位

欄位說明何時加
aliases別名陣列重要 hub、常用縮寫的 entity 強烈建議
tags標籤陣列跨 MOC 的細分類、未來 dataview query 用
source-update-logappend-only 歷史軌跡(plugin v1.3.5+)當 entity 經 wiki-refresh / 手動補資料時。配合 wiki-lint 的 stale-source 偵測,避免 lint 誤報。每筆格式:"date: YYYY-MM-DD action: refreshed summary: 描述"action 取值:created / refreshed / manual-edit / deprecated / merged-from / split-into

status 流程

stub → draft → active
                ↓
           archived(過時但保留)
Status何時用
stub佔位頁,只有標題和概要骨架,內容待補
draft內容已完備,但尚未經人工校對
active經校對驗證的穩定內容(多數 entity 都應為此)
archived過時但有歷史價值,保留不刪

domain × type 對照

domain允許的 type
itsop / troubleshooting / equipment / reference
systemd3mam / k2 / aurora / network
vendormanual
networkconfig
mocmoc(僅給 9 張 Map of Content 用)

tags 命名建議

採小寫 + 中英混合,常用 tag 集合:

系統類k2 / d3mam / aurora / diva / pres / 副控 / ob
用途類架構圖 / sop / troubleshooting / ip清單 / 帳密 / 備份 / 災後檢查
廠商grass-valley / oracle / harris / miranda / front-porch-digital
主題磁帶 / 歸檔 / 打包 / 播出 / 剪輯 / 字幕 / prompter


範例

A. 一般 troubleshooting entity

---
title: "K2_Insync連線GV失敗"
domain: it
type: troubleshooting
status: active
tags: [k2, insync, troubleshooting]
sources:
  - "年代 & 壹電視 Q&A/K2 Insync(二) 連線GV失敗.md"
created: 2026-04-30
updated: 2026-04-30
---

B. 重要 hub(加 aliases)

---
title: "主控K2維護SOP"
aliases: [主控K2, PRES K2 維護, K2 維護]
domain: system
type: k2
status: active
tags: [k2, san, maintenance, sop, pres]
sources:
  - "年代 & 壹電視 Q&A/主控K2維護.md"
created: 2026-04-29
updated: 2026-04-29
---

C. MOC 入口頁

---
title: "MOC_K2系統"
aliases: [K2, K2 系統, K2 入口]
domain: moc
type: moc
status: active
tags: [k2, san, summit, storage, grass-valley, moc, index]
sources: []
created: 2026-04-29
updated: 2026-04-29
---

自動 lint

定期跑:

cd /path/to/IT
python3 references/lint_frontmatter.py  # (未來實作)

最新報告見 wiki/reports/LINT_FM_YYYYMMDD.md


相關