插件文档撰写结构

1. 简介

1.1 插件简介

1.2 应用场景

1.3 预期效果

1.4 使用说明(若没有对应的功能依赖,仅说明插件是否付费即可

1)插件付费说明有以下三种模板,可根据当前插件类型选择一种即可:

  • xxx插件为付费插件,每次调用插件消耗 xx 个 云币。在使用插件时自动扣除云币数量,当云币余额可支付的识别次数为 0 时,将无法使用xxxx插件。(付费插件说明示例
  • 该插件为免费插件,付费版用户可免费使用。(免费插件说明示例
  • xxx插件为免费插件,但用户需要自行前往 xxxx平台 购买相关服务。购买成功后,才可使用xxxx插件。(插件在简道云平台免费,但需购买第三方服务说明示例。在此说明完成后,需在文末增加【7. 价格说明】

2)该插件需要具有 API 权限才能使用。(功能依赖说明示例

2. 第三方平台配置(若没有对接第三方平台,可忽略此步骤

2.1 步骤一(给出步骤名称)

2.2 步骤二

2.3 步骤……

3. 插件安装及配置

3.1 安装插件

3.1.1 直接安装

1)您可点击右方链接直接安装插件:xxxxxx(给出插件安装链接)。

2)安装成功后,可参考本文【3.2 配置插件】和【3.3 启用插件】,前往开放平台 >> 插件管理处配置并启用插件。

3.1.2 插件市场安装

3.2 配置插件(若没有配置插件过程,可忽略此步骤

3.3 启用插件

4. 表单搭建

插件使用体验可先安装:xxxxx 插件模板表单,本文将按照示例表单进行讲解。(该模板链接由简道云根据文档中 demo 迁移搭建后给出,开发者无需设置该 demo 链接)

5. 前端事件/智能助手配置

该插件支持在 前端事件 智能助手 中调用触发,本文以前端事件/智能助手调用触发为例,进行插件的调用配置。如下所示:(前端事件/智能助手任选一种进行配置讲解说明即可

5.1 添加前端事件 / 添加智能助手

5.2 设置事件名称和说明(若以智能助手调用触发可忽略此步

5.3 设置触发动作

5.4 设置执行动作

5.5 效果演示

效果参见本文【1.3 预期效果】

6. 流程节点设置

(根据插件使用的具体步骤,【5. 前端事件/智能助手配置】和【6. 流程节点设置】任选其一即可)

6.1 流程发起节点

6.2 插件节点

6.2.1 添加插件节点

6.2.2 设置插件节点

6.3 启用流程

7. 自定义按钮配置

7.1 配置自动同步按钮

7.2 配置插件节点

7.3 配置xxxx节点

7.4 效果演示

8. 注意事项

9. 价格说明

注:此处价格说明为,若插件需要购买第三方平台服务的价格说明。若插件无需对接第三方平台,此步骤可省略。

10. 联系方式

该插件为官方合作的服务商开发,若您在使用过程中有任何疑问,可通过以下方式咨询:

  • 公司:
  • 联系人:
  • 联系电话:

文档内容是否对您有帮助?
有帮助
没帮助没帮助
如需获取即时帮助,请联系技术支持
咨询
扫码领取100+零代码资料简道云官方微信号400-111-0890
图标在线咨询
立即体验