SuperAPI AI 工具集

sop-structure

办公与效率

查看项目

更新于 10-16 02:06

技能介绍

用途

sop-structure 用于指导如何以一致的结构和 Markdown 格式组织标准作业程序(SOP),使 SOP 易于理解、维护和执行。它覆盖 SOP 的解剖结构与章节组织方式。

主要能力

该技能定义了标准 SOP 应包含的核心章节:

  • 标题(Title):清晰、以动作导向的描述
  • 概述(Overview):目的与使用场景的简要总结
  • 参数(Parameters):可配置输入,便于复用
  • 前置条件(Prerequisites):所需工具、知识或环境设置
  • 步骤(Steps):按顺序排列的执行指令
  • 成功标准(Success Criteria):如何验证完成
  • 错误处理(Error Handling):出错时的应对方式
  • 关联 SOP(Related SOPs):指向相关工作流的链接

文件命名约定:SOP 文件必须使用 .sop.md 扩展名。正确示例:deployment-checklist.sop.md、code-review-security.sop.md、database-migration.sop.md。错误示例:deployment.md(缺少 .sop)、checklist.sop.txt(文件类型错误)、SOP-Deployment.md(格式不正确)。

使用方式

各章节的编写要点如下:

标题:使用 # {动作动词} {具体结果} 格式。短形式使用 kebab-case 文件名,长形式使用 Title Case 标题。示例包括 # Generate API Documentation、# Implement Feature Using TDD、# Review Pull Request for Security。

概述:回答三个问题——What(该 SOP 完成什么)、When(何时使用)、Why(为何采用此方法)。

参数:在开头定义所有可配置输入,格式为 - **输入变量**: {variable_name} - 描述与示例值。

前置条件:列出所需工具(含版本)、所需知识和所需环境设置。

步骤:按层级组织,可在大步骤下添加子步骤,并可在每步末尾加入 Validation 验证点。

成功标准:使用可勾选清单定义可衡量的结果。

错误处理:针对常见失败,提供症状(Symptoms)、原因(Cause)和解决步骤(Resolution)。

关联 SOP:链接到相关工作流,说明何时改用或配合使用。

适用场景

适用于需要编写、组织或维护可复用、易执行、易维护的 SOP 文档的场景,例如部署流程、代码审查、数据库迁移、功能实现等。技能中提供了代码分析类 SOP 和实现类 SOP 的模板,以及一个完整的“部署应用到生产环境”SOP 示例。

限制与反模式

应避免以下结构错误:

  • 缺少参数:在步骤中硬编码值,而非在开头定义参数
  • 前置条件不清:假设工具已安装,而非明确列出所需工具及版本
  • 成功标准模糊:如“代码质量应良好”,而非“代码通过 linter 且 0 错误、测试覆盖率 ≥ 80%”
  • 缺少错误处理:只描述顺利路径,未包含常见失败与解决方案
  • 章节组织混乱:步骤排在参数之前、成功标准与步骤混杂;应保持固定顺序:概述 → 参数 → 前置条件 → 步骤 → 成功标准 → 错误处理

相关技能包括 sop-authoring(编写清晰可执行的指令)、sop-rfc2119(使用 RFC 2119 关键词表达精确要求)、sop-maintenance(保持 SOP 时效性与相关性)。