博客列表
/

功能升级 | Choerodon猪齿鱼“新”知识管理介绍

功能升级 | Choerodon猪齿鱼“新”知识管理介绍

作者:朱琳珏 全部标签: 版本类
2019年07月22号

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.png

二、功能

▍1. 文档的创建与编辑

2.png

  • 创建文档即是创建内容也是创建页面;
  • 编辑器支持基本的编辑需要;
  • 支持实时保存,离开界面时,会进行确认提醒;
  • 支持2种编辑模式:markdown/所见即所得。

▍2. 文档的查看

3.png

  • 点击左侧树形菜单结构进行查看(无限层级);
  • 支持全局搜索查看;
  • 可显示目录,通过目录跳转到目标位置进行查看;
  • 可针对文档进行评论、附件上传;
  • 面包屑导航显示文档的位置;
  • 可通过分享链接的方式,分享自己创建的文档,非项目成员可通过分享的链接查看文档。

▍3. 其他操作

4.png

  • 文档可在左侧树型菜单上自由移动,可移动单个文档或文档集;
  • 支持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)入群

大家也可以通过以下社区途径了解猪齿鱼的最新动态、产品特性,以及参与社区贡献:

作者:朱琳珏

出处:Choerodon

欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文链接。