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

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

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

那麼,這個新的知識管理和以前的「知識管理(Wiki管理)」有何不一樣?微信

新老知識管理有何區別?

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

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

爲何要從新開發一個新的知識管理服務?

隨着更多新用戶的增長以及數據的不斷積累,XWiki已經沒法知足用戶在體驗和操做上的更高需求,根據社區成員和用戶的反饋,豬齒魚進行了商議和選型,通過1個迭代的週期推出了新的知識管理。運維

選擇從新開發的緣由有不少,主要有如下幾點:編輯器

▍1. 功能開發成本高

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

好比使用頻率很高的分享功能,因爲原XWiki中的分享功能在豬齒魚平臺中沒法知足到用戶的需求,豬齒魚只能進行二次開發。在開發過程當中,常常會由於一些諸如須要先讀懂源代碼邏輯等工做,讓工做量超出預期,反而下降了團隊的開發效率。工具

▍2. 升級引發重構

豬齒魚引用XWiki(版本)實現了內容的管理,但同時,爲了知足用戶的需求,通常都會對其進行二次開發,在此狀況下,若是豬齒魚跟隨官方對XWiki進行了升級,那就意味着二次開發代碼的重構,升級的不肯定性會帶來很大的成本,所以棄用XWiki並開發新的知識管理頗有必要。佈局

▍3. 操做較爲複雜,用戶體驗不佳

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

根據產品團隊的不徹底統計,針對Wiki管理,社區論壇上關於操做的問題達到50%以上,性能問題達到了20%以上,好比:

一、Wiki服務與豬齒魚平臺用戶同步的問題; 二、權限配置的問題; 三、左側樹形菜單結果加載過慢問題。

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

豬齒魚知識管理服務上線

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

新的知識管理是一個開發輕量級,操做簡便的內容管理工具,具備最基本的建立、編輯、導航、連接、版本回滾、搜索等功能,組織層和項目層均有屬於本身的知識管理服務。

1、操做和體驗

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

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

▍2. 操做簡單,弱化了權限設置操做,突出團隊共享

結構權限上與以前的Wik相比,沒變的是同項目的成員可查看項目內建立的全部文檔,不一樣的是組織層的文檔,各個項目成員均能查看;

項目成員可對其餘成員建立的文檔進行編輯,但只能刪除本身建立的文檔。

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

2、功能

▍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)入羣

你們也能夠經過如下社區途徑瞭解豬齒魚的最新動態、產品特性,以及參與社區貢獻:

相關文章
相關標籤/搜索