工程開發
spec avatar

spec

為平台變更建立結構化規格,包含 GitHub Issue、SDD 範本,並針對基礎設施與安全性變更進行自動化類型推論。

簡介

spec 技能是「規格驅動開發 (SDD)」工作流程的核心組件,旨在簡化雲原生平台工程的架構決策流程。它能讓平台工程師在執行變更前,先行草擬、追蹤並管理重要變更,例如新的 Crossplane 組成 (Compositions)、透過 OpenTofu 進行的重大基礎設施修改,或是安全性原則更新。透過將每項變更與專屬的 GitHub Issue 及版本控制的規格目錄掛鉤,確保所有變更皆遵循符合專案憲章的一致審查流程。

  • 根據描述關鍵字(如 KCL、RBAC、VPC 或 Karpenter)自動推論變更類型(安全性、組成、基礎設施或平台)。

  • 根據預先定義的 SDD 範本產生標準化的產出物結構,包含 spec.md、plan.md 和 clarifications.md。

  • 促進多角色審查(PM、安全性、SRE、平台),以減少實作後的重工與技術債。

  • 與生命週期管理指令整合,例如用於解決模糊不清之處的 /clarify、執行品質門禁檢查的 /validate,以及實現順暢 GitOps 轉換的 /create-pr。

  • 透過將 Issue 標籤從 spec:draft 轉換為 spec:implementing,提供從設計到執行的清晰移轉路徑。

  • 請針對重大的架構調整、多組件平台功能,或需要實作前確認的變更使用此技能。

  • 若為版本升級、僅限文件更新或小型 Helm 設定調整,請避免使用此功能。

  • 若自動推論的類型不準確,使用者可在描述前明確指定類型(例如 /spec security '...' 或 /spec infrastructure '...')來進行覆寫。

  • 此技能會在 docs/specs/ 結構內建立產出物並對應至現有的 GitHub 工作流程,確保所有變更皆可透過 Flux 與 GitOps 原則進行完整追蹤。

  • 請務必參考生成的 spec.md 檔案以填寫技術細節、標記需要釐清的需求,並驗證是否符合平台在零信任與 GitOps 優先原則上的規範。

倉庫統計

Star 數
93
Fork 數
15
Open Issue 數
21
主要語言
Shell
預設分支
main
同步狀態
閒置
最近同步時間
2026年5月3日 上午06:07
在 GitHub 查看