1. 程式人生 > >功能升級 | Choerodon豬齒魚“新”知識管理介紹

功能升級 | Choerodon豬齒魚“新”知識管理介紹

Choerodon豬齒魚知識管理是一種內容管理工具,具有建立、編輯、導航、連結、搜尋等功能。它為企業、IT團隊提供方便的專案協作平臺和強大的專案內容管理平臺,集中式管理產品相關內容等,例如需求收集、架構設計、功能設計、開發規範、命名規範、會議記錄、計劃安排等。

在0.17版本中,豬齒魚上線了新的知識管理,作為專案團隊內容管理功能,並在0.18做了升級和功能增強,而原有的承載知識管理功能的Wiki管理將在0.19版本正式下線。

那麼,這個新的知識管理和之前的“知識管理(Wiki管理)”有何不同?

新老知識管理有何區別?

豬齒魚早期的知識管理——“Wiki管理”是團隊基於開源產品XWiki所開發。XWiki是一個由Java編寫的基於LGPL協議釋出的開源wiki和應用平臺,基本涵蓋了在知識、文件管理等方面所需的各種大小功能。但隨著產品的不斷演進,XWiki官方團隊減少對產品的投入,大大降低了迭代以及運維的效率。

而0.18版本中使用的知識管理則由豬齒魚團隊自行開發,內置於豬齒魚平臺,不再需要跳轉至Wiki空間,保留了文件編輯、分享、管理等基本功能,整體上更加輕量。

為什麼要重新開發一個新的知識管理服務?

隨著更多新使用者的增加以及資料的不斷積累,XWiki已經無法滿足使用者在體驗和操作上的更高需求,根據社群成員和使用者的反饋,豬齒魚進行了商議和選型,經過1個迭代的週期推出了新的知識管理。

選擇重新開發的原因有很多,主要有以下幾點:

▍1. 功能開發成本高

Wiki管理自上線以來,一直在不斷迭代優化,但豬齒魚在實際開發過程中發現,針對wiki管理的功能優化,即使是一些普遍性需求,功能開發代價也常常加倍。

比如使用頻率很高的分享功能,由於原XWiki中的分享功能在豬齒魚平臺中無法滿足到使用者的需求,豬齒魚只能進行二次開發。在開發過程中,經常會因為一些諸如需要先讀懂原始碼邏輯等工作,讓工作量超出預期,反而降低了團隊的開發效率。

▍2. 升級引起重構

豬齒魚引用XWiki(版本)實現了內容的管理,但同時,為了滿足使用者的需求,一般都會對其進行二次開發,在此情況下,如果豬齒魚跟隨官方對XWiki進行了升級,那就意味著二次開發程式碼的重構,升級的不確定性會帶來很大的成本,因此棄用XWiki並開發新的知識管理很有必要。

▍3. 操作較為複雜,使用者體驗不佳

豬齒魚是一個既追求產品功能又重視產品體驗的平臺。在前幾個版本中,開發者更多地是在關注功能是否缺失,可隨著產品功能的逐步完善,產品經理和設計師的關注度逐步向體驗和操作轉移。

根據產品團隊的不完全統計,針對Wiki管理,社群論壇上關於操作的問題達到50%以上,效能問題達到了20%以上,比如:

1、Wiki服務與豬齒魚平臺使用者同步的問題; 2、許可權配置的問題; 3、左側樹形選單結果載入過慢問題。

這一切本不該出現的問題,佔到了總數的70%,此時,豬齒魚團隊更加確定Wiki必須重構。

豬齒魚知識管理服務上線

從決定重構,選型,開發再到最後的上線,開發團隊前後花了大概3周的時間,在0.17版本釋出了一個可用的基礎版。

新的知識管理是一個開發輕量級,操作簡便的內容管理工具,具有最基本的建立、編輯、導航、連結、版本回滾、搜尋等功能,組織層和專案層均有屬於自己的知識管理服務。

一、操作和體驗

▍1. 安裝、升級更加快捷

無需引入第三方XWiki,可直接部署、升級豬齒魚知識管理服務。

▍2. 操作簡單,弱化了許可權設定操作,突出團隊共享

結構許可權上與之前的Wik相比,沒變的是同項目的成員可檢視專案內建立的所有文件,不同的是組織層的文件,各個專案成員均能檢視;

專案成員可對其他成員建立的文件進行編輯,但只能刪除自己建立的文件。

▍3. 介面佈局清晰,無需手冊容易上手

二、功能

▍1. 文件的建立與編輯

  • 建立文件即是建立內容也是建立頁面;
  • 編輯器支援基本的編輯需要;
  • 支援實時儲存,離開介面時,會進行確認提醒;
  • 支援2種編輯模式:markdown/所見即所得。

▍2. 文件的檢視

  • 點選左側樹形選單結構進行檢視(無限層級);
  • 支援全域性搜尋檢視;
  • 可顯示目錄,通過目錄跳轉到目標位置進行檢視;
  • 可針對文件進行評論、附件上傳;
  • 麵包屑導航顯示文件的位置;
  • 可通過分享連結的方式,分享自己建立的文件,非專案成員可通過分享的連結檢視文件。

▍3. 其他操作

  • 文件可在左側樹型選單上自由移動,可移動單個文件或文件集;
  • 支援Word格式文件的匯入;
  • 支援PDF的匯出;
  • 支援版本回滾以及歷史版本對比(並顯示新增和刪除記錄);
  • 所有操作日誌的記錄。

針對知識管理,豬齒魚團隊會逐步迭代,進行功能和操作體驗的提升。希望重構後的知識管理可以更好地幫助到大家,也歡迎大家多多反饋,開發團隊會積極迴應大家的需求和意見。

插播通知

Choerodon豬齒魚將於0.19版本正式取消Wiki管理功能,所有文件內容管理相關操作請大家在知識管理中進行。

Wiki管理和知識管理會在0.18版本中並行,方便使用者進行資料遷移。Choerodon豬齒魚系統已經將所有使用者所屬專案空間下的Wiki文件自動遷移至知識管理,如您在wiki空間中還有新的增改,可點選知識管理選單欄上方“wiki遷移”進行手動二次遷移。

關於Choerodon豬齒魚

Choerodon豬齒魚是一個開源多雲技術平臺,是基於開源技術Kubernetes,Istio,knative,Gitlab,Spring Cloud來實現本地和雲端環境的整合,實現企業多雲/混合雲應用環境的一致性。平臺通過提供精益敏捷、持續交付、容器環境、微服務、DevOps等能力來幫助組織團隊來完成軟體的生命週期管理,從而更快、更頻繁地交付更穩定的軟體。

Choerodon豬齒魚已開通官方微信交流群,歡迎大家新增Choerodon豬齒魚微信(ID:choerodon-c7n)入群

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