把「README 编写」交给智能体，难点不在模型能力，而在流程是否说清楚：输入是什么（代码仓库），按什么顺序处理，交付什么（README 文档），哪些事不能做。Skill 就是把这些写下来的载体。

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

这个技能做什么

项目说明
技能README 编写（readme-writer）
作用根据仓库内容生成结构完整的 README
输入代码仓库
输出README 文档
形态纯提示词
风险低
适用人群开发者与技术写作者

处理流程分四步：

  1. 识别项目用途
  2. 整理安装与运行命令
  3. 写最小示例
  4. 补充贡献与许可说明

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

在 n8n AI Agent 中是什么形态

n8n 是可自托管的工作流自动化工具，内置 AI Agent 节点，可以给智能体挂上 HTTP 请求、代码等工具，并与数百种应用的触发器和动作衔接。

可以自托管或使用云服务；凭据在 n8n 中单独管理，不要写进节点参数。

示例配置

# n8n 流程示意（节点名称以 n8n 当前版本为准）
[Chat Trigger 或 Webhook]
      │ content
      ▼
[AI Agent]  系统消息：README 编写，识别项目用途；整理安装与运行命令；写最小示例；补充贡献与许可说明
      ├─ 工具：无，纯提示词
      ▼
[IF 需人工确认?] ──是──▶ [发送给负责人审核]
      │否
      ▼
[输出：README 文档]

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

安装与启用步骤

  1. 新建工作流，选择聊天触发或 Webhook 触发
  2. 添加 AI Agent 节点，写系统消息
  3. 为 Agent 挂上需要的工具节点
  4. 加 IF 节点把需人工确认的结果转给负责人
  5. 测试后启用工作流

实操：一次完整的运行

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

这是今天的代码仓库，按团队的README 编写流程处理一下。

智能体识别到任务与「README 编写」相关后，会依次识别项目用途、整理安装与运行命令、写最小示例、补充贡献与许可说明。最终交付README 文档，并在末尾列出需要人工确认的内容。你的工作是对照原始代码仓库抽查两三处关键信息，确认无误后再使用。

测试与验收

用固定测试数据手动执行工作流，检查每个节点输出，再开启自动触发。

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

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

常见坑

  • 把密钥直接写进代码节点。
  • 自动触发未加频率限制，导致重复执行。
  • 只写了步骤，没写交付格式，导致每次输出的README 文档结构不同。
  • 没有给出样例，智能体对“好结果”的理解与你不一致；在参考资料里放一两份范例会明显改善。

延伸阅读

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