一點點進步的OceanBase資料庫文件!

OceanBase技術站發表於2023-03-27

歡迎訪問 OceanBase 官網獲取更多資訊:https://www.oceanbase.com/

自 2020 年 OceanBase 以獨立子公司開始全面推進商業化以來,提供更好更易用的資料庫檔案一直是 OceanBase 努力的一個重要方向。

如何透過檔案讓使用者更快速更便捷地瞭解和使用 OceanBase 資料庫?如何輔助使用者更快速地解決使用過程中遇到的問題?是 OceanBase 檔案一直在探索和前行的方向。

過去的兩年裡,我們收到了很多資料庫愛好者對 OceanBase 檔案的反饋和“吐槽”,也走出去和很多資料庫使用者和專家進行了很多交流。 檔案有但是不能解決問題、檔案有但是找不到、檔案缺失等 是讓使用者頭大的幾大問題,給使用者自助使用帶來了掣肘。面向越來越多的資料庫愛好者自助學習和使用資料庫的大背景,帶著使用者的聲音和期待,我們啟動了 OceanBase 檔案易用性演進。

在這期間,我們也一直在思考幾個問題,檔案如何能更符合使用者的訴求能真正提供幫助、檔案如何能更易用、檔案如何能持續的演進和迭代。我們認為檔案需要聆聽使用者真實的聲音,需要越辯越明,需要集思廣益,我們要做更 open 的檔案。

我們最近做了什麼?

近期,結合著 OceanBase 資料庫 4.x 的新架構,OceanBase 針對檔案做了很多討論,結合之前大家反饋的一些檔案建議和問題,對檔案和檔案中心做了一些調整,在檔案內容上也更多地去貼近使用者視角和場景。

▋ 解決檔案「不好找」的問題,檔案更聚焦,20% 的檔案覆蓋 80% 的問題

作為一款較複雜的軟體,我們需要提供大量的檔案來滿足使用者在不同場景下的資訊獲取訴求,這些檔案包括操作指導、技術原理介紹、引數/檢視/錯誤碼等參考類資訊。檔案豐富可以確保使用者想要的資訊都有,但是隨之帶來的問題是如何更好的組織這些資訊,才能讓使用者在這麼多資訊中比較快捷比較精準的找到自己需要的。

之前 OceanBase 檔案將面向同一使用者角色的各類資訊(操作指導、技術原理、參考資訊等)做匯聚來統一呈現,力求呈現更全的資訊。 資訊全,但是同時也帶來了不小的資訊“干擾”,資訊查詢困難, 這些龐雜的資訊中,可能只有少量是大部分使用者在日常工作中高頻會查閱的資訊,剩餘的大量資訊使用者主要是以按需查詢為主。

在這一次的調整中, 我們協同 OceanBase 資料庫的資深 DBA 一起反覆討論和梳理出了使用者使用 OceanBase 資料庫的核心鏈路和場景,將這些核心鏈路和場景的相關檔案按照使用者旅程來單獨呈現。 同時將使用者按需檢索類的檔案作為參考資訊單獨呈現,對檔案資訊按照使用者角色和內容型別做了分層處理,檔案更輕量,定位更清晰。

Image

▋ 解決檔案「不好用」的問題,檔案更加使用者視角和場景化

以前用 OceanBase 檔案的時候是不是會有點什麼都寫了,又好像沒寫什麼的感覺。我們深入剖析了一下,主要是因為之前的檔案沒有和使用者的“語言”同頻。之前的檔案比較偏向功能視角,在更多的去告訴大家我們有什麼,但是使用者日常的路徑是我遇到了什麼問題應該怎麼去解決。

在這次的調整中,我們著重向使用者視角和場景化的大方向上演進,檔案更重要的去講述我們能夠解決什麼問題。“是什麼、為了什麼/解決什麼、什麼時候/什麼場景下使用、如何使用(提供詳細的使用 demo 和說明)、注意什麼、如何驗證”,更貼近使用者的使用思路和實際場景,務求能夠真正提供幫助。

?以隔離節點為例

▷ 為什麼需要隔離節點?

▷ 什麼情況下需要隔離節點 ?

▷ 隔離節點的邏輯 ?

▷ 如何隔離節點?

Image

▷ 詳細的操作資訊和適用場景

▷ 必要的風險提示和使用建議

Image

內容好很重要,內容便於使用也很重要。 在最佳化檔案內容的同時,我們也針對大家使用 OceanBase 檔案過程中遇到的體驗問題進行了小小的調優,以提升檔案中心使用體驗,進一步解決使用者痛點問題。

