数字员工 Skill 格式规范

目录说明

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）。

元数据字段

完整示例

---
name: release-readiness-checker
description: 用于服务发布前的就绪检查，评估健康状态、流量、依赖服务是否具备发布条件
---

# Release Readiness Checker

## 概述
在服务发布前，自动检查关键指标是否满足发布条件，输出发布就绪报告，降低发布风险。

## 执行步骤
1. 查询目标服务当前的错误率、延迟、QPS 基线
2. 检查依赖服务（数据库、缓存、下游接口）的健康状态
3. 确认 CI/CD 流水线最新构建是否通过（单测、集成测试）
4. 评估当前流量水位，判断是否处于业务高峰期
5. 输出发布就绪报告，标注风险项

## 输出格式
输出结构化的发布就绪报告，包含：
- 整体就绪结论（✅ 可发布 / ⚠️ 谨慎发布 / ❌ 不建议发布）
- 各检查项的状态和详情
- 风险项说明和建议操作

## 注意事项
- 如无法获取某项指标，标注为"数据缺失"并跳过，不影响其他项检查
- 高峰期（工作日 10:00-12:00、14:00-18:00）发布需额外确认