知识库成长记
知識庫
這是一篇網易云信知識庫自述“我是誰,我從哪里來,我到哪里去”的故事。
01/?固本
網易云信由于豐富的功能、可靠的性能,形成了良好的口碑,吸引了大量的開發者接入。
從開發手冊的角度來說,主要是按照端來分類的,比如Android端開發指南集中介紹Android端接口,iOS端開發指南集中介紹iOS端接口,等等。
橫看成嶺側成峰,遠近高低各不同。在這種文檔模式下,有的開發者需要了解下一些常用的接口在其它各端對應的接口。例如,Android端設置擴展字段后,iOS和Web端怎么接收,反之亦然。這種情況下,開發者在查看開發指南時,需要到不同的頁面去查找。
出于方便開發者的目的,知識庫把這類問題整合到一個條目中,可以一目了然地進行對照,方便開發者各端人員快速協同。
“
這就是知識庫存在的第一個原因:整合歸類。
”一花一世界,一葉一菩提。由于接入的開發者不斷增多,各種不同的產品場景、設備環境、接入姿勢、調用邏輯都有所差異,因此會出現各種各樣的問題。例如,我應該怎樣做才能實現特定的目的?為什么我這樣調用會出現異常?這樣的錯誤提示有哪些原因。
為了解答上述問題,我們整理了一些速查條目,方便開發者按圖索驥、對癥下藥。例如,消息收不到的排查步驟,推送失敗的常見原因,等等。
“
這就是知識庫存在的第二個原因:問題速查。
”金河一去路千千,欲到天邊更有天。知識就像浩瀚的海洋,深邃的宇宙。一個人,即使是某些領域的專家,也不可能掌握所有的知識。開發者在接入某些功能的時候,由于沒有相關的背景經驗,對于一些問題不大容易理解。而開發指南很難詳細地逐一介紹相關的概念和知識。
這時候,知識庫可以作為一定的補充,介紹一些常見的內容。例如,直播推流邏輯簡介,開發者應用邏輯簡介,等等。
“
這就是知識庫存在的第三個原因:背景知識。
”基于這些主要原因,我們把開發者經常咨詢的問題,記錄下來,整理出來,提煉凝聚形成有參考價值的條目內容。
02/ 培元
在2016年發布第一個知識庫版本后,我們一方面不斷完善內容,另一方面不斷優化結構。
九層之臺,起于累土。正如前面提到,知識庫的條目內容主要來源于實際使用過程,我們不斷積累,認真總結,條目逐漸增多,內容不斷豐富。同時,我們也精益求精,盡力確保內容的準確嚴謹。
發展才是硬道理。知識庫版本更新過程中,不斷優化,順勢而為。從實踐中來,到實踐中去。不斷響應建議和需求,最終茁壯成長,至今已發布27個版本。
重要的功能升級點包括:
從最初單一靜態頁面,升級為前后端分離、引入數據庫、開發管理系統。
增加評價、反饋、分享功能,以及相應的統計和通知功能
評價功能有助于了解條目內容質量,是否對用戶起到幫助
反饋功能用于搜集意見建議,便于持續優化完善條目內容
分享功能一鍵自動生成帶標題的鏈接,可以方便地粘貼分享
統計功能了解訪客分布情況,輔助印證云信產品的客戶分布
通過統計功能,我們注意到兩點有意思的情況:
一是,知識庫訪客來自全球各地,國外東南亞地區較多,說明現在東南亞確實是黃金市場;
二是,國內訪客最多的省市:北京、廣東、浙江,IT大省名不虛傳。
增加簡單搜索功能,方便通過關鍵詞查找相應內容
條目子標題支持折疊和Tab化,利于內容較多時的展示陳列
增加播放器和上傳SDK的簡易集成示例Demo,方便開發者參考
增加移動端版本,適配移動設備,優化訪問體驗
前端升級VUE框架,體驗實踐主流技術
安全無小事,平安險中求。知識庫的個別訪客出于對技術的研究,或者測試目的,對知識庫發起注入攻擊、DDOS攻擊等惡意行為。對此,我們很深的感觸是,網站無論大小,只要在網絡上運行,都面臨極大的安全風險。
我們在知識庫系統中引入了防注入、頻率控制、黑名單等功能,相對增加一定程度的安全性。但是,我們始終敬畏技術,謹小慎微,深刻地意識到始終面臨極大的安全性挑戰。
03/ 明心
聚沙成塔、聚義行天下。知識庫的從零開始、固本培元,這是一個見證積少成多、恒心出奇跡,學以致用、實踐促創新的過程。云信知識庫發展至今,主要由技術支持和解決方案同事堅持不斷地整理和豐富內容,同時也得到產品、開發、商務、市場等部門同事的關心和協助,還搜集到一些開發者熱心的意見和建議。
別具匠心、精益求精。2019年,知識庫累計訪問約7萬條次,條目被分享3000多次,共有13位人員參與貢獻近200次。我們秉承”網易出品、必屬精品”的匠心精神,嚴格審核、精心編輯、反復打磨、不斷優化條目內容,并且持續進行查漏補缺、夯實完善工作。
不忘初心、方得始終。我們將繼續堅持為開發者服務的理念,作為開發指南的補充,為開發者更快地接入、更好地體驗云信產品貢獻力量。站在更高的角度來說,通過連接開發者,協助云信產品助力客戶企業成長。
點擊閱讀原文,進入網易云信知識庫。
總結
- 上一篇: WebRTC系列之音频的那些事
- 下一篇: 万里目联合网易云信 引领奢侈品电商新风潮