系统的使用文档应该怎么写?

作为一个功能比较复杂的产品系统,都需要一个专门的帮助页面,帮助用户去更好的使用产品,方便用户遇到问题后进行查阅解决。

软件系统的帮助文档一般都叫“XX帮助中心”、“XX帮助文档”,告知用户遇到什么问题,怎么去解决,并且用系统的相应截图,告知用户如何操作,达到什么目的;另一种是偏需求类的帮助文档,一般都应用在B端产品,告知用户为什么这样操作,下面简单分析一下这两种帮助文档的写法分析。

帮助手册类使用文档

这种多用于简单逻辑的产品,大多数的逻辑在页面上可以展示,用户只需要产品的使用流程,在哪些地方找到哪些功能即可,用基本的截图或者视频演示,配上简单的文字说明即可。一般分为几大板块:热门问题、基本操作、产品演示视频、更新公告等。内容页面撰写的结构一般是功能模版-系统截图-操作步骤-注意事项等。

需求类使用文档

需求类的说明文档一般应用在复杂的B端产品中,很多隐藏的页面逻辑很难在页面展示出来,需要通过后台设定流程和逻辑,因此需要给用户讲清楚业务逻辑之后再进行上方帮助手册类的写作。一般是部分业务流程的讲解-系统截图-功能模块的划分-操作步骤-注意事项。
下面给大家演示一下使用Baklib制作的帮助文档。


预览地址:https://help.wsgjp.com/

一、首页

整个首页颜色符合产品的调性,添加导航栏目引导用户到产品使用页面,首页添加搜索功能,用户直接通过搜索关键词即可查找到相应的解决方法。

二、板块

分为三个大板块:用户操作手册、资料库、产品功能引导,每个分类下面进行相应的栏目分类,相应的功能导航一目了然。

三、帮助文档内容页面

对于常见问题的解决方案,运用图片+文字或者文字+视频的形式进行解答,右侧导航栏帮助用户更快定位到操作步骤处。

除此之外Baklib还有其他特色插件功能:

多种插件功能免费使用

1.站点权限等级设置,可以对站点、栏目、文章的访问等级进行设置,轻松把控访问人员的访问内容
2.站点域名:提供免费的二级域名,也可以绑定自己的独立域名,有利于搜索引擎优化,宣传引流;
3.团队协同:可以邀请多人一起为站点贡献内容,比如可以把撰稿、编辑、校对和审核的工作交给不同成员,各司其责,构建准确严谨的网站内容;
4.访客统计:通过插件可以集成多个第三方访问统计代码,实时了解您的站点被访问的情况,生成访客画像,优化内容;
5.全文检索:类似百度的搜索方式,关键词高亮,快速查询网站内容;
6.文章反馈和关键词统计:了解访客最关心的内容,及时做出网站内容调整;
......
使用地址:https://www.baklib.com/?utm_content=7&utm_source=csdn

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值