ShowDoc v3.0 发布 , 提升了产品颜值和操作体验,但是设计师说——

2023-02-14 10:18:50 +08:00
 star7th

地址

开源地址: https://github.com/star7th/showdoc

官网: https://www.showdoc.com.cn/

开发小故事

在年前,设计师基本为 showdoc 设计出了一套 ui 主题。然而直到昨天,我才按设计稿重构了一版 UI 。虽然外观看着变化也不算非常大,但实际上底层代码已重构掉了一半,很多产品逻辑导致的底层组件封装方式发生了变化,同时我也借此机会修复了历史上不少代码的遗留包袱。

到现在,完成度还没有很高,很多细节没打磨好,大约只达到设计稿原意的六七成。我决定直接先发布一个 3.0 版,后面的问题后面完善。

设计师说,我习惯一步到位,做完善了再上。

我跟他就这个观点进行了交流,还蛮有意思的。这是两种风格迥异的产品思维。一种是把产品打磨得很好,一出场就惊艳用户。一种是小步快走,分阶段迭代。实际上,我也看过设计师的其他作品,确实给人的第一感觉就很惊艳,其产品给目标用户的第一印象非常好。

对于我的项目而言,我要照顾到开发时间成本和宣发机会,我比较愿意追求留给用户一种 “这个产品一直在优化在进步”的印象,而不需花太长的时间“憋大招”来惊艳用户。

尽管这个观点不同,但是我非常欣赏设计师的产品思维和对细节的追求。后续也继续有意愿跟他合作其他产品。

3.0 版本更新了什么

重写了 UI 和交互逻辑,大大提升了视觉效果和操作体验,包括但不限于以下内容:

给新用户看的 showdoc 介绍

ShowDoc 是一个非常适合 IT 团队的在线 API 文档、技术文档工具,既有开箱即用的在线托管服务版,也有免费的开源版( github 1 万+ star )。通过 showdoc ,你可以方便地使用 markdown 语法来书写出美观的 API 文档、数据字典文档、技术文档、在线 excel 文档等等。如果不想编辑 markdown 文档,你还可以利用 showdoc 的自动化能力,从程序注释中自动生成 API 文档,或者从搭配的 RunApi 客户端(类似 postman 的 api 调试工具)中一边调试接口、一边自动生成文档。无需手动编写文档,释放生产力。通过分配项目成员和团队成员,你可以很方便地进行项目文档的权限管理和团队协作,也可以分享文档出去给朋友查看。ShowDoc 还支持多平台客户端,有 win 客户端、mac 客户端、ios 、android 等,更方便跨平台使用。目前超过 100000+的互联网团队正在使用 showdoc ,包括知名公司内部的一些团队,比如腾讯、华为、百度、京东、字节跳动等等。

关于 Showdoc 的详细介绍,请看: https://www.showdoc.com.cn/help

相关截图

4965 次点击
所在节点    分享创造
48 条回复
star7th
2023-02-15 10:06:42 +08:00
@CaffreySun

showdoc 没办法像 gitbook 那种将大片显示区域留给内容,因为两者面向的文档类型不一样。

像 gitbook 这样的大片区域,非常适合文字段落饱满的情况,比如写一篇教程,文字或者代码非常饱满,可以充满一个个段落的。
但是 showdoc 没办法,因为 showdoc 大部分用来解决 api 文档场景。写 api 文档,段落是不饱满的,我自己测试过,在锻炼不饱满的情况下,不同分辨率下的视觉效果无法统一,且都不算好看。
至于说排版细节,那就确实是的,showdoc 有不少要改进的地方。但无论如何,都不能直接仿照 gitbook ,因为主要面向的文档类型不一样。

至于说配色的问题,我后面会咨询设计师意见,后面再做个更完善的版本。
star7th
2023-02-15 10:14:51 +08:00
@geekboy

评论需求是一个很模糊的需求。说需要嘛,这几年来用户的呼声不大。说不需要嘛,偶尔会有人说。https://github.com/star7th/showdoc/issues/553

我自己依然没想好。再确认之前,我可能暂时先不动手做这个,因为评论功能会强势地占用视觉空间,并不是躲在一个二级菜单里等着用户使用就好。
sairoa
2023-02-15 12:08:22 +08:00
代码块输入英文单引号会被转义,保存后页面显示为`'`。
star7th
2023-02-15 12:20:21 +08:00
@sairoa 昨天晚点的时候发布了 3.0.1 版,就是修复此问题的。你更新下。
gongquanlin
2023-02-15 21:24:23 +08:00
用了好几年了,一直在用。牛逼,加油。什么时候能优化一下移动端就牛逼了,现在在手机上用 app 会有很多错位 /占满的问题
star7th
2023-02-15 22:12:09 +08:00
@gongquanlin

移动端好久没更新了,因为用户少,大部分用户都是电脑上把 showdoc 当生产力工具使用。有空再看看移动端吧
idragonet
2023-02-18 20:25:02 +08:00
3.0 怎么编辑框,有时候 ctrl+c 容易导致编辑框消失?
star7th
2023-02-18 23:18:12 +08:00
@idragonet

去官网试一下 有没有这样的问题 https://www.showdoc.com.cn/ 如果官网没问题,那可能是开源版滞后。你需要更新一下。

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/915920

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX