帶你走進Choerodon豬齒魚的知識管理

知識管理是Choerodon豬齒魚的一個重要功能,支持在線自定義文檔編輯、成員協助共享等功能,幫助團隊集中管理創意、需求和設計。本文將會和大家聊一聊知識管理對敏捷團隊的重要性,介紹Choerodon選用XWiki作爲開發基礎的原因,以及開發團隊如何設計Choerodon知識管理,最後會簡單介紹一下Choerodon知識管理的一些主要功能和特色。

敏捷團隊的知識管理

對於軟件開發團隊來說,每個成員都是知識工作者,知識工作者需要具備一個很重要的能力——知識管理能力。知識是軟件行業的靈魂和生存之本,然而很多時候大家都忽略或輕視了團隊知識管理的重要性,所以Choerodon希望能夠爲團隊提供一個便捷高效的知識管理方式。

Choerodon豬齒魚知識管理是爲了解決敏捷團隊在快速迭代的開發過程中可能忽視的知識沉澱、文檔管理和團隊協作等問題而誕生的。

印第安人在趕了3天路之後,會停下來小憩一天,因爲他們要等待自己的靈魂跟上來。敏捷開發過程也是如此,在經歷一個迭代或者衝刺之後,也需要做一些休整,那就是敏捷回顧。每次回顧時,團隊成員需要歸納總結開發過程中積累下來的各種問題或經驗,並將這些知識記錄在可共享的wiki上,這樣既便於團隊成員互相學習,也利於以後需要時快速查閱。

爲什麼基於XWiki開發Choerodon知識管理

現在常見到的wiki有很多,開源免費的如 MediaWiki、DokuWiki,企業收費的如 Confluence等。在開發Choerodon豬齒魚知識管理初期,團隊希望能夠選擇一款既開源,又能針對Choerodon豬齒魚平臺的應用場景,做定製化的wiki系統。比如適應Choerodon的組織項目層級結構,以及與Choerodon豬齒魚中的敏捷管理、測試管理等做更多的互動,讓用戶能夠在使用平臺時,快速準確地記錄下自己的知識,讓知識管理在應用交付和自動化運營過程中發揮更大的價值。在經過許久對比和甄選之後,團隊選擇了一個優秀、強大的開源wiki系統——XWiki。

XWiki是由一家法國的公司XWiki SAS於2004年開發出的一款wiki系統,並於2007年開源。至今已經10多年,這個社區仍然有衆多活躍的貢獻者和使用者,並且擁有大量的客戶羣體和產品案例。XWiki有健壯的編輯器、強大的編輯語法,能提供多種拓展特性來定製化wiki。除了XWiki官方提供的功能以外,還有超過100個社區參與者貢獻的拓展項目,這些拓展都可以直接在XWiki系統的拓展市場上安裝和管理。

XWiki、Confluence以及MediaWiki對比

接下來通過XWiki與Confluence以及MediaWiki的對比,來談談Choerodon爲什麼選擇XWik作爲其知識管理的基礎。

XWiki是一個開源的項目,使用了LGPL開源協議,使用者可自己搭建和拓展XWiki而不需要購買任何授權。它使用java語言開發,提供了衆多面向企業的特性,並且擁有豐富的拓展庫和宏,靈活性與拓展性很強。有許多如Amazon、AFP、EDF等大型的公司使用XWiki創建知識庫或者協作工具,也有一些企業和組織使用XWiki搭建門戶網站。

Confluence是一個團隊協作軟件,由澳大利亞的公司Atlassian開發和銷售,它是一個面向業務的專業wiki,使用java開發,主要應用於企業環境。目前Confluence有許多大型客戶案例,如Facebook、eBay、Adobe等,不過使用Confluence,需要向Atlassian公司購買授權。

MediaWiki是一款使用PHP開發的開源wiki軟件,它最著名的案例就是維基百科,所以也是受衆最大的wiki。MediaWiki支持多語言管理、各種擴展和媒體格式,還能夠配置wiki外觀。但是MediaWiki在權限管理,組織架構管理上並不適合Choerodon的解決方案,也不太適用企業的業務需求。

除了上面談到的三款wiki軟件之外,我們還對比了其他比較流行的wiki軟件,綜合考慮之後,最終選擇了開源的、有強大的拓展特性以及適應企業多種業務場景的XWiki。

Choerodon豬齒魚知識管理的設計

Choerodon豬齒魚平臺是基於spring cloud的微服務架構開發,而Choerodon知識管理選擇以XWiki作爲開發的基礎,那麼就需要做到統一的用戶、權限以及組織架構。因此開發團隊開發了微服務wiki-service,這個微服務主要用於監聽Choerodon平臺中其他服務的操作,比如IAM的創建組織、創建項目等,然後使用http請求的形式,讓XWiki做對應的業務處理,比如創建對應的空間和頁面。另外XWiki需要使用Choerodon豬齒魚平臺統一的登錄和權限校驗,所以Choerodon在XWiki中添加了OAuth登錄認證。下圖是Choerodon豬齒魚知識管理設計示意圖:

