知識庫

這是一篇網(wǎng)易云信知識庫自述“我是誰，我從哪里來，我到哪里去”的故事。

01/?固本

網(wǎng)易云信由于豐富的功能、可靠的性能，形成了良好的口碑，吸引了大量的開發(fā)者接入。

從開發(fā)手冊的角度來說，主要是按照端來分類的，比如Android端開發(fā)指南集中介紹Android端接口，iOS端開發(fā)指南集中介紹iOS端接口，等等。

橫看成嶺側(cè)成峰，遠近高低各不同。在這種文檔模式下，有的開發(fā)者需要了解下一些常用的接口在其它各端對應(yīng)的接口。例如，Android端設(shè)置擴展字段后，iOS和Web端怎么接收，反之亦然。這種情況下，開發(fā)者在查看開發(fā)指南時，需要到不同的頁面去查找。

出于方便開發(fā)者的目的，知識庫把這類問題整合到一個條目中，可以一目了然地進行對照，方便開發(fā)者各端人員快速協(xié)同。

“

這就是知識庫存在的第一個原因：整合歸類。

”

一花一世界，一葉一菩提。由于接入的開發(fā)者不斷增多，各種不同的產(chǎn)品場景、設(shè)備環(huán)境、接入姿勢、調(diào)用邏輯都有所差異，因此會出現(xiàn)各種各樣的問題。例如，我應(yīng)該怎樣做才能實現(xiàn)特定的目的？為什么我這樣調(diào)用會出現(xiàn)異常？這樣的錯誤提示有哪些原因。

為了解答上述問題，我們整理了一些速查條目，方便開發(fā)者按圖索驥、對癥下藥。例如，消息收不到的排查步驟，推送失敗的常見原因，等等。

“

這就是知識庫存在的第二個原因：問題速查。

”

金河一去路千千,欲到天邊更有天。知識就像浩瀚的海洋，深邃的宇宙。一個人，即使是某些領(lǐng)域的專家，也不可能掌握所有的知識。開發(fā)者在接入某些功能的時候，由于沒有相關(guān)的背景經(jīng)驗，對于一些問題不大容易理解。而開發(fā)指南很難詳細地逐一介紹相關(guān)的概念和知識。

這時候，知識庫可以作為一定的補充，介紹一些常見的內(nèi)容。例如，直播推流邏輯簡介，開發(fā)者應(yīng)用邏輯簡介，等等。

“

這就是知識庫存在的第三個原因：背景知識。

”

基于這些主要原因，我們把開發(fā)者經(jīng)常咨詢的問題，記錄下來，整理出來，提煉凝聚形成有參考價值的條目內(nèi)容。

02/ 培元

在2016年發(fā)布第一個知識庫版本后，我們一方面不斷完善內(nèi)容，另一方面不斷優(yōu)化結(jié)構(gòu)。

九層之臺，起于累土。正如前面提到，知識庫的條目內(nèi)容主要來源于實際使用過程，我們不斷積累，認(rèn)真總結(jié)，條目逐漸增多，內(nèi)容不斷豐富。同時，我們也精益求精，盡力確保內(nèi)容的準(zhǔn)確嚴(yán)謹(jǐn)。

發(fā)展才是硬道理。知識庫版本更新過程中，不斷優(yōu)化，順勢而為。從實踐中來，到實踐中去。不斷響應(yīng)建議和需求，最終茁壯成長，至今已發(fā)布27個版本。

重要的功能升級點包括：

• 從最初單一靜態(tài)頁面，升級為前后端分離、引入數(shù)據(jù)庫、開發(fā)管理系統(tǒng)。

• 增加評價、反饋、分享功能，以及相應(yīng)的統(tǒng)計和通知功能

評價功能有助于了解條目內(nèi)容質(zhì)量，是否對用戶起到幫助

反饋功能用于搜集意見建議，便于持續(xù)優(yōu)化完善條目內(nèi)容

分享功能一鍵自動生成帶標(biāo)題的鏈接，可以方便地粘貼分享

統(tǒng)計功能了解訪客分布情況，輔助印證云信產(chǎn)品的客戶分布
通過統(tǒng)計功能，我們注意到兩點有意思的情況：
一是，知識庫訪客來自全球各地，國外東南亞地區(qū)較多，說明現(xiàn)在東南亞確實是黃金市場；
二是，國內(nèi)訪客最多的省市：北京、廣東、浙江，IT大省名不虛傳。

• 增加簡單搜索功能，方便通過關(guān)鍵詞查找相應(yīng)內(nèi)容

• 條目子標(biāo)題支持折疊和Tab化，利于內(nèi)容較多時的展示陳列

• 增加播放器和上傳SDK的簡易集成示例Demo，方便開發(fā)者參考

• 增加移動端版本，適配移動設(shè)備，優(yōu)化訪問體驗

• 前端升級VUE框架，體驗實踐主流技術(shù)

安全無小事，平安險中求。知識庫的個別訪客出于對技術(shù)的研究，或者測試目的，對知識庫發(fā)起注入攻擊、DDOS攻擊等惡意行為。對此，我們很深的感觸是，網(wǎng)站無論大小，只要在網(wǎng)絡(luò)上運行，都面臨極大的安全風(fēng)險。

我們在知識庫系統(tǒng)中引入了防注入、頻率控制、黑名單等功能，相對增加一定程度的安全性。但是，我們始終敬畏技術(shù)，謹(jǐn)小慎微，深刻地意識到始終面臨極大的安全性挑戰(zhàn)。

03/ 明心

聚沙成塔、聚義行天下。知識庫的從零開始、固本培元，這是一個見證積少成多、恒心出奇跡，學(xué)以致用、實踐促創(chuàng)新的過程。云信知識庫發(fā)展至今，主要由技術(shù)支持和解決方案同事堅持不斷地整理和豐富內(nèi)容，同時也得到產(chǎn)品、開發(fā)、商務(wù)、市場等部門同事的關(guān)心和協(xié)助，還搜集到一些開發(fā)者熱心的意見和建議。

別具匠心、精益求精。2019年，知識庫累計訪問約7萬條次，條目被分享3000多次，共有13位人員參與貢獻近200次。我們秉承”網(wǎng)易出品、必屬精品”的匠心精神，嚴(yán)格審核、精心編輯、反復(fù)打磨、不斷優(yōu)化條目內(nèi)容，并且持續(xù)進行查漏補缺、夯實完善工作。

不忘初心、方得始終。我們將繼續(xù)堅持為開發(fā)者服務(wù)的理念，作為開發(fā)指南的補充，為開發(fā)者更快地接入、更好地體驗云信產(chǎn)品貢獻力量。站在更高的角度來說，通過連接開發(fā)者，協(xié)助云信產(chǎn)品助力客戶企業(yè)成長。

點擊閱讀原文，進入網(wǎng)易云信知識庫。

總結(jié)

以上是生活随笔為你收集整理的知识库成长记的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。