Documentation
README
規範文件更新
修改任何 .knowledge/specs/ 下的規範文件時,必須透過此 skill 執行,確保版本號遞增、變更有記錄、相關任務被通知。
使用方式
/spec-update <spec-file> <變更摘要>
參數
$0: 規範文件路徑(如.knowledge/specs/api-design.md)$ARGUMENTS: 完整參數(含變更摘要)
執行步驟
STEP 1 — 讀取目標規範文件
讀取 $0,確認:
- 當前版本號(文件標題或頂部 metadata 中的
vX.Y) - 文件結構與現有內容
⛔ STEP 2 — 確認變更範圍
說明本次變更:
- 變更內容:新增 / 修改 / 刪除了什麼
- 影響範圍:哪些模組、API、功能受影響
- 向後相容性:是否有 breaking change
輸出:
📋 變更摘要
規範文件:$0
當前版本:vX.Y
變更類型:[新增欄位 / 修改行為 / 刪除功能 / 其他]
影響範圍:[描述]
Breaking change:[是 / 否]
✋ 確認變更範圍正確後再繼續。
STEP 3 — 執行變更
對 $0 進行實際修改。
⛔ STEP 4 — 遞增版本號
在規範文件頂部更新版本號:
- Minor change(新增、修改):
vX.Y→vX.Y+1 - Breaking change:
vX.Y→vX+1.0
This is the opening of the README. Read the full README on GitHub.