可能是国内颜值最高的开源文档工具?

2023-06-28 09:26:31 +08:00
 star7th

地址

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

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

开发小故事

早前,showdoc 发布过 3.0 UI 重构版,但是尚未完全达到设计预期,属于略微仓促发布的版本。在那个时候,设计师委婉地说过,他习惯一步到位,做完善产品了再上线。意思是想我更完善 showdoc 再发布。

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

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

于是在 3.0 版发布了一段时间后的今天,3.2 完全版也出来了。本轮更新,在设计师的“像素眼”注视下,修改了大量细节,优化了很多视觉 UI 和交互体验。

3.2 版本更新了什么

相关截图

给新用户看的 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

18849 次点击
所在节点    分享创造
234 条回复
ggp1ot2
2023-06-28 09:34:27 +08:00
之前用过,你要是说小清新还行, [颜值最高] 是怎么有自信的?
vayci
2023-06-28 09:36:38 +08:00
暂时不可能
star7th
2023-06-28 09:37:03 +08:00
@ggp1ot2

你可以尝试发一下你认为颜值最高的国内开源文档工具来让我学习下?
star7th
2023-06-28 09:37:54 +08:00
@vayci

尝试发一下你认为颜值最高的国内开源文档工具来让我学习下?
LavaC
2023-06-28 09:39:39 +08:00
该想个办法忽悠后端用上
ggp1ot2
2023-06-28 09:46:44 +08:00
@star7th


没法提供,只是单纯觉得 [国内最 xxx] 式的标题很讨厌

要想说 [国内颜值最高的开源文档工具] ,有点过于太得意了,谁给你的勇气,还是想靠标题党吸引人用?

可以看出比上个版本 ui 更现代化一点,可能是花了很多心思

个人认为,作为开发者应该谦虚一点

最后,这个 ui ,真的就一般,很多 typore 主题都能秒杀
nekoneko
2023-06-28 09:47:47 +08:00
一直在用, 挺好的, 支持一下.
rzdCG
2023-06-28 09:49:10 +08:00
没有 Linux 差评
star7th
2023-06-28 09:51:07 +08:00
@ggp1ot2

typore 不开源,不在比较的范围内。

我起这个标题的时候,其实是调查过了的。基本符合事实。当然,为了防止翻车,我加上了“可能” 两字。
如果不符合事实,你大可找反例来反驳我,我承认我的孤落寡闻后,回去默默提高产品体验。
但是如果是符合事实的,那为什么不能把 产品的优点(颜值)拿出来做一下宣传呢。所以我起了这个标题。
iblessyou
2023-06-28 09:51:21 +08:00
为啥不像 swagger 那样自己本地给启个服务呢
star7th
2023-06-28 09:52:44 +08:00
@nekoneko

多谢支持
mydingyan
2023-06-28 09:53:09 +08:00
更新 3.0 以后,安卓端 app 项目主页一直白屏的,是不是忘记兼容啦
版本号:1.1.1
star7th
2023-06-28 09:55:19 +08:00
@rzdCG

showdoc 是网站为主的,基本全平台的浏览器都可访问。
你说的没有 linux ,应该指的是客户端吧。其实 showdoc 客户端也只是一个 web 打包,我统计了下使用率也没有很高,大部分用户还是直接通过 web 访问的。
lmoon
2023-06-28 09:57:08 +08:00
如果说,我就是如果说啊,算上国外呢
star7th
2023-06-28 09:57:58 +08:00
@iblessyou

我没有看到 这种本地启动服务的方式 比 showdoc 现在的方式 有明显的好处。
seth19960929
2023-06-28 09:58:56 +08:00
用 showdoc 写 API 文档, 到底图 什么呢
star7th
2023-06-28 09:59:34 +08:00
@lmoon

所以我保守一点,加上了明显的国内范围限制,免得有人喷我标题党。
目前来看,这个标题还是基本符合事实的。如果连 符合事实 的标题都看不惯,只能说某些人纯属只是看不得别人好。
zq11211277
2023-06-28 10:00:04 +08:00
很好用
但颜值可能不是最高的,这个不影响
whyzp2019
2023-06-28 10:00:19 +08:00
审美是一个非常主观的东西,你拿着个跟别人顶,属实是不太明智,人家觉得这个不好看,也并不一定就会有觉得更好看的,同时,同意前楼的说法,像 swagger 那样起个服务,我一定程度上都不用开 postman
star7th
2023-06-28 10:02:17 +08:00
@seth19960929

因为要写 api 文档给团队的其他成员看。比如后端写给前端看。
如果不想手写 api 文档,可以用 runapi 来自动生成 https://www.showdoc.com.cn/runapi

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

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

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

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

© 2021 V2EX