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

地址

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

官网: 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 的详细介绍,请看: www.showdoc.com.cn/help

本作品采用《CC 协议》,转载必须注明作者和本文链接
讨论数量: 5

个人感觉 中间内容部分和左右两侧的目录, 在同一设备尺寸下 位置和尺寸固定的好一点, 现在点击左侧目录的时候感觉整个页面一跳一跳的不太舒服。

11个月前 评论
star7th (楼主) 11个月前

颜值怎么样可以先放一放,功能上欠缺些,几个小建议:

  1. 技术文档项目和api文档项目在创建时就分开;看演示,文档内容都是手写的markdown;二者还是要区分下,好做后续专项迭代

  2. api文档缺少一键导入/导出功能;

    • 现在的api基本都是基于swagger自动生成的,建议可以直接创建只读api项目绑定swagger.json 地址,你这边自动刷新或者手动刷新
    • 支持一键导出成postman的json配置文件,可以是项目级别导出也可以是单个api级别导出;单api级别导出顺带支持下导出成 curl 命令
  3. api文档和你们那个run api打通。

  4. 接口支持mock功能。

产品不用做的太通用,小众方向做到极致。

11个月前 评论
star7th (楼主) 11个月前

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!