术语和命名
本页面是风格指南的配套内容:风格指南介绍写作风格、格式和结构,本页面则是产品术语的 source of truth。
n8n 文档力求在所有页面中为同一概念使用同一术语,并优先使用官方产品术语,而不是看似合理的同义词。术语一致性有助于读者理解,也会直接改善 AI tools(search、docs assistant 和 coding agents)查找和使用文档的效果。
大小写
- 正文中使用 sentence case: "Add a trigger node"、"create a sub-workflow"。
- 对于真实 UI label 或 node name,使用粗体并保留产品中的精确大小写: "Select Add trigger"、"the HTTP Request node"。与界面显示保持一致。
- 产品名称写作
n8n,始终小写,即使位于句首也一样。
核心概念
| 使用 | 不要使用 |
|---|---|
| workflow | flow、automation(作为整个流程的名词时)、scenario、pipeline、zap |
| node | step、block、action、module |
| execution(workflow 的一次运行) | run(作为名词时)、job、invocation |
Workflow lifecycle
| 使用 | 不要使用 |
|---|---|
| publish、unpublish a workflow;published workflow | activate、deactivate、enable、disable、turn on、go live、deploy |
| run、execute a workflow(动词) | kick off、fire |
| pin data;pinned data | mock data、freeze data、lock data、sample data |
Nodes
| 使用 | 不要使用 |
|---|---|
| app node | integration node、service node |
| core node | system node |
| cluster node;root node;sub-node | parent node、child node、super node |
| community node(可安装、由 community 发布) | custom node、third-party node、plugin、add-on |
| Execute Sub-workflow Trigger node;Execute Sub-workflow node | Execute Workflow Trigger node、Execute Workflow node(已弃用的名称) |
| AI Agent node | Agent node(单独使用) |
Credentials 和 connections
| 使用 | 不要使用 |
|---|---|
| credential(存储服务的身份验证详情) | 将 connection 作为 credential 的同义词 |
| connection(画布上两个节点之间的连接) | wire、link |
n8n 界面有时会将 credential 的身份验证链接标为“connection”(例如私有 credential 的共享消息)。在文档中请区分两者:credential 用于向服务进行身份验证;connection 用于连接画布上的节点。
Canvas 和 editor
请遵循两条大小写规则:只有在术语是选择、点击或打开操作的直接目标时才将其加粗;仅表示位置时不要加粗。定义元素的名称只将首个单词大写(例如“Workflow menu”,不要写成“Workflow Menu”)。
| 使用 | 不要使用 |
|---|---|
| canvas | editor board、diagram、workspace、graph |
| sticky note | comment、annotation、label、memo |
| sub-workflow | subworkflow、sub workflow、subflow、child workflow、nested workflow |
| left menu(应用范围的左侧导航,包含 Overview、Projects、Favorites 等) | sidebar、left sidebar、navigation menu、main menu |
| Canvas header(画布顶部栏,包含项目/工作流名称、Workflow menu、editor/executions/evaluations 切换和 Publish) | top navigation bar、top menu |
| Workflow menu(水平 ⋯ 图标,位于 Canvas header 中) | three dots icon、the three dots、Options(垂直图标专用) |
| Options menu(垂直 ⋮ 图标;按行或按项显示的菜单,不是画布元素) | 含义不明确的 three-dot menu、three dots menu |
| Nodes panel(通过画布的 + 按钮打开) | Node Panel(单数且大写)、add node menu、“What happens next?” panel |
| Node details view(双击节点打开) | node editor view、未先定义的 NDV |
| input panel;output panel(Node details view 的侧边面板) | 大写的 Input panel/Output panel、INPUT/OUTPUT pane |
| Logs panel(画布底部) | bottom panel、bottom menu、canvas footer |
Workflow menu 图标是 three-dots-horizontal.png;Options menu 图标是 three-dot-options-menu.png。提及这些菜单时请使用内联图标,格式参阅风格指南。
AI 和 agents
| 使用 | 不要使用 |
|---|---|
| sub-agent | subagent、child agent |
n8n 有多个用于构建工作流的 AI 功能。每个功能都是具体的 n8n 产品名称,而不是泛称,请勿混用:
| 使用 | 不要使用 |
|---|---|
| n8n Assistant(基于聊天的 agent:创建、编辑、测试和发布工作流与 agents) | assistant、the AI、chatbot、AI Assistant |
| AI Workflow Builder(旧版,根据提示生成和完善单个工作流) | workflow builder、builder |
| Ask n8n AI(旧版帮助 assistant,不再积极开发,应将读者指向 n8n Assistant) | 将 AI assistant 作为其同义词、help assistant |
功能成熟度
| 使用 | 不要使用 |
|---|---|
| Preview(功能成熟度标签,首字母大写) | beta、alpha、early access |
Platform 和 deployment
| 使用 | 不要使用 |
|---|---|
| self-hosted | self hosted、on-premise、on-premises、on-prem |
| n8n Cloud | Cloud、hosted version、SaaS、the cloud、managed n8n |
| instance(运行中的 n8n 系统) | server、box、deployment(作为运行中系统的名词时) |
| Enterprise(plan) | enterprise edition、premium、paid tier |
| Cloud console(位于 app.n8n.cloud 的 n8n Cloud Web 应用,实例所有者可在其中管理实例、plan、计费和 credits) | admin dashboard、admin panel、Cloud dashboard、Cloud admin dashboard |
“Deployment”并非一概禁止:用于表示部署这一行为时(如“deployment methods”“the deployment finishes”),或指 Kubernetes 的 Deployment 资源时,可以使用。只有当它作为运行中 n8n 系统的名词时,才应改用“instance”。
在页面中首次提及时写作“n8n Cloud console”,以便与 Google Cloud Console 等其他厂商的 console 区分;之后写作“Cloud console”。将在其中管理的 n8n Cloud 系统称为“instance”,而不是“workspace”。n8n 编辑器左侧菜单中指向 Cloud console 的链接标为 Admin Panel:仅在指导读者选择该链接的步骤中使用这一准确标签。
Plans 和 tiers
请使用以下准确且首字母大写的 plan 名称(从低到高)。不要自行创造替代名称(例如“professional plan”或“team tier”):
- n8n Cloud: Starter、Pro、Enterprise
- Self-hosted: Community、Registered Community、Business、Enterprise
同时指代所有 tier 时,请写“All plans”或“All editions”,不要逐一列出。
Features
| 使用 | 不要使用 |
|---|---|
| project | workspace、team space |
| folder | directory(app 中)、group |
| environment variable | env(作为名词时)、config var |
| data table | database table、datatable、the table feature |
| Environments(功能名);Environments (Classic)(早期的源代码控制功能) | Environments v2、promotions(作为功能名)、Git connections |
| environment(发布流程中的一个阶段,以及运行它的实例) | promotion target、stage(指代 environment 时) |
| promote to、apply from(某个 environment) | promote from、apply to,以及用 push、pull、deploy 或 sync 来称呼 promote 和 apply |
| provider(将 n8n 连接到 Git 托管平台并完成身份验证) | Git connection、connection(指代 provider 时) |
| promotion review(n8n 的审批步骤) | merge request 或 pull request(指代 Git 托管平台上的对象时除外) |
| Git-based promotion | Git sync |
用 “instance” 指代正在运行的 n8n 系统。动作只与 environment 搭配:promote to 一个 environment,apply from 一个 environment。指代实例时,写 “the instance that promotes”(源实例)和 “the instance that applies”(目标实例),不要写 “the instance you promote from” 或 “the instance you apply to”。
Product 和 brand names
| 使用 | 不要使用 |
|---|---|
| n8n(始终小写) | N8n、N8N、n8N |
| GitHub、npm、JavaScript、OAuth2 | Github、NPM、Javascript、oAuth |