菜单

应用说明文档填写帮助中心

本文档旨在详细介绍应用说明文档结构,帮助开发者更快写出符合用户阅读习惯的文档,降低用户使用难度

特别注意:每个标题要用H2,否则无法与应用说明文档上方的TAB联动

 

应用说明文档分几部分?


共分为两大部分,分别是业务场景和功能介绍。

业务场景面向不懂技术的用户,让用户第一时间了解该应用适用于什么人群,能解决什么痛点问题,应用的核心价值是什么。这一部分很大程度上决定了用户是否会为了开发者的应用买单。

功能介绍面向需要运行应用的用户,包含应用的功能介绍、应用运行时处理的网页、运行时的大致逻辑、应用启动参数和用户需要注意的事项,最后是运行效果展示。

开发者为什么要按要求写文档?


核心目的是提升用户的使用体验,让用户产生购买欲望。因此优化说明文档的同时,就是在提升自己应用的竞争力,同时也能降低开发者的售前售后成本。

业务场景


在三个模块(适用人群、解决痛点、核心价值)下分别填写即可,该部分可以利用AI生成,官方亲测好用的AI提示语如下:

你是一名内容营销人员,现在技术给出了一个RPA应用功能说明,你需要通过这个说明分点解释该应用的适用人群、解决痛点、核心价值。每部分的描述尽可能简短且精准概括,能一眼吸引用户。RPA应用功能说明是“......(替换成您的功能说明)”

举例:

【适用人群】

  1. 电商运营:跨国多站点商品/活动页管理者
  2. 网站管理员:需高频维护海外官网链接的团队

【解决痛点】

  1. 人工低效:告别手动逐条检查,1次配置自动执行
  2. 跨时区难题:覆盖美/英/西/日多站点,可通过定时触发器一天多次自动检测
  3. 隐性损失:及时拦截“变狗”链接,避免用户流失与SEO降权。

【核心价值】

  1. 效率翻倍:10分钟配置,日均释放2小时人力
  2. 风险兜底:0遗漏检测+实时截图存证,修复有据可依
  3. 全球适配:主流电商/官网站点全覆盖,多国市场同步保障

功能介绍(使用说明)


RPA应用功能

纯文本描述即可,写清楚该应用适用于什么平台,能实现什么功能。

举例:

通过预先填写好“待检查链接”的示例表,本RPA应用将自动监控该链接是否已经失效(变狗),最终会输出当前链接的网页截图、是否变狗等信息。目前支持查验美国站、英国站、西班牙和日本站点的链接。
 
通过预先设置好的参数,RPA应用将自动打开小红书网页版,输入关键词和筛选条件,采集笔记的相关数据。每日采集的次数不要太多,频繁采集容易触发小红书平台对账号的安全限制;如需进行大量采集,建议每次替换账号或者环境进行采集

应用运行截图

应用实现目的通常分两大类,一类是数据采集,一类是自动化操作(如自动发帖,自动添加好友)

采集类需要在截图中框选可采集的字段,并文本标注采集了哪些字段;
自动操作类的提供应用主要操作的页面截图即可

运行逻辑图

绘制当前应用的简要流程图,圆角符号代表开始/结束,方形代表动作,菱形代表判断
举例:

启动参数说明

将运行参数界面截图附上,路径:应用右侧操作列--->点击“运行”--->出现运行参数--->截图上传
并在此处解释参数含义
举例:
  1. 示例表文件路径:请先下载示例表格,并在示例表格中输入需要检测的链接,该参数选择保存后的Excel示例表的文件路径。例如:D:\工作文件\检查链接是否变狗_示例表.xlsx

注意事项

填写运行该应用需要注意的事项,比如有的网站需要预登录,有的需要先下载示例表格并填写其中部分数据,有的应用内置了Python代码,需要安装指定包
举例:
  1. 当前应用运行需要用八爪鱼RPA2.0版本,请前往官网下载,https://rpa.bazhuayu.com/download
  2. 请确保WPS或者Word Excel在运行过程中不会出现弹窗
  3. 运行过程中,请不要操作鼠标和键盘

示例附件下载

非必填
如果用户使用该应用需要下载一些附件,例如示例表格,请提供附件下载链接。如果没有附件要下载,该内容可删除。

运行结果预览

上传应用运行成功的效果图,例如如果是采集数据类型的应用,附上采集后的表格图;如果是填写某些输入框(自动发布作品等),附上填写成功的图
举例:
最近修改: 2025-05-13