SKILL.md
readonlyread-only
name
update-specification
description
更新解決方案的現有規格檔案,針對生成式 AI 使用進行最佳化,根據新需求或任何現有程式碼的更新。
更新規格
您的目標是根據新需求或任何現有程式碼的更新,來更新現有的規格檔案 ${file}。
規格檔案必須以清晰、明確且結構化的方式定義解決方案元件的需求、限制和介面,以便生成式 AI 有效使用。請遵循既定的文件標準,並確保內容是機器可讀且自包含的。
AI 就緒規格的最佳實務
- 使用精確、明確且無歧義的語言。
- 清楚區分需求、限制和建議。
- 使用結構化格式(標題、清單、表格)以便於解析。
- 避免使用成語、隱喻或依賴上下文的參考。
- 定義所有縮寫和領域特定術語。
- 在適用的情況下包含範例和邊界情況。
- 確保文件是自包含的,不依賴外部上下文。
規格應儲存在 /spec/ 目錄中,並按照以下慣例命名:[a-z0-9-]+.md,名稱應描述規格的內容,並以高層級目的開頭,目的為 [schema, tool, data, infrastructure, process, architecture, or design] 之一。
規格檔案必須使用格式良好的 Markdown。
規格檔案必須遵循以下範本,確保所有區塊都已適當填寫。Markdown 的前置資料應按照以下範例正確結構化:
---
title: [描述規格重點的簡潔標題]
version: [可選:例如 1.0, 日期]
date_created: [YYYY-MM-DD]
last_updated: [可選:YYYY-MM-DD]
owner: [可選:負責此規格的團隊/個人]
tags: [可選:相關標籤或分類清單,例如 `infrastructure`, `process`, `design`, `app` 等]
---
# 簡介
[對規格及其預期達成的目標進行簡短簡潔的介紹。]
## 1. 目的與範圍
[提供規格目的及其應用範圍的清晰簡潔描述。說明目標讀者和任何假設。]
## 2. 定義
[列出並定義本規格中使用的所有縮寫、簡稱和領域特定術語。]
## 3. 需求、限制與指南
[明確列出所有需求、限制、規則和指南。使用項目符號或表格以確保清晰。]
- **REQ-001**: 需求 1
- **SEC-001**: 安全需求 1
- **[3 個字母]-001**: 其他需求 1
- **CON-001**: 限制 1
- **GUD-001**: 指南 1
- **PAT-001**: 遵循的模式 1
## 4. 介面與資料合約
[描述介面、API、資料合約或整合點。使用表格或程式碼區塊來表示結構描述和範例。]
## 5. 驗收標準
[為每個需求定義清晰、可測試的驗收標準,在適當時使用 Given-When-Then 格式。]
- **AC-001**: 給定 [上下文],當 [動作],則 [預期結果]
- **AC-002**: 系統應在 [條件] 時 [特定行為]
- **AC-003**: [根據需要新增其他驗收標準]
## 6. 測試自動化策略
[定義測試方法、框架和自動化需求。]
- **測試層級**: 單元測試、整合測試、端到端測試
- **框架**: MSTest、FluentAssertions、Moq(適用於 .NET 應用程式)
- **測試資料管理**: [測試資料建立和清理的方法]
- **CI/CD 整合**: [在 GitHub Actions 管線中進行自動化測試]
- **涵蓋率需求**: [最低程式碼涵蓋率門檻]
- **效能測試**: [負載和效能測試的方法]
## 7. 理由與背景
[解釋需求、限制和指南背後的理由。提供設計決策的背景資訊。]
## 8. 相依性與外部整合
[定義本規格所需的外部系統、服務和架構相依性。重點在於**需要什麼**而非**如何實作**。除非是架構限制,否則避免指定特定的套件或函式庫版本。]
### 外部系統
- **EXT-001**: [外部系統名稱] - [目的和整合類型]
### 第三方服務
- **SVC-001**: [服務名稱] - [所需能力和 SLA 需求]
### 基礎設施相依性
- **INF-001**: [基礎設施元件] - [需求和限制]
### 資料相依性
- **DAT-001**: [外部資料來源] - [格式、頻率和存取需求]
### 技術平台相依性
- **PLT-001**: [平台/執行階段需求] - [版本限制和理由]
### 合規相依性
- **COM-001**: [法規或合規需求] - [對實作的影響]
**注意**:此區塊應專注於架構和業務相依性,而非特定的套件實作。例如,指定「OAuth 2.0 驗證函式庫」而非「Microsoft.AspNetCore.Authentication.JwtBearer v6.0.1」。
## 9. 範例與邊界情況
```code
// 程式碼片段或資料範例,展示指南的正確應用,包括邊界情況
10. 驗證標準
[列出必須滿足的標準或測試,以符合本規格。]
11. 相關規格 / 延伸閱讀
[連結到相關規格 1]
[連結到相關外部文件]






