模板提交指南
请提交一个原创工作流:它解决实际问题,导入后能够运行,并包含他人使用它所需的说明。
解决有用的问题
选择具体的受众和结果。说明您的模板处理什么任务,以及这个结果为什么能帮助别人。
构建之前,请先搜索模板库。您的提交应当填补空白,或对现有方法做出有意义的改进。
模板需要有足够的实质内容,才能为他人省下工作。一个触发器只连接到单个操作、一个默认聊天机器人,或一次孤立的 API 请求,都需要更多上下文或可复用逻辑才符合要求。请把用例发展成完整的解决方案,包含它所需的数据处理、决策和设置。
例如,一个潜在客户接收模板可以检查必填字段、匹配现有联系人、路由合格的潜在客户,并说明不完整记录会如何处理。
在问题允许的范围内尽量保持设计简单。额外的节点不会让模板更有用。一个聚焦的工作流如果能很好地处理某个具体问题,并提供可复用的逻辑或知识,也可以符合要求。
审核 AI 辅助的提交
提示
您可以提交 AI 辅助的作品
只要您已经复查并测试过,AI 生成的工作流、代码、表达式和设置说明都欢迎提交。提交前,您必须理解工作流如何运行,并核实它的说法。
提交前请复查生成的内容:
- 检查每个节点、表达式、代码片段、API 端点和依赖项。替换编造的或不受支持的设置。
- 用有代表性的输入运行工作流。检查其输出(包括 AI 回复)是否准确、有用。
- 让设置说明与工作流一致。移除编造的功能、不受支持的说法、空泛的填充文字,以及不适用的说明。
- 检查链接、拼写和格式。重写那些重复信息、却无助于他人设置或使用模板的文字。
不要提交未经复查的 AI 输出、成批几乎相同的工作流,或只改了名称、提示词或应用选择的通用示例。这些属于低投入提交,不符合质量要求。
提交原创作品
请创建您自己的模板。不要复制、转贴或转售他人的工作流。抄袭将导致账户封禁。
如果您在现有方法上继续构建,请说明您的贡献,并尊重原作者的许可证和许可。
让工作流易于理解
- 重命名节点以描述其用途,例如 Find existing contact 查找现有联系人 或 Route incomplete submissions 路由不完整的提交。
- 排列节点,使他人能够顺着执行路径阅读。
- 遵循便签指南。包含一条概览便签,并在需要时包含分区便签。
- 在可行时,把他人需要更改的值集中到一个 Edit Fields (Set) 编辑字段(Set) 节点中。说明每个值,并使用清晰的占位符。
- 记录所需凭据、权限、外部资源,以及子工作流或社区节点等依赖项。
- 包含该用例所需的错误处理。说明任何需要人工关注的限制或失败。
假定他人可能是 n8n 的新用户。把必需的说明放在模板里。您可以链接到详细的设置指南,或添加演练视频作为补充。
移除密钥和个人数据
使用 n8n 凭据进行身份验证。不要把 API 密钥、令牌、密码或授权标头直接放进节点参数、代码、表达式或便签。
提交前请复查导出的 JSON。移除能识别您账户的凭据名称和 ID、个人电子邮件地址、聊天 ID、电子表格 ID、webhook URL,以及其他私有资源标识符。把可配置的资源值替换为占位符,并说明如何设置它们。
移除敏感的示例数据和固定的执行数据。如果工作流需要示例输入,请包含能展示预期结构的合成数据。
提交前测试模板
请测试您计划提交的那一份 JSON 文件。只在您原来的实例中能运行的工作流,还没有准备好分享。
- 导出工作流,并把它导入一个全新的工作流。
- 按照您的设置说明操作。配置凭据并替换占位符,不要依赖只存在于您原来工作流中的资源。
- 用有代表性的输入运行完整工作流。在目标服务中检查最终结果,而不只是执行状态。
- 走通每个已记录的分支。在适用时测试缺失或空的输入、多条记录,以及失败的服务调用。
- 检查重复执行。如果工作流会创建记录或发送通知,请验证它的重复处理,或说明何时可能发生重复。
- 确认它不依赖固定数据、缺失的子工作流、本地文件或未记录的资源。
- 对于 AI 工作流,尝试不同的输入并复查回复。确认下游节点能够处理输出格式和预期的失败情况。
- 检查便签、截图和设置链接是否与测试过的工作流一致。
当工作流依赖特定版本的行为时,请写明您测试时使用的 n8n 版本。记录所需的节点或软件包版本,以及任何平台限制。不要声称您尚未检查过的兼容性。
使用社区节点的模板
写明每个社区节点软件包的名称,记录您测试的版本,并链接到它的安装说明。
已验证的社区节点可以在 n8n Cloud 和自托管实例上使用。未验证的社区节点需要自托管。请检查具体软件包,并描述支持的设置。请参阅社区节点安装。
当工作流使用社区节点时,请附上一张工作流图片,以便在预览无法渲染时他人仍能查看工作流。同时用文字写上设置说明。
提交检查清单
在您提交模板之前,请确认:
- 它解决一个实际问题,并为模板库带来价值。
- 它是您的作品,并且您已经复查过任何 AI 生成的内容。
- 导出的 JSON 在按照已记录的设置步骤导入后能够运行。
- 您已经检查预期输出和相关的失败情况。
- 您已经移除密钥、私有标识符和敏感数据。
- 节点有描述性名称,并且必需的便签都在。
- 工作流的便签写明了要求、设置步骤、行为和限制。