star7th / showdoc

ShowDoc is a tool greatly applicable for an IT team to share documents online一个非常适合IT团队的在线API文档、技术文档工具
https://www.showdoc.com.cn
Other
12.18k stars 2.18k forks source link

Showdoc的功能优化建议 #1169

Open Amwsup opened 3 years ago

Amwsup commented 3 years ago

钦佩加感谢提供这么好的Showdoc,简约不简单。 作为个人及团队知识管理系统,附件尤其pdf上传功能简直完美,在浏览器打开,而不是要下载后打开,。

在使用过程中,个人提几个使用的小建议:

一、编辑器方面:

  1. 增加富文本支持,毕竟markdown的使用还是有一定学习难度,尤其是在表格、字体大小等编辑时,网上试了几个,尤其前两个还挺符合Showdoc的设计的,不会违和。 TinyMCE https://www.tinymce.com/ 1、表格支持完美,可调整列宽度;2、复制的文字+图片可以同时粘贴 wangEditor http://www.wangeditor.com/ 1、复制的文字+图片可以同时粘贴 kindeditor https://github.com/kindsoft/kindeditor
  2. 或者看看语雀的那种编辑器,感觉好像是富文本+Markdown 可以设计成在创建文档的时候选择编辑器,相当于给文章加了一个属性:富文本还是markdown。只能在创建的时候选择好就固定了,后续不能改。

使用场景不一样就需要两种编辑器支持会更好点

markdown不方便的地方(较多文字、图片输入场景)

1.编辑页的空格输入。比如段首的空格后台直接转换为 #&8194 或者 。tab换成#&8195;或者 &mbsp; 。虽然输入的话,全角空格可以,但还是不方便。 2.表格是个大问题,多点文字,就分不清了(做api展示还行,其他的基本不能用) 3.复制图片是个问题 (文字、图片得分开复制) 4.虽然有预览,但是左边编辑可能在右边显示不在同一水平线上,多点文字就没法用了

二、附件方面:

  1. 《工程技术标准》.pdf上传之后变成了 5f9038d41c3a7.pdf,小白猜这个应该是为了安全+防止乱码的设计进行转码可以理解。但进行文件下载,名字是5f9038d41c3a7.pdf。(有小部分文件下载是原名称,大部分不是原名称),不那么方便理解。 希望可以增加 原名称 与 [转码后名称对应关系,下载文件是原名称。]

三、功能体验方面:

  1. 能否增加夜间模式,夜间编写会好点
  2. 当前搜索只能在项目内进行,有没有可能全域(跨项目)进行搜索。当然这个可以做成参数,是否进行跨项目搜索(直接在首页搜索,当前首页只能搜索项目名,不能搜索内容),需要管理员在后台设置是否允许,设置界面可以提示:全域可能影响性能,让自己选择呗。
  3. 对单文章或接口的Tags功能。当前搜索也很好用,但有Tags的话,可以辨析文章大体内容,点击的话也相当于快捷搜索,输出含有该Tag的文章。
  4. 对单文章或接口的评论功能。团队成员有时只有读权限,但是对文章有想法没法及时反馈或者更新。类似Jira的:
  5. 改成编辑页面的最上面功能栏能一直显示 所谓功能栏就是文章标题、目录、保存、返回、模板、附件等按钮那里: 编辑到比较多行数时,若想添加附件或者格式工具,以及想要保存时,需要滚动到最上面点击按钮。可以考虑将功能栏放到上面固定或某侧固定,使之一直在编辑时显示
  6. 导出文章支持单文章导出。当前只支持全部或者某个目录下所有。

用了很久了,奈何自己未进行网页界面等前端编程,心有余而力不足,希望通过建议为Showdoc更完美添砖加瓦,上面的建议可能不专业,或存在较大实现难度,请谅解,权当参考。 感谢Showdoc开发者们的付出。

针对Showdoc的不专业建议20201120(有截图).pdf

star7th commented 3 years ago

1,基于性价比考虑,暂未支持富文本编辑器。最主要是富文本带来的维护成本太高了,后面新增什么功能都要考虑兼容两种文本情况。而收益方面,showdoc目前以IT团队为核心,支持富文本的意义不大。如果有一天想扩展非IT群体,可能会支持富文本。 2,编辑多表格,用mardkown的表格是不太方便的。建议新建项目的时候,使用showdoc的表格类型项目。它实现了一个轻量级的在线excel。 3,附件方面的名字怕是不好改。首先,附件文件储存是用英文名的。如果读取出来的时候改回中文名,那么就需要把整个文件先读取进内存再输出。额外带来蛮多性能消耗。目前不是很想引入这种机制。 4,夜间模式短期内不做好。主要是showdoc的页面一直都是补丁式的增加,UI代码有历史包袱。要换主题的话需要大改。这个以后再说。 5,全局搜索功能是一个可以考虑的点吧。确实也会有性能问题的。不一定引入这个功能。 6,文章tab功能我个人觉得是重了点的。大多数人可能用不到但它却占据着视觉空间。如果能找到一种最小代价侵占视觉空间的交互方式再看吧。 7,编辑页面那个标题栏固定在顶部的功能后面看下,这个是有必要做的。 8,新版showdoc已经支持单文章导出。

Amwsup commented 3 years ago

谢谢回答了,理解,毕竟开发维护很耗时间和精力。