命名原则:Coze插件和工作流workflow

150 阅读3分钟

玩coze的插件和workflow的小伙伴都知道,搓一个bot,背后可能对应1个知识库,3个插件,5个workflow。

还有你调试临时建立的workflow,叫它test-xxx,当天你肯定记得,下周你打开就会想,这玩意干嘛的啊。

以下内功心法就是给大家创建插件和workflow的时候做个参考。

起名字总要有家谱吧,家谱编排原则是什么

命名

当工作流等越来越多的时候,找到这个工作流就是一个难题。

在命名上确保工作流和应用对应起来,可以采取以下策略:

  1. 专用工作流-应用名称作为前缀:将应用的名称作为工作流名称的一部分,这样一来,用户和开发者都能清楚地知道这个工作流是为哪个应用设计的。例如,如果你的应用叫做MyApp,那么为它设计的日志工作流可以命名为myapp-logger
  2. 通用工作流-功能描述:对于通用工作流,重点应放在功能描述上。这种工作流的名称通常不需要特定应用的前缀,而是直接描述其功能,如universal-loggerenhanced-authentication等。
  3. 版本兼容性标示:如果工作流针对应用的特定版本或系列版本,可以在名称中通过后缀来表明这一点。例如,如果工作流只支持MyApp版本3,可以命名为myapp-v3-logger

通过这样的命名策略,工作流的名称不仅帮助开发者和用户快速识别其功能和适用的应用,还能在多个工作流中保持组织和逻辑的清晰。

版本管理

基本原理:命名中不含版本信息已保证兼容,但需要文档记录和声明。

  1. 版本信息通常不包含在工作流基础命名中:在大多数情况下,工作流的基本名称不直接包含版本号。例如,一个用户认证工作流可能命名为 myapp-flow,而不是 myapp-flow-1.0.3
  2. 版本信息在发布和打包中体现:当发布或打包工作流时,版本信息通常体现在文件名、标签或元数据中。例如,发布的文件可能命名为 myapp-flow-1.0.3.zip
  3. 避免在代码或API中硬编码版本信息:在工作流内部,避免硬编码任何特定版本信息,以确保兼容性和维护的灵活性。
  4. 版本兼容性声明:如果工作流设计用于支持特定版本的应用,可以在文档中明确声明这一点,而不是在工作流名称中直接包含。例如,文档中可以说明“适用于 MyApp 版本 3.x”。
  5. 更新日志和版本追踪:维护一个详细的更新日志,每个版本的变更、新增功能和修复都应记录在案。这有助于用户理解版本更新的内容和重要性。

image.png