▋ 解決檔案「找不到」的問題,提供更多的檔案使用引導

OceanBase 除了分散式資料庫之外,還提供了豐富的生態工具產品來輔助使用者更好更便捷地使用資料庫,這些產品都有配套檔案,但是之前檔案中心沒有提供明確的入口,這些檔案對於使用者來說可能是“不可見”的。

OceanBase 提供了很多內容,除了產品版本配套的使用檔案之外,也會提供面向不同使用者角色不同使用場景的教程和影片類內容,但是這些內容都隱藏在了 OceanBase 大量的檔案中,對於使用者來說可能也是“不可見”的。

針對這些“不可見”的問題,我們在檔案中心提供了檔案“大地圖”,使用者可以根據檔案導覽圖快速看到都有哪些內容可用並快速直達。

Image

Image

▋ 解決檔案「不好搜」的問題,搜尋結果可篩選,搜尋分層更精準

OceanBase 的檔案很多,搜尋範圍的精準性對於快速找到想要的內容至關重要。

我們在之前的使用者訪談中,反覆聽到使用者對於快速準確查詢到想要檔案的痛點,“檔案不是沒有,但是不容易找到”、“搜尋結果裡,有很多同名檔案,點進去才發現不是自己想看的版本”等等等等。

針對搜尋結果“太多”的問題,我們提供了搜尋結果篩選的能力,大家可以透過選擇想要的產品和版本來縮小搜尋結果的範圍。

Image

針對如何提升站內搜尋精準度的問題,我們對搜尋做了分層處理,現在您可以搜整個官網一覽所有內容,也可以專注搜尋檔案,還可以更加精準的搜某個產品某個版本的檔案,搜尋範圍可泛可精準,滿足不同場景的訴求。

Image

Image

除了上述調整之外,我們還針對檔案的導航目錄、檔案的樣式等做了很多細小的調優,歡迎到 OceanBase 檔案中心體驗這些小而美的改進。

?更多小的體驗提升

▷ 功能更易用

▷ 檔案切換、PDF 下載、檔案反饋等功能更明顯,使用路徑更清晰

Image

▷ 更豐富的檔案樣式

▷ 設計了更多檔案樣式,讓資訊獲取更便捷

Image

與我們一起共建更易用的資料庫檔案

OceanBase 一直相信更好的資料庫檔案一定來源於熱愛資料庫的大家們的共同打磨和建設。後續我們將以檔案提升活動、檔案專家小組、主題性檔案討論等形式陸續發起 OceanBase 檔案共建活動,和大家一起打磨更好用的資料庫檔案。

▋ 一起交流呀,檔案越磨越易用

同步一個小活動,近期,OceanBase 4.0 檔案和檔案中心都進行了一些調整,我們誠邀大家一起來體驗試用:

您可以給我們的檔案提交 pr,反饋在使用過程中的各種問題;也可以在社群檔案帖子下反饋建議,跟帖互動,碰撞交流。 我們將針對優質反饋贈送定製鍵盤、Polo衫、定製無線充等精美禮品和社群積分喔~感興趣的小夥伴可以點選連結(https://ask.oceanbase.com/t/topic/35602746)檢視具體的活動細節。

▋ 檔案專家小組,檔案的智囊團

檔案需要長期的建設和持續演進,我們也會把檔案共建作為一個長期的計劃來推進。為了更好的支撐檔案共建的運作,構建更 open 的資料庫檔案,OceanBase 擬籌建檔案專家小組。檔案專家小組後續會深度參與到 OceanBase 檔案的共建、檔案策略討論、和檔案演進中來。

更多檔案專家小組的建設和運作機制的細節資訊,我們後續會在 OceanBase 官網和社群透出,期待您的關注和參與。

寫在最後

我們趕上分散式資料庫的大潮,也遇上了資料庫學習和使用的熱潮,構建更好的資料庫檔案,服務更多的資料庫愛好者和使用者,讓我們一起共建更易用的資料庫檔案,讓檔案發揮更大的價值。

最後,牆裂建議釘釘掃碼加入我們的釘釘群(群號:41203246),本群為我們檔案貢獻社群官方交流群,OceanBase 檔案同學將在群裡實時互動答疑,同步活動積分和最終結果,併為您解決活動中遇到的各種問題~?

歡迎訪問 OceanBase 官網獲取更多資訊:https://www.oceanbase.com/

相關文章