知识库成长记

这是一篇网易云信知识库自述“我是谁,我从哪里来,我到哪里去”的故事。

一、 固本

网易云信由于丰富的功能、可靠的性能,形成了良好的口碑,吸引了大量的开发者接入。

从开发手册的角度来说,主要是按照端来分类的,比如Android端开发指南集中介绍Android端接口,iOS端开发指南集中介绍iOS端接口,等等。

横看成岭侧成峰,远近高低各不同。在这种文档模式下,有的开发者需要了解下一些常用的接口在其它各端对应的接口。例如,Android端设置扩展字段后,iOS和Web端怎么接收,反之亦然。这种情况下,开发者在查看开发指南时,需要到不同的页面去查找。

出于方便开发者的目的,知识库把这类问题整合到一个条目中,可以一目了然地进行对照,方便开发者各端人员快速协同。

这就是知识库存在的第一个原因:整合归类。

一花一世界,一叶一菩提。由于接入的开发者不断增多,各种不同的产品场景、设备环境、接入姿势、调用逻辑都有所差异,因此会出现各种各样的问题。例如,我应该怎样做才能实现特定的目的?为什么我这样调用会出现异常?这样的错误提示有哪些原因。

为了解答上述问题,我们整理了一些速查条目,方便开发者按图索骥、对症下药。例如,消息收不到的排查步骤,推送失败的常见原因,等等。

这就是知识库存在的第二个原因:问题速查。

金河一去路千千,欲到天边更有天。知识就像浩瀚的海洋,深邃的宇宙。一个人,即使是某些领域的专家,也不可能掌握所有的知识。开发者在接入某些功能的时候,由于没有相关的背景经验,对于一些问题不大容易理解。而开发指南很难详细地逐一介绍相关的概念和知识。

这时候,知识库可以作为一定的补充,介绍一些常见的内容。例如,直播推流逻辑简介,开发者应用逻辑简介,等等。

这就是知识库存在的第三个原因:背景知识。

基于这些主要原因,我们把开发者经常咨询的问题,记录下来,整理出来,提炼凝聚形成有参考价值的条目内容。

二、 培元

在2016年发布第一个知识库版本后,我们一方面不断完善内容,另一方面不断优化结构。

九层之台,起于累土。正如前面提到,知识库的条目内容主要来源于实际使用过程,我们不断积累,认真总结,条目逐渐增多,内容不断丰富。同时,我们也精益求精,尽力确保内容的准确严谨。

发展才是硬道理。知识库版本更新过程中,不断优化,顺势而为。从实践中来,到实践中去。不断响应建议和需求,最终茁壮成长,至今已发布27个版本。

重要的功能升级点包括:

Ø 从最初单一静态页面,升级为前后端分离、引入数据库、开发管理系统。

Ø 增加评价、反馈、分享功能,以及相应的统计和通知功能

l 评价功能有助于了解条目内容质量,是否对用户起到帮助

l 反馈功能用于搜集意见建议,便于持续优化完善条目内容

l 分享功能一键自动生成带标题的链接,可以方便地粘贴分享

l 统计功能了解访客分布情况,辅助印证云信产品的客户分布
通过统计功能,我们注意到两点有意思的情况:
一是,知识库访客来自全球各地,国外东南亚地区较多,说明现在东南亚确实是黄金市场;
二是,国内访客最多的省市:北京、广东、浙江,IT大省名不虚传。

Ø 增加简单搜索功能,方便通过关键词查找相应内容

Ø 条目子标题支持折叠和Tab化,利于内容较多时的展示陈列

Ø 增加播放器和上传SDK的简易集成示例Demo,方便开发者参考

Ø 增加移动端版本,适配移动设备,优化访问体验

Ø 前端升级VUE框架,体验实践主流技术

安全无小事,平安险中求。知识库的个别访客出于对技术的研究,或者测试目的,对知识库发起注入攻击、DDOS攻击等恶意行为。对此,我们很深的感触是,网站无论大小,只要在网络上运行,都面临极大的安全风险。

我们在知识库系统中引入了防注入、频率控制、黑名单等功能,相对增加一定程度的安全性。但是,我们始终敬畏技术,谨小慎微,深刻地意识到始终面临极大的安全性挑战。

三、 明心

聚沙成塔、聚义行天下。知识库的从零开始、固本培元,这是一个见证积少成多、恒心出奇迹,学以致用、实践促创新的过程。云信知识库发展至今,主要由技术支持和解决方案同事坚持不断地整理和丰富内容,同时也得到产品、开发、商务、市场等部门同事的关心和协助,还搜集到一些开发者热心的意见和建议。

别具匠心、精益求精。2019年,知识库累计访问约7万条次,条目被分享3000多次,共有13位人员参与贡献近200次。我们秉承”网易出品、必属精品”的匠心精神,严格审核、精心编辑、反复打磨、不断优化条目内容,并且持续进行查漏补缺、夯实完善工作。

不忘初心、方得始终。我们将继续坚持为开发者服务的理念,作为开发指南的补充,为开发者更快地接入、更好地体验云信产品贡献力量。站在更高的角度来说,通过连接开发者,协助云信产品助力客户企业成长。

了解网易云信知识库>>>

了解网易云信,来自网易核心架构的通信与视频云服务>>

你可能感兴趣的:(知识库)