Skip to content

G2:版本控制的文件

將文件與程式碼放在同一個版本控制儲存庫,是 documentation as code 的核心實踐。Git 追蹤每一次變更的作者、時間與原因,Markdown 的純文字格式讓差異比對清晰可讀。

Confluence、Google Docs、Word 等工具產出的文件缺乏版本歷史、無法分支與合併、難以與程式碼變更關聯。二進位格式也讓 AI 代理難以解析內容。

原則

  • 所有規格必須 (MUST) 以 Markdown 撰寫、在版本控制(Git)下管理,並包含 frontmatter 後設資料以供程式化存取。

純文字格式讓差異比對清晰可讀,AI 也易於解析。Git 追蹤每一次變更的作者、時間與原因,並支援分支與合併。Frontmatter 欄位如 title、description、status、owner、created、updated 讓 AI 代理可以解析後設資料而無需讀取完整內容。

相關原則

參考資料