程序猿必备的文档工具——ShowDoc
据说在硅谷流传着这样一句关于程序猿和文档的名言:“Coders hate 2 things: writing documentation and no documentation.”(程序猿最痛恨两件事:写文档和没有文档)。,程序员们很希望别人能写好技术文档并且自己不希望写文档,因为自己写文档意味着花大量的时间去处理排版、格式、新建的word文档存放在哪个目录等大量非技术细节。浪费本来就宝贵的精力。IT团队编写代码时,文档七零八落散落在各个团队成员,需要文档的同志基本靠吼——一副两岸“猿”声啼不住的景象。今天给大家推荐一款可以大大减轻程序员团队协作效率低下所带来痛苦的在线文档分享工具——ShowDoc。
- ShowDoc是什么?
ShowDoc是一款给IT团队减轻大量压力的在线文档工具,ShowDoc针对中国程序员的使用习惯、结合开发人员的职业特点,可以大大提高团队成员的写作效率,减轻团队的维护负担。它主要解决了开发团队的一个重要诉求:拥有一个可以拿来就用的文档存放中心,可以快速地分享、生成文档,并且可以让团队之间各成员划分权限、多人协作,彻底解决“writing documentation”和“no documentation”的问题。
- 为什么选择ShowDoc
ShowDoc有多受欢迎呢?安利ShowDoc这款文档工具这件事甚至看起来有点拾人牙慧,国内顶尖的开发团队都在使用这款文档工具,作为安全开源的文档工具,ShowDoc在GitHub上是拥有超过10,000颗星的超级热门项目。ShowDoc几乎是程序员的“装机必备”。

官网上大胆又骄傲地展示在使用ShowDoc的互联网巨头们,一句“包括且不仅以下公司团队”彰显着开发者的自信。
- ShowDoc的主要功能有哪些?
- 权限管理
ShowDoc中分为公开项目和私密项目两种项目。公开项目可供任何用户访问,而用户可以给私密项目设置密码来进行验证访问。
- 自动记录历史版本
ShowDoc自动记录历史版本,你可以在需要的时候快捷地恢复之前的版本。
- 支持文件导入
可以导入postman的json文件、swagger的json文件、showdoc的markdown压缩包,系统会自动识别文件类型。
- 采用markdown编辑器
除了常见的文档库和电子表格库,ShowDoc可以插入API接口模板和数据字典模板,这就让ShowDoc拥有两个技术文档的特色功能:API文档库和数据字典文档。前者可以解析源码的注释,自动生成API说明文档;后者可以生成数据库对一张表格的说明文档。在调试API过程中可以极大的提高团队效率。
- 响应式网页设计
可以方便地将项目文档分享到其他设备查看,甚至可以将项目导出为word文件离线浏览。
最后,附上官网地址:https://www.showdoc.com.cn/ ,快来加入巨头行列,提升团队的效率吧!