最开始对手册产生需求是因为产品上线,没有地方可以存放和分享产品帮助手册,才去寻找在线帮助手册制作的工作,做为一个技术人员首先想到是开源、免费,最好可以自己搭建一个,尝试过很多工具。
gitbook,程序员专享,非技术人员使用非常不方便,这玩意也saas化了,插件也没有维护了,用saas版吧,想想是国外的,最终弃用了。
Docusaurus 这个同样的面向技术人员的,基于md内容,生成静态网站,这个插件相对丰富能满足我们大部分需求,后面由于需要业务人员参于帮助内容维护,协作不便,3个月后,弃用。
后面梳理一下,我们对帮助手册主要的功能诉求是:
美观的界面,简单易于编写,结构易于管理
产品帮助内容的创建过程有很多非技术人员参于,如市场,业务等,工具使用必须简单。
查看、搜索方便,支持文章大纲展示
主要是使用端,产品用户及客服人员需要能快速找到答案。
需要支持多人协作并支持权限控制
内容比较多,需要多部门的人员协作,并且需要有读写权限控制。
需要支持发布功能
需要提前编写更新内容,产品发布后,进行帮助手册同步快速更新。
需要支持多手册管理
需要同时管理多个产品。
需要支持移动端
市场人员、用户需要随时随地查询帮助内容。
最好可以私有化布署
数据安全,内容不丢。
最终我们找到一款可以解决我们诉求的产品-牵牛电子手册(https://fx.beebox.cc/eman),它不仅能满足我们的功能诉求,还提供私有化布署方案,主要特性如下:
牵牛采用的空间-手册-文章三级来管理组织内容,空间是为一个企业或者组织设定的一个区域,每个空间相互独立,一个空间下可以有多个手册。每个手册下还可以按目录分类来管理文章,我们可以根据业务自行划分管理结构,全覆盖组织所有的手册需求, 结构示例如下图所示。
提供类语雀编辑体验,且更专注手册内容创作。
支持插入图片、音频、视频、附件多种内容格式
支持office、pdf、视频、音频文档在线预览
支持嵌入表格,行列可随意增减,文字、图片、附件、状态均可进行添加使用
支持关联文件,方便文档之间进行串联,构建网状信息结构
左侧为手册目录导航,中间文章内容,右侧为文章大纲,可以快速定位文章内容。
内容支持全文检索,并高亮显示命中结果
手机端也可以方便查看
手册支持两个分享场景:
内部分享-组织内部成员可访问。
外部分享-获取到链接的互联网用户可访问
每个空间都可以进行独立的权限管理,支持管理、编辑、查看人员的设置。
牵牛不仅仅有免费的云端版,还支持免费的私有化布署,并提供了容器一键安装模式,数据本地管理。
私有化部署参考这里
综上所述,牵牛电子手册不仅可以满足我们的产品手册承载的诉求,还可以作为下面一些场景里应用。
注册体验:https://fx.beebox.cc/eman