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

相关截图

4058 次点击
所在节点    分享创造
48 条回复
ieliwb
2023-02-14 11:12:32 +08:00
正在用,支持
highf4324
2023-02-14 12:28:51 +08:00
很不错,不过还是建议首页左上角的 LOGO 不要用 PNG/JPEG 图像,因为看起来有点模糊。
建议直接用 svg ,这样无论怎样都不会模糊。
yushiro
2023-02-14 12:30:32 +08:00
showdoc 是换域名了吗?用之前保存的 url 都没法正常显示了
superliwei
2023-02-14 12:42:19 +08:00
👍 非常棒~!
star7th
2023-02-14 13:02:49 +08:00
@highf4324 主要是因为当初这个原始 logo 我没有保存源文件。只有一张大图。不过我倒可以使用大图生成各种分辨率的。所以你说的模糊问题,我尝试换个大分辨率一点的图标
star7th
2023-02-14 13:03:48 +08:00
@yushiro showdoc 官网域名是 https://www.showdoc.com.cn/ ,我不清楚你以前是否使用了非官方平台(即别人搭建开源版给他自己用的,而你跑去注册账号了)
akiyamamio
2023-02-14 13:04:13 +08:00
开源版和商业版有啥区别?
star7th
2023-02-14 13:04:15 +08:00
@superliwei
@ieliwb
谢谢支持
star7th
2023-02-14 13:10:03 +08:00
@akiyamamio 软件功能上的区别很小,可以忽略。

商业版主要是方便一些不想动手搭建的用户,更重要的是他们觉得数据交给 showdoc 官方去维护,比自己搭建的更可靠。尤其企业用户对数据的稳定性要求更高。如果是私自搭建开源版,服务器运维要你自己去保证可靠性。
yushiro
2023-02-14 13:42:43 +08:00
并不是用的其他人的,域名就是 showdoc.com.cn ,现在访问还是有问题,会去链接 dyfun-spare2.showdoc.这 com.cn:8888 这个地址,返回全部超时
polarbearn
2023-02-14 14:00:47 +08:00
从文档跳转到登录界面,会造成页面假死
刚刚提的 issues
github.com/star7th/showdoc/issues/1851
EngAPI
2023-02-14 14:08:18 +08:00
用了你们推送半年多,感谢
mydingyan
2023-02-14 14:28:14 +08:00
刚使用./showdoc update 命令升级了, 发现数据都被清空了, 应该怎么操作下
star7th
2023-02-14 14:52:17 +08:00
@yushiro

dyfun-spare2.showdoc 是我们自建的 cdn 服务,你那边访问有问题吗?
你是什么网络?如果是使用公司网络,会不会是公司安全限制了 8888 端口出口?能否用手机网络试一下?
star7th
2023-02-14 14:52:37 +08:00
@rolitter 好的,晚点修复下。
star7th
2023-02-14 14:52:53 +08:00
@EngAPI 多谢支持
star7th
2023-02-14 14:58:14 +08:00
@mydingyan
可能是没有写入权限导致。在你目录 /showdoc_data 下应该能找到类似 html_bakxxxx 这样名字的文件夹。将它改掉,替换原来的 html 目录,然后重启下 docker 容器就好了
lower
2023-02-14 15:00:42 +08:00
刚试了一下,8 年前的账号还能登录进去,当年的项目文档居然还都在😂
pengtdyd
2023-02-14 15:02:19 +08:00
好奇,showdoc 开源项目商业化能赚到钱吗?本身就是很小众的产品
star7th
2023-02-14 15:03:56 +08:00
@lower 嗯,多年来的账号没清理过。顶多清理下系统生成的示例文档, 但用户创建的数据没动。

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

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

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

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

© 2021 V2EX