n8n 中文文档

为模板添加便签

添加便签,让他人能够从工作流画布上理解并设置您的模板。

每个模板都需要一条主概览便签。有四个或更多节点的工作流还需要分区便签,用来给相关节点分组。

添加主概览便签

在画布左上角使用一条黄色便签。写 100 到 300 个词,并使用以下标题:

  • ### How it works:描述工作流的用途、触发器、主要阶段和结果。
  • ### Setup:列出所需账户、凭据、资源以及要配置的值。
  • ### Customization:可选,说明他人可以做的有用改动。

请提供足够的上下文,使他人无需返回模板库页面就能使用该工作流。说明这个工作流帮助谁、产生什么结果,以及有哪些限制。

下面的示例展示了一个潜在客户接收工作流的结构。请根据您自己的工作流调整,并核实每一步:

### How it works
此工作流帮助销售团队处理收到的潜在客户提交。它检查必填字段,在 HubSpot 中查找现有联系人,并创建或更新匹配的记录。它把合格的潜在客户发送到 Slack 频道,并把不完整的提交路由到人工审核。按电子邮件匹配可以避免同一个人的每次提交都创建一个新联系人。

### Setup
连接您的 HubSpot 和 Slack 凭据。在配置节点中设置目标频道和资格规则。配置表单,使其把预期的姓名、电子邮件和公司字段发送到工作流。发送一次测试提交,然后检查 HubSpot 记录和 Slack 消息。在发布工作流之前,再测试一个已存在的联系人,以及一次缺少电子邮件地址的提交。

### Customization
修改资格规则,使其符合您的销售流程。更新 Slack 消息,加入团队审核潜在客户时使用的字段。

用分区便签给节点分组

对于有四个或更多节点的工作流,使用白色便签标识相关分区。白色便签在深色模式下显示为灰色。

把每条便签拉伸到能够覆盖或标出多个节点。使用简短标题,例如 ## Validate lead data,必要时最多再加两行简短文字。每条便签不超过 50 个词。

说明一个分区的用途,而不是重复每个节点的名称。例如,描述哪些记录符合某个分支的条件,或者工作流为什么要转换某个字段。

标出关键设置步骤

您可以使用红色警告便签,提醒他人注意关键的设置步骤或风险。把它放在它所针对的那一个节点上。请谨慎使用警告便签。

例如,说明在运行会发送消息的节点之前,必须先更改目的地。

添加演练视频

对于复杂的工作流,或面向初学者的工作流,可以考虑添加设置视频。请保持书面说明完整,使他人不看视频也能使用模板。

要在便签中嵌入 YouTube 视频,请使用 @[youtube](RScKsGfrhs4),并把 RScKsGfrhs4 换成您的视频 ID。

您可以把便签生成工作流作为起点。提交前,请根据这些要求复查生成的便签和节点名称。

添加便签后,请按照提交指南测试并准备您的模板。

相关资源

不想自己部署和维护 n8n?n8ncn 托管 n8n 云服务:开通账号即可使用,不用买服务器;也可以在 n8ncn 工作流库 找现成的中文工作流。