sop-authoring

用途

SOP Authoring 用于在编写或创建面向 AI 智能体的新标准作业程序（SOP）时提供指导。其目标是帮助把复杂工作流程转化为可复用、确定性的指令。

核心概念

一个良好的 SOP 应具备以下特征：

单一职责：每个 SOP 只针对一个特定的工作流程或任务
确定性：相同的输入产生相同的输出
可执行性：每一步都具体且可执行
参数化：通过变量实现跨场景复用
自包含：尽量减少外部依赖

SOP 与其它文档的区别

SOP：规定性的工作流程，包含具体步骤
文档：描述性的参考资料
指南：带有解释的教育性内容
教程：逐步学习体验

当需要一致、可重复地执行多步骤流程时，应使用 SOP。

主要能力与最佳实践

编写清晰指令

应当：使用主动语态和祈使语气；步骤以动作动词开头（analyze、generate、validate）；明确预期结果；为每一步包含成功标准；有序步骤用编号列表，无序项用项目符号。

不应：使用被动语态（"should be done" → "do this"）；包含含糊指令（"improve the code"）；混合流程性内容与参考资料；未加说明就假设存在隐含知识。

标题与描述

格式为 # {Action Verb} {Outcome} SOP，后接 Overview，用 1-2 句话描述该 SOP 达成什么目标以及何时使用。

好的标题示例："Generate Codebase Documentation"、"Implement Feature Using TDD"、"Review Pull Request for Security"。

差的标题示例："Documentation"（太含糊）、"How to Maybe Improve Code Quality"（不确定）、"The Complete Guide to Everything"（太宽泛）。

步骤的结构化

既支持顺序步骤，也支持条件逻辑。顺序步骤示例中，每一步下可列出子项。条件逻辑示例中，可根据判断结果分支执行不同动作。

参数

定义参数使 SOP 可复用，例如：Repository Path: {repository_path}；Output Format: {output_format} (markdown, json, html)；Verbosity Level: {verbosity} (concise, detailed, comprehensive)。在步骤中引用这些参数。

成功标准

以清单形式给出明确的成功标准，例如所有源文件已记录、README.md 存在且含安装说明、API 文档完整、示例经过测试且可用。

示例

技能提供三个完整示例：

代码质量审查 SOP：参数为 Pull Request URL 与 Review Depth；步骤包括获取 PR 详情、审查代码质量、检查架构一致性、生成评审反馈；成功标准包括识别所有关键问题、反馈具体可执行等。
测试驱动开发实现功能 SOP：参数为 Feature Description 与 Test Framework；步骤遵循红-绿-重构循环（创建失败测试、编写最小实现、重构、对每个需求重复）；成功标准包括所有测试通过、测试覆盖率 ≥ 80%、无代码重复、功能满足需求。
生成代码库文档 SOP：参数为 Repository Path、Documentation Format、Include Examples；步骤包括分析仓库结构、提取架构信息、记录公共 API、生成安装说明、创建文档文件；成功标准包括文档覆盖所有公共 API、安装说明完整、架构解释清晰、示例经过测试且准确。

常见模式

错误处理：任一步骤失败时应记录失败原因、提供排查步骤、建议替代方案，且不要进入下一步。
验证步骤：每个主要步骤后验证输出是否满足质量标准、检查错误或警告、确认结果符合预期。
迭代流程：对集合中的每一项执行动作、验证结果、继续下一项。

反模式（应避免的常见错误）

指令过于笼统：❌ "Improve the code quality" → ✅ "Run linter and fix all errors, then remove code duplication"
缺少上下文：❌ "Run the tests" → ✅ "Run test suite using npm test and verify all tests pass"
成功标准含糊：❌ "Code should be good" → ✅ "Code passes all linter checks and has no security vulnerabilities"
隐藏假设：❌ 假设工具已安装 → ✅ 明确列出前置条件
混合多个工作流程：❌ 在一个 SOP 中合并测试、部署与监控 → ✅ 创建可组合的独立 SOP

限制

资料中未提供该技能的安装命令、收费方式、支持平台及具体版本信息。

技能介绍

用途