1.0 文档信息
|
系统归属
|
WEB;BE
|
文档版本
|
1.0.3
|
|
撰写人
|
@Saber.tang
|
编写日期
|
2025-09-25
|
2.0 修订记录
|
版本号
|
日期
|
属性
|
描述
|
|
1.0.3
|
2025-10-17
|
新增
|
-
新增:备注名字段
|
|
1.0.2
|
2025-10-16
|
新增
|
-
新增:8.3 边界场景
-
新增:批量上传逻辑说明
|
|
1.0.1
|
2025-10-13
|
新增
|
-
新增:筛选项新增编号搜索
-
新增:hover 状态时的说明
-
新增:栏目选项(新增后有 5 个栏目选项)
-
修改:新增/编辑页面,添加语言改为语言(文案修改)
-
修改:筛选项和字段删除标题
-
完善:帮助中心和通用文章状态同步说明
|
|
1.0.0
|
2025-09-25
|
新增
|
新增文档
|
3.0 关联清单
4.0 需求背景
在推进新人转化专项需求落地时,需解决「多页面展示帮助中心文档」的问题,初始评估两种方案存在明显局限:
-
前端写死:提前确定文档内容由前端录入,更新需重新发版,灵活性差,文档更新与管理效率低。
-
页面单独开发后台:为每个业务页面单独开发运营管理后台,功能重复开发导致研发成本高,且无法实现多页面统一管理。
经与 @Clio.zhou @Kui.pan @May.liu @Nicole.zhang 讨论确认,最终确定开发通用化文章展示功能,支持多业务页面灵活调用文档,既能节省研发资源、简化文档管理流程,也为后续扩展至更多业务页面预留空间。
5.0 需求目标
-
提高管理便捷性:通过统一管理和同步更新,确保各业务页面文档与帮助中心更新状态实时一致。
-
保障可扩展性:预留扩展能力,未来可快速将功能接入更多业务页面,无需重复开发。
-
节省人力:减少研发重复开发后台的工作量,降低运营重复配置的时间成本,提升整体协作效率。
-
用户体验优化:支持文档排序和封面文章功能,让页面内容展示更具逻辑性,增强对用户的引导效果。
目前需要调用该功能的任务清单如下:
https://project.larksuite.com/lbk/story/detail/7495848
https://project.larksuite.com/lbk/story/detail/7483961
https://project.larksuite.com/lbk/story/detail/8151128
6.0 方案设计
由于 【APP+WEB+TWALK+BE】【新人专项】【首次合约转化】【9月】合约入门落地页 已做了管理页面,因此决定在该页面基础之上做迭代优化。
目前 @Boris.bao 对合约入门落地页的新手教程功能还没做完,因此方案分为两部分,需要活动线研发支持:
-
完成现有的合约入门落地页的新手教程
-
对新手教程做优化和功能迭代。
8.0 需求详情
8.1 现有合约入门落地页的新手教程需求
|
页面
|
截图和说明
|
|
新手教程
|
用户控制客户端「新手教程」显示哪些文章,以及文章的排序;文章从「运营管理-内容中心-公告&帮助中心」,以编号的形式获取。
筛选项
-
编号:搜索框
-
标题:搜索框(搜索默认语言的标题)
-
状态:select 下拉框
表格字段:
-
编号:同「公告&帮助中心」编号
-
标题:默认语言的标题,从「公告&帮助中心」获取
-
排序值:控制文章显示顺序;越大越靠前;
-
创建人
-
创建时间
-
修改人
-
修改时间
-
帮助中心状态:同「公告&帮助中心」状态,禁用,不可编辑
-
合约落地页状态:
-
on/off:是否显示文章
-
帮助中心状态为 on 时,合约入门落地页状态可以为 on/off
-
帮助中心状态为 off 时,合约入门落地页状态必须为 off(数据单向同步);帮助中心状态有更新时,合约入门落地页状态同步更新。
-
操作
-
预览:点击新页面,打开默认语言的文章
-
编辑:显示「编辑文章」抽屉
-
删除:显示「删除确认」弹窗
新增文章
-
编号:input 输入框
-
未输入:提示文案 请输入
-
未输入:点击「同步」,message error 提示「请输入编号」
-
已输入:点击「同步」,同步按钮 loading 中
-
编号输入正确:message success 提示「同步成功」
-
编号输入错误/找不到:message error 提示「编号错误,请重新输入」
-
网络等错误:message error 提示「网络错误,请重试」
-
语言:
-
未同步编号:图三所示
-
已同步编号:图四所示
-
显示默认语言(排第一)
-
显示其他语言
-
封面上传:upload 上传组件,逻辑同「广告管理」;用于在客户端显示
-
排序值:逻辑同「广告管理」;用于在客户端控制文章顺序
-
帮助中心文章状态:显示该文章在帮助中心的当前状态;禁用不可编辑;
-
状态为启用,就显示启用;状态为禁用,就显示禁用
-
合约入门落地页文章状态:
-
默认为启用
-
当帮助中心文章状态为禁用,合约合约入门落地页状态必须为禁用
编辑文章
-
禁用编号,无法修改
-
其他同新增
交互:
-
在表格字段,切换「合约落地页状态」状态,popconfirm 提示「确认要启用吗」「确认要禁用吗」,图二所示
-
在表格字段,点击删除,popconfirm 提示,「确认要删除吗」,图二所示
|
8.2 文章显示管理(新手教程的迭代需求)
|
页面
|
截图和说明
|
|
入口
|
将原有「运营管理-运营工具-合约入门新手教程」移动至「运营管理-内容中心-公告&帮助中心」的下方,并重命名为「文章显示管理」
|
|
文章显示管理
|
页面作用:
-
控制客户端某个页面显示哪些文章,以及文章的排序;文章从编号的形式获取。
页面改动点(图一):
-
表格筛选项:
-
编号:input 输入框
-
备注名:input 输入框
-
栏目:select 单选下拉框
-
状态:select 单选下拉框
-
表格字段:
-
编号:同「公告&帮助中心」编号
-
备注名:同「公告&帮助中心」备注名
-
标题:默认语言的标题,从「公告&帮助中心」获取
-
栏目;显示文章对应的栏目,多个用 ;分隔符
-
状态:当帮助中心文章状态为禁用,hover 状态的 switch 按钮时,提示 帮助中心为禁用状态,暂不支持修改
-
按钮:添加文章按钮改为关联文章 ; 对应的新增/编辑弹窗标题需一起修改
关联文章改动点(图二图三)
-
备注名:
-
select 下拉框;可搜索可输入
-
只显示「公告&帮助中心」已启用的文章
-
原有「语言」选项:删除
-
添加语言和标题:新增项
-
作用:用于控制客户端文章显示的语言和标题(即同一份文章,允许在「公告&帮助中心」显示 LBank 新手指南:合约入门新手教程,在其他页面(通过此功能),显示 合约入门新手教程)
-
状态:
-
编号未同步时,语言和标题为空
-
同步成功后,展示源文章支持的所有语言;语言选项禁用,不可新增或删除语言;可以修改标题
-
每个语言对应一个标题输入框,运营可选择性填写自定义标题;
-
若不填写:前端显示时,将直接采用该语言对应的原始标题;点击预览按钮,新页面显示「原始标题 + 文章正文」
-
若填写:前端显示时,将使用此处填写的自定义标题; 点击预览按钮,新页面显示「原始标题 + 文章正文」
-
标题支持批量导入(即批量导入自定义标题)
-
交互参考「花猫广告管理-广告管理」
-
新增 栏目 :
-
控制文章在哪些页面显示;select 下拉框,可搜索可多选
-
选项:合约入门落地页;现货帮助中心;现货杠杆帮助中心;合约帮助中心 ;APP 下载页
-
修改「封面上传」:改为可选;若不上传,则前端显示时,不展示封面图。
-
编辑:
-
备注名禁用,不可编辑
帮助中心状态和状态的同步说明:
-
新增时:
-
帮助中心状态为 on 时,状态可以为 on/off
-
帮助中心状态为 off 时,状态必须为 off(数据单向同步);
-
帮助中心状态有更新时,状态半同步更新:
-
帮助中心从 off 改为 on,状态不变 也改为 on
-
帮助中心从 on 改为 off,状态改为 off
批量上传模版
articleTitle.xlsx
批量上传只更新语言代码匹配的部分:
-
场景一:文章语言代码 9 个,批量上传文件有 12 个,匹配成功 9 个,最后更新 9 个
-
场景二:文章语言代码 9 个,批量上传文件有 9 个,匹配成功 9 个,最后更新 9 个
-
场景三:文章语言代码 9 个,批量上传文件有 5 个,匹配成功 5 个,最后更新 5 个
-
场景四:文章语言代码 9 个,批量上传文件有 0 个,匹配成功 0 个,最后更新 0 个,提示:Excel 文件为空,请检查
其余同原有逻辑
|
8.3 边界场景
公告中心的文章语言状态的同步问题
1 不管语言状态,同步所有的标题
边界场景
1 公告中心语言从禁用改为启用,文章显示管理 不同步
2 公告中心新增语言,文章显示管理 不同步
后续二期再提需求优化,一期不改
9.0 测试验收
|
序号
|
问题和说明
|
|
1
|
删除 运营工具-合约入门新手教程
|
|
2
|
-
删除红框内的文章显示管理
-
将选中的文章显示管理移动至「公告帮助中心」下方
|
|
3
|
-
在公告帮助中心复制备注名,直接粘贴到输入框,没有搜索结果;但是手动输入是有的
-
没有搜索结果后,关闭下拉框,再重新选中,下拉框的内容一直在 loading(如上图);必须要关闭面板,重新点击关联文章,才能重新显示下拉框内容。
|
|
4
|
所有字段左对齐
|
|
5
|
-
需要确认下现在前端是最多显示多少条,后端配置了 14 条,但前端只显示 8 条
-
和设计师、业务方已确认,web\app 最多显示 10 条
|
|
6
|
-
新手指南点击广告位,也是在新 tab 页面打开
|
10.0 运营配置说明
功能位于 「运营工具-文章显示管理」
-
作用:目前可控制现货/现货杠杆/合约的新手指南、合约入门落地页、App 下载页五个场景的显示哪些文章
-
数据来源:
-
文章显示管理的文章都是从「公告帮助中心」获取的
-
因此,如果有一篇新文章想要在上述 5 个场景展示,需要先在「公告帮助中心」新增,再在「文章显示管理」配置
关联文章的步骤:
-
编号:输入编号,进行搜索、
-
备注名:无需填写,搜索编号后自动显示
-
显示标题:
-
重新编辑标题,例如在「公告帮助中心」页面,显示的标题是 LBank新手必做攻略:如何进行现货交易
-
但是觉得标题太长,于是改成了 如何进行现货交易,最后在用户看来, 就是显示 如何进行现货交易
-
选填,可以不编辑,保留原有标题
-
栏目:这篇文章想要显示在哪个栏目
-
排序值:文章在栏目中的排序值,越大越靠前
-
封面上传:
-
现货/现货杠杆/合约、帮助中心:不需要上传
-
合约入门落地页:需要上传图片,宽高尺寸 384*216
-
状态:
-
启用(默认)
-
禁用:在对应的栏目不显示这篇文章
特殊说明
-
目前选择的文章只能是「公告帮助中心」的帮助中心和公告中心,如果选择了学院/问答平台的,会 404
-
搜索编号后,需要确认在「显示标题」没有变量,如果有变量,需要编辑标题,将变量去掉。
-
例如显示标题是 LBank合約下架YIDAFANG永續合約 ,快来参与
-
需要删除 变量,最终显示 LBank合約下架 YIDAFANG 永續合約
-
关联公告中心的文章时,保存状态必须为「保存」,不要关联「仅保存」的文章