Choerodon豬齒魚平臺中有三層組織層次,即全局層、組織層和項目層。Choerodon 使用三層組織結構來管理用戶、權限、項目、環境資源、菜單,以及其他系統資源和功能。其中全局層包含了系統的一些基本設置,例如組織管理、菜單管理、全局角色管理等;組織層管理用戶、權限、項目、環境資源,以及其它系統資源和功能;項目層用來管理軟件的開發,項目屬於組織。Choerodon知識管理也是按照組織層和項目層,以及組織和項目下的空間來管理wiki的。爲了保證XWiki與Choerodon平臺有統一的組織和項目以及組織、項目對應的人員、權限等,需要將每個組織項目的創建、角色分配等都在XWiki中做對應的處理。下圖是當IAM創建一個組織時,wiki-service爲保證數據一致性做的處理:

Choerodon豬齒魚知識管理功能介紹

Choerodon知識管理實現了一個強大的Wiki平臺,允許用戶根據自己的特定需求自定義Wiki,爲企業、IT團隊提供方便的項目協作平臺和強大的項目內容管理平臺,集中式管理產品相關內容,例如需求收集、架構設計、功能設計、開發規範、命名規範、會議記錄、計劃安排等。目前Choerodon知識管理除基礎的空間頁面創建、文檔編輯、文檔共享等,還開發了一些特色功能,如個人空間、組織項目文檔權限控制、匿名分享、文檔模板等。

基本概念簡介

  • 空間

空間相當於一個分組,它是一類文檔的集合,組織和項目下都可以創建空間。在空間下可以創建對應類型的文檔樹,實現各類文檔的分別維護和管理。

  • 頁面

頁面是Wiki中的基本內容單元,也就是使用者在空間下創建的文檔。頁面可以創建在空間下或者在其他頁面之下,這樣用戶就可以隨意地組織團隊的文檔結構。頁面可以進行編輯、分享、評論、收藏等操作,還支持使用多語法編輯和多人協作編輯,另外每個頁面都可以有版本控制。

個人空間

Choerodon知識管理中除了組織項目下的共享空間之外,Choerodon還設計了一種特殊的空間——個人空間。這個空間爲每個wiki用戶提供了一個私人的編輯區域,用戶可以在個人空間中隨意編輯和記錄文檔,並且可以選擇將一些文檔發佈到需要的公開區域,比如某個組織或者項目下。

空間、頁面權限

在Choerodon知識管理中,空間和頁面採用相同的權限模型,以用戶組的形式配置權限。對於組織和項目下的空間、以及空間下的頁面,在不單獨配置權限的情況下,默認是繼承組織和項目的權限的,也就是隻有組織或者項目成員纔可以查看。

同時,用戶可以針對某個頁面或者空間,個性化配置權限,可以是對某個用戶組開放,也可以對所有人或者匿名用戶開放,權限包括視圖查看、評論、編輯、修改腳本、刪除和設置管理員。如下圖的權限配置頁面所示:

匿名訪問

Choerodon知識管理的內容使用空間和頁面的形式組織,並且受到組織項目權限的管控,當用戶想將文檔分享給未註冊用戶時,可以將一些需要公開的文檔設置成可匿名訪問,既不影響其他頁面的權限,也保證了文檔的安全。在權限設置中選擇未註冊用戶勾選相應權限即可。

文檔模板

Choerodon知識管理預置了產品需求和敏捷回顧會議記錄等文檔的模板,可以直接進行編輯,簡化了用戶編輯排版操作。平臺管理員也可以自定義創建團隊常用文檔模板、修改頁面佈局界面。

其他功能概述

除了上面提到的幾個特色以外,Choerodon知識管理還提供了比如:

  • 所有更新、熱門:用戶可以查看最近wiki中發生的文檔創建、編輯、評論等操作,以及一些瀏覽量較高的文檔,能夠瞭解到一些新的文檔動態,及時的學習和共享。

  • 最近工作、最近訪問:用戶可以在wiki中查看到自己最近編輯以及查看的文章,方便用戶查看自己的歷史操作記錄。

  • 通知:頁面的操作可以通過站內信或者郵件的形式通知到關注者,幫助用戶及時跟進文檔的狀態。

  • 搜索:wiki系統提供了強大的文章搜索引擎,可以搜索到文章中的關鍵字,提高搜索精度。

  • 導入、導出:頁面還可以進行批量的導入導出,可以導入office文檔,wiki會自動解析文檔內容,並添加到頁面中。

瞭解更多功能,請查看Choerodon知識管理用戶手冊

總結

Choerodon知識管理自發布以來,經歷了多個版本的更新和迭代,提供了越來越便捷和完善的功能,希望能夠讓用戶在敏捷開發和項目管理過程中,沉澱各種知識與經驗,提高團隊協作的便捷性和積極性,今後也會持續優化,歡迎各位朋友前來社區交流。

關於Choerodon豬齒魚

Choerodon豬齒魚作爲開源多雲應用平臺,是基於Kubernetes的容器編排和管理能力,整合DevOps工具鏈、微服務和移動應用框架,來幫助企業實現敏捷化的應用交付和自動化的運營管理,同時提供IoT、支付、數據、智能洞察、企業應用市場等業務組件,致力幫助企業聚焦於業務,加速數字化轉型。

歡迎加入Choerodon豬齒魚社區,共同爲企業數字化服務打造一個開放的生態平臺。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章