本文介紹 SKILL.md 檔案的完整格式規範及技能目錄結構。
技能目錄結構
一個完整的技能由一個檔案夾組成,檔案夾名即為技能標識。目錄結構如下:
├── SKILL.md # 必需:核心指令檔案
├── references/ # 可選:參考文檔目錄
├── assets/ # 可選:模板和資來源目錄
└── scripts/ # 可選:可執行指令碼目錄目錄說明
目錄 | 是否必需 | 說明 | 典型用途 |
SKILL.md | 是 | 技能的核心定義檔案,包含中繼資料和執行指令 | 定義技能名稱、描述、執行步驟和輸出格式 |
references/ | 否 | 存放參考文檔和規範說明 | 編碼規範、最佳實務、檢查清單、API 文檔等 |
assets/ | 否 | 存放模板檔案和靜態資源 | 輸出模板、代碼模板、配置模板、樣本檔案等 |
scripts/ | 否 | 存放可執行指令碼(當前不支援) |
references 目錄
references/ 目錄用於存放技能執行時需要參考的文檔資料。數字員工會根據 SKILL.md 中的指令按需載入這些文檔。
適用情境:
發布檢查清單和變更操作規範。
故障處理手冊(Runbook)。
警示響應流程和升級鏈路。
CI/CD 流水線配置說明。
服務依賴關係和 SLO 定義。
樣本結構:
references/
├── release-checklist.md # 發布前檢查清單
├── rollback-runbook.md # 復原操作手冊
└── alert-handling.md # 警示處理規範在 SKILL.md 中引用:
## 執行步驟
1. 參考 `references/release-checklist.md` 執行發布前檢查
2. 根據 `references/rollback-runbook.md` 評估是否需要復原assets 目錄
assets/ 目錄用於存放模板檔案和靜態資源。這些資源可以作為輸出格式的參考,或作為產生內容的基礎模板。
適用情境:
故障複盤報告模板。
發布通知和變更記錄模板。
CI/CD 流水線配置模板。
監控警示規則模板。
樣本結構:
assets/
├── incident-report.md # 故障複盤報告模板
├── deploy-summary.md # 發布通知模板
└── pipeline-config.yaml # CI/CD 流水線配置模板在 SKILL.md 中引用:
## 輸出格式
按照 `assets/incident-report.md` 模板格式輸出故障複盤報告。
## 發布通知
使用 `assets/deploy-summary.md` 作為發布完成通知的內容結構。scripts 目錄
scripts/ 目錄用於存放可執行指令碼。數字員工可以調用這些指令碼來完成自動化任務,如代碼檢查、資料處理、檔案轉換等。
說明: 當前數字員工 Skill 不支援指令碼運行,此目錄僅供未來擴充使用。
適用情境:
服務健全狀態檢查指令碼。
日誌採集和分析指令碼。
CI/CD 流水線觸發和狀態查詢指令碼。
基礎設施巡檢指令碼。
樣本結構:
scripts/
├── health-check.sh # 服務健全狀態檢查指令碼
├── log-analyzer.py # 日誌分析指令碼
└── pipeline-trigger.sh # CI/CD 流水線觸發指令碼指令碼編寫規範:
指令碼應支援命令列參數輸入。
輸出結果應為結構化文本,便於數字員工解析。
包含必要的錯誤處理和使用說明。
首行添加 shebang(如
#!/bin/bash或#!/usr/bin/env python3)。
SKILL.md 檔案結構
SKILL.md 檔案由兩部分組成:
YAML Frontmatter:檔案頂部的中繼資料配置。
Markdown 本文:技能的具體指令和說明。
中繼資料欄位
欄位 | 是否必填 | 說明 | 限制 |
name | 是 | 技能唯一標識 | 僅小寫字母、數字、連字號,最長 64 字元 |
description | 是 | 功能描述和觸發情境 | 最長 512 字元 |
完整樣本
---
name: release-readiness-checker
description: 用於服務發布前的就緒檢查,評估健康狀態、流量、依賴服務是否具備發布條件
---
# Release Readiness Checker
## 概述
在服務發布前,自動檢查關鍵計量是否滿足發布條件,輸出發布就緒報告,降低發布風險。
## 執行步驟
1. 查詢目標服務當前的錯誤率、延遲、QPS 基準
2. 檢查依賴服務(資料庫、緩衝、下遊介面)的健康狀態
3. 確認 CI/CD 流水線最新構建是否通過(單測、整合測試)
4. 評估當前流量水位,判斷是否處於業務高峰期
5. 輸出發布就緒報告,標註風險項
## 輸出格式
輸出結構化的發布就緒報告,包含:
- 整體就緒結論(✅ 可發布 / ⚠️ 謹慎發布 / ❌ 不建議發布)
- 各檢查項的狀態和詳情
- 風險項說明和建議操作
## 注意事項
- 如無法擷取某項指標,標註為"資料缺失"並跳過,不影響其他項檢查
- 高峰期(工作日 10:00-12:00、14:00-18:00)發布需額外確認最佳實務
描述要精準:
description欄位是數字員工判斷是否啟用技能的關鍵,應包含明確的觸發關鍵詞。步驟要清晰:使用編號清單描述執行步驟,便於數字員工理解和執行。
提供樣本:包含具體的輸入輸出樣本,協助數字員工理解預期行為。
定義輸出格式:明確說明輸出的格式要求,確保結果一致性。