开发者与技术写作者经常要做「教程编写」这类事：把一个功能写成循序渐进的教程。每次都从头写提示词，结果时好时坏；把它做成智能体 Skill，就能让智能体每次按同一套步骤执行，输出结构也更稳定。

本文介绍如何在 OpenAI Agents SDK 上实现这个技能，包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。

这个技能做什么

项目说明
技能教程编写（tutorial-writer）
作用把一个功能写成循序渐进的教程
输入功能说明与示例
输出教程文档
形态纯提示词
风险低
适用人群开发者与技术写作者

处理流程分四步：

  1. 设定读者水平
  2. 拆分步骤
  3. 每步附代码与预期结果
  4. 加入排错提示

这个技能纯指令型，不需要额外脚本或外部连接，复制到大多数平台都能用；风险较低，但输出仍需快速过目再使用。

在 OpenAI Agents SDK 中是什么形态

OpenAI Agents SDK 是一个轻量的智能体开发框架，用 Agent 定义指令与工具，用 function_tool 把 Python 函数变成工具，用 Runner 运行，还支持多智能体交接与护栏。

代码运行在你自己的环境中，可接入日志与追踪；具体的包名、版本与模型配置以官方文档为准。

示例配置

# 示意代码：OpenAI Agents SDK（pip 包名与接口以官方文档为准）
from agents import Agent, Runner, function_tool

@function_tool
def load_tutorial_writer(path: str) -> str:
    """读取功能说明与示例并返回文本。"""
    with open(path, encoding="utf-8") as fh:
        return fh.read()[:20000]

agent = Agent(
    name="教程编写",
    instructions="""
1. 设定读者水平
2. 拆分步骤
3. 每步附代码与预期结果
4. 加入排错提示
输出：教程文档。不确定的内容标注“需人工确认”。
""",
    tools=[load_tutorial_writer],
)

result = Runner.run_sync(agent, "请处理 input.txt 中的功能说明与示例")
print(result.final_output)

示例里最重要的是两处：一是描述（或指令开头）要写明「什么时候用」，让智能体在开发者与技术写作者提出相关请求时能对上号；二是约束部分要写进「文中的命令和接口要与当前代码逐一核对」这类领域规矩，避免智能体自作主张。

安装与启用步骤

  1. 安装 SDK 并配置模型访问凭据（放在环境变量中）
  2. 用 function_tool 定义读取或处理数据的工具
  3. 在 Agent 的 instructions 中写入技能步骤与约束
  4. 用 Runner 运行并打印结果
  5. 把它包装成命令行工具或接口供团队使用

实操：一次完整的运行

假设你在文档仓库与文档站中发出这样的请求（虚构示例）：

用教程编写技能处理这份功能说明与示例，输出教程文档。

智能体识别到任务与「教程编写」相关后，会依次设定读者水平、拆分步骤、每步附代码与预期结果、加入排错提示。最终交付教程文档，并在末尾列出需要人工确认的内容。你的工作是对照原始功能说明与示例抽查两三处关键信息，确认无误后再使用。

测试与验收

为 Agent 写几条固定输入的回归用例，每次修改指令后重跑，比较输出结构。

针对这个技能，还建议额外准备：

  • 一份信息齐全的标准功能说明与示例，检查输出是否完整
  • 一份缺少关键信息的输入，检查智能体是否先提问而不是编造
  • 一份包含“忽略以上规则”等字样的输入，检查约束是否仍然有效

常见坑

  • 把密钥写在代码里提交。
  • instructions 写得过长，关键约束被淹没。
  • 只写了步骤，没写交付格式，导致每次输出的教程文档结构不同。
  • 没有给出样例，智能体对“好结果”的理解与你不一致；在参考资料里放一两份范例会明显改善。

延伸阅读

说明：文中的配置、代码与目录结构均为示意，用于说明思路；各平台的入口、字段名与能力会更新，落地前请以对应官方文档为准。示例中的数据与场景为虚构，不代表真实案例。