name: update-sop description: 更新现有标准操作程序以反映工具、过程或最佳实践的变化
更新现有标准操作程序
名称
agent-sop:update-sop - 更新现有标准操作程序
概要
/update-sop
描述
此命令指导用户更新现有标准操作程序（SOP），以反映工具、过程或最佳实践的变化。它处理版本递增、变更日志管理、迁移指南编写，并确保相关SOP的一致性。
实施
您正在帮助用户更新现有标准操作程序（SOP），以保持其当前和准确。
您的任务
通过以下步骤指导用户更新SOP：
-
识别要更新的SOP：
- 哪个SOP需要更新？
- 更新需求触发原因？（工具变更、过程变更、事件、反馈）
-
阅读当前SOP：
- 审查现有内容
- 注意当前版本（如有版本控制）
- 识别需要更改的部分
-
确定更新类型：
- 次要更新：澄清、拼写错误修复、小改进（补丁版本）
- 功能更新：新步骤、附加参数、增强错误处理（次要版本）
- 重大变更：根本过程变更、工具迁移（主要版本）
-
更新版本和变更日志：
# {SOP标题}
**版本**：{新版本}
**最后更新**：{YYYY-MM-DD}
**变更**：{变更简要摘要}
## 变更日志
### v{新版本} ({日期})
- {变更1及详情}
- {变更2及详情}
- {变更3及详情}
*原因：{为何进行这些变更}*
### v{前一版本} ({前一日期})
- {先前变更}
-
进行更新：
- 更新受影响部分
- 如需要，添加新步骤
- 更新参数
- 修订成功标准
- 添加新错误处理场景
- 更新示例为当前语法
- 验证RFC 2119关键词是否仍适用
-
确保一致性：
- 相关SOP可能也需要更新
- 如需要，更新“相关SOP”部分
- 检查示例是否仍有效
- 验证先决条件是否为当前
版本编号（语义版本控制）
-
主要 (X.0.0)：重大变更
- 工具替换（Docker → Kubernetes）
- 根本过程变更
- 不兼容参数变更
-
次要 (x.X.0)：新功能、非破坏性
- 新可选步骤
- 附加参数
- 增强错误处理
-
补丁 (x.x.X)：错误修复、澄清
- 拼写纠正
- 澄清语言
- 更新示例
更新检查清单
进行更改后，验证：
- [ ] 版本号适当递增
- [ ] 变更日志更新了变更和原因
- [ ] 最后更新日期为当前
- [ ] 所有工具版本为当前
- [ ] 示例使用当前语法
- [ ] 先决条件准确
- [ ] 成功标准可测量
- [ ] 错误处理覆盖已知问题
- [ ] 相关SOP仍有效
- [ ] RFC 2119关键词适用
常见更新场景
场景1：工具版本更新
## 变更日志
### v1.2.0 (2025-12-05)
- 更新Node.js要求从v16到v18
- 更新npm命令以使用新语法
- 添加Node v18破坏性变更的故障排除
*原因：Node.js v16达到寿命终止*
## 先决条件
### 必需工具
- Node.js (v18或更高) <!-- 从v16更改 -->
- npm (v9或更高) <!-- 从v8更改 -->
场景2：添加错误处理
## 变更日志
### v1.1.0 (2025-12-05)
- 添加连接超时场景的错误处理
- 在部署步骤中包含重试逻辑
*原因：生产事件 #1234 - 部署期间超时*
## 错误处理
### 错误：部署期间连接超时
**症状**：部署挂起，服务器连接超时
**原因**：网络问题、服务器过载或防火墙阻止
**解决**：
1. 检查与部署目标的网络连接
2. 验证服务器响应：`ping {服务器}`
3. 以增加超时重试部署：`--timeout 300`
4. 如果持续，检查防火墙规则和服务器日志
场景3：过程改进
## 变更日志
### v2.0.0 (2025-12-05)
- 添加金丝雀部署步骤（重大变更）
- 重构推出过程以逐步发布
- 在阶段之间添加监控验证
*原因：减少因不良部署导致的生产中断风险*
## 步骤
1. 部署到金丝雀（10%流量）
- 更新金丝雀部署
- 路由10%流量到新版本
- **新**：监控错误率10分钟
- **验证**：错误率 < 1%，延迟在基准10%内
2. 部署到生产（剩余90%）
- 如果金丝雀成功，继续
- 如果金丝雀失败，自动回滚
[... 其余步骤 ...]
迁移指南模板
对于重大变更（主要版本），包括迁移指南：
## 从v{旧主版本}.x迁移
### 重大变更
1. **{变更名称}**
- **旧行为**：{之前是什么}
- **新行为**：{现在是什么}
- **所需操作**：{用户必须做什么}
2. **{另一变更}**
- **旧行为**：{先前方法}
- **新行为**：{新方法}
- **所需操作**：{迁移步骤}
### 迁移步骤
1. {准备迁移的步骤}
2. {执行迁移的步骤}
3. {验证迁移的步骤}
### 向后兼容性
- {什么保持兼容}
- {什么破坏兼容}
- {旧版本将支持多久}
更新后
-
测试更新后的SOP：
- 逐步执行所有步骤
- 验证示例有效
- 检查错误场景
-
沟通变更：
- 通知团队重大更新
- 突出破坏性变更
- 如需要，提供迁移指导
-
更新相关文档：
- SOP索引
- 相关SOP
- 团队维基或文档
-
提交变更：
git add {sop-file}.sop.md git commit -m "feat(sop): 更新{sop-name}到v{版本} - {摘要}"
示例交互
用户：“更新部署SOP以使用新CI/CD管道”
响应：
- 阅读当前部署SOP
- 询问新管道详情
- 确定这是主要版本（重大变更）
- 更新版本从1.5.0到2.0.0
- 添加变更日志条目解释CI/CD迁移
- 更新部署步骤以使用新管道
- 添加从旧到新管道的迁移指南
- 更新先决条件（需要新工具）
- 测试更新后的SOP
- 保存并提交变更