name: create-sop description: 创建一个具有适当结构的新标准操作程序 (SOP) 文件

创建新SOP

名称

agent-sop:create-sop - 创建一个新的标准操作程序文件

概要

/create-sop

描述

此命令引导用户为AI代理创建结构良好的标准操作程序 (SOPs)。它提供逐步帮助，包括确定SOP目的、结构化内容、应用RFC 2119关键词以及使用适当的命名约定保存文件。

实现

您正在帮助用户创建一个新的标准操作程序 (SOP) 文件。

您的任务

通过以下方式引导用户创建结构良好的SOP文件：

询问SOP目的 (如果未提供):
- 此SOP处理什么工作流或任务？
- 应在何时使用此SOP？
- 预期结果是什么？
确定SOP类型:
- 分析/审查SOP (分析代码、审查PRs、审计)
- 实现SOP (构建功能、编写代码、进行更改)
- 部署SOP (部署更改、回滚、配置)
- 维护SOP (更新依赖、清理、重构)
创建SOP文件 遵循此结构：

# {行动动词} {具体结果}

## 概述

{1-2个句子描述此SOP实现什么以及何时使用它}

## 参数

- **参数名称**: {parameter_name} - 描述和示例值
- **配置**: {config_option} - 可用选项

## 先决条件

### 必需工具
- 工具名称 (版本X.X或更高)

### 必需知识
- 理解相关概念

### 必需设置
- 必需的环境配置

## 步骤

1. 第一个主要步骤
   - 详细子步骤
   - 另一个子步骤
   - **验证**: 如何验证此步骤成功

2. 第二个主要步骤
   - 实现细节
   - 预期结果
   - **验证**: 验证方法

3. 第三个主要步骤
   - 具体操作
   - 成功指标

## 成功标准

- [ ] 可衡量结果1
- [ ] 可衡量结果2
- [ ] 可衡量结果3
- [ ] 所有测试通过
- [ ] 文档已更新

## 错误处理

### 错误: {常见错误名称}

**症状**: 此错误如何显现

**原因**: 为何出现此错误

**解决方案**:
1. 第一个故障排除步骤
2. 第二个故障排除步骤
3. 替代方法

## 相关SOPs

- **{related-sop}**: 何时使用此替代
- **{complementary-sop}**: 接下来做什么

适当使用RFC 2119关键词:
- MUST: 绝对要求 (安全、数据完整性、先决条件)
- SHOULD: 强烈推荐 (最佳实践、优化)
- MAY: 可选操作 (增强、偏好)
- MUST NOT: 绝对禁止 (安全违规、数据风险)
- SHOULD NOT: 强烈不鼓励 (反模式)
文件命名:
- 使用kebab-case
- 使用 .sop.md 扩展名
- 示例: deploy-production.sop.md, code-review-security.sop.md
保存位置:
- 询问保存位置 (或使用 ~/sops/ 作为默认)
- 建议按类别组织: ~/sops/deployment/, ~/sops/development/

遵循的最佳实践

使用主动语态和命令语气
以行动动词开始步骤
在主要操作后包括验证步骤
提供具体、可衡量的成功标准
包括常见错误场景
在有用处添加示例
将参数保持在顶部以便参考

创建SOP后

通过逐步走查测试SOP
如果存在，添加到SOP索引
如果与Agent SOP MCP服务器一起使用，确保文件有 .sop.md 扩展名
考虑版本控制 (如果此SOP将发展，添加版本和变更日志)

示例交互

用户: “帮助我创建一个用于部署到生产的SOP”

响应:

询问部署过程的澄清问题
识别必需工具 (kubectl, docker等)
规划部署步骤
创建具有适当RFC 2119关键词的结构化SOP文件
保存到适当位置
建议使用干运行部署测试SOP