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

Choerodon豬齒魚發表於2019-01-29

知識管理是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 使用三層組織結構來管理使用者、許可權、專案、環境資源、選單,以及其他系統資源和功能。其中全域性層包含了系統的一些基本設定,例如組織管理、選單管理、全域性角色管理等;組織層管理使用者、許可權、專案、環境資源,以及其它系統資源和功能;專案層用來管理軟體的開發,專案屬於組織。Choerodon知識管理也是按照組織層和專案層,以及組織和專案下的空間來管理wiki的。為了保證XWiki與Choerodon平臺有統一的組織和專案以及組織、專案對應的人員、許可權等,需要將每個組織專案的建立、角色分配等都在XWiki中做對應的處理。下圖是當IAM建立一個組織時,wiki-service為保證資料一致性做的處理:

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

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

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

基本概念簡介

  • 空間

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

  • 頁面

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

個人空間

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

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

空間、頁面許可權

在Choerodon知識管理中,空間和頁面採用相同的許可權模型,以使用者組的形式配置許可權。對於組織和專案下的空間、以及空間下的頁面,在不單獨配置許可權的情況下,預設是繼承組織和專案的許可權的,也就是隻有組織或者專案成員才可以檢視。

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

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

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

匿名訪問

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

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

文件模板

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

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

其他功能概述

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

  • 所有更新、熱門:使用者可以檢視最近wiki中發生的文件建立、編輯、評論等操作,以及一些瀏覽量較高的文件,能夠了解到一些新的文件動態,及時的學習和共享。

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

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

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

  • 匯入、匯出:頁面還可以進行批量的匯入匯出,可以匯入office文件,wiki會自動解析文件內容,並新增到頁面中。

瞭解更多功能,請檢視Choerodon知識管理使用者手冊

總結

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

關於Choerodon豬齒魚

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

大家也可以通過以下社群途徑瞭解豬齒魚的最新動態、產品特性,以及參與社群貢獻:

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

相關文章