开发升讯威在线客服系统启示录:怎样编写堪比 MSDN 的用户手册

本系列文章详细介绍使用 .net core 和 WPF 开发 升讯威在线客服与营销系统 的过程。

免费在线使用 & 免费私有化部署:https://kf.shengxunwei.com


文章目录列表请点击这里


视频实拍:演示升讯威在线客服系统在网络中断,直接禁用网卡,拔掉网线的情况下,也不丢消息,不出异常。
https://blog.shengxunwei.com/Home/Post/fe432a51-337c-4558-b9e8-347b58cbcd53


不忘初心 方得始终:开源、免费、共享 之精神 ♥

大部分程序员都不爱写文档,但是为了能让用户快速了解产品,提供指引。好的文档和好的产品一样重要。

既然说产品要容易使用,为什么又讲到要有完善的文档和说明书呢。你要为用户的使用设计一个递进的层次。往往用户是在直接体验,感觉良好之后,才有可能看你的文档和说明书。所以两者不矛盾。

用户根据文档,就能自己完成系统的搭建,一方面使我能够积累到更多的用户,另一方面也减轻了我自己的精力,在有详细文档之前,需要花很多时间回答用户的疑问。

详细的文档为我默默积累了许多前期用户,对于大部分人来说,如果没有详细的文档,他们会直接放弃使用你的产品,而不是来咨询你,这一点很重要。

我归纳为以下几点:

  • 要有好的在线文档系统
  • 仔细设计文档结构
  • 认真编写文档内容
  • 认真对待所有用户的每一个问题

下面我仔细讲讲我是怎么做的。

要有好的在线文档系统

首先我 花了大约 35分钟 时间,写了一个在线文档平台,功能简单,但是做到了版式简明,内容展示清晰。

https://docs.shengxunwei.com/Post/f7bc8496-14ee-4a53-07b4-08d8e3da6269

开发升讯威在线客服系统启示录:怎样编写堪比 MSDN 的用户手册

仔细设计文档结构

我仔细设计了文档的类目结构,一步一步分解了软件的部署和使用过程。
特别是对于私有化部署的过程,我按 部署新服务器、升级现有服务器、服务器维护 等几个大类别,分开进行了详细说明。
在每个大类别下,我又按 Windows、Linux、宝塔、Docker 不同的平台,进一步详细说明。

开发升讯威在线客服系统启示录:怎样编写堪比 MSDN 的用户手册

认真编写文档内容

首先,是简单易懂,图文并茂

不搞玄学,不预设用户是否有经验。一切从 0 开始讲解。每一步都以配图加文字的方式详细讲解。

开发升讯威在线客服系统启示录:怎样编写堪比 MSDN 的用户手册

其次,是严谨认真

对于安装部署的过程,我新开环境干净的服务器,一边实际操作,一边对照写文档。写完之后,释放服务器环境再次重置,然后严格跟着文档再次验证,发现有疏漏的地方就立即补充修改。

认真对待所有用户的每一个问题

在平时收到用户的问题,我从来没有“怎么这都不会”,“怎么这都不知道”这类的想法。
不管什么问题,我都会认真回答,并更新到在线文档中去。经过一段时间的积累,文档越来越完善。

收到用户的热心反馈

在文档上线一段时间后,陆续有用户向我提供积极的反馈。

做为一个程序员,还有什么比这更有成就感的事情呢?

开发升讯威在线客服系统启示录:怎样编写堪比 MSDN 的用户手册


不忘初心 方得始终:开源、免费、共享 之精神


  • 可以追踪正在访问网站或使用 APP 的所有访客,收集他们的浏览情况,使客服能够主动出击,施展话术,促进成单。
  • 访客端在 PC 支持包括 IE8 在内的所有浏览器。
  • 移动端支持手机浏览器、APP、各大平台的公众号。
  • 具备一线专业技术水平,网络中断,拔掉网线,手机飞行模式,不丢消息。同类软件可以按视频方式对比测试。
    ** 优酷视频:https://v.youku.com/v_show/id_XNTEwNzQ5Mzg2OA==.html
    ** bilibili 视频:https://www.bilibili.com/video/BV1pK4y1N7UP?t=22

开发升讯威在线客服系统启示录:怎样编写堪比 MSDN 的用户手册

开发升讯威在线客服系统启示录:怎样编写堪比 MSDN 的用户手册

上一篇:JetBrains的idea、pycharm、Webstrom,internet error 究极解决方案


下一篇:MSDN 我告诉你官方原版系统下载方法教程