ShowDoc是什么

每当接手一个他人开发好的模块或者项目，看着那些没有写注释的代码，我们都无比抓狂。文档呢？！文档呢？！Show me the doc  ！！

程序员都很希望别人能写技术文档，而自己却很不希望要写文档。因为写文档需要花大量的时间去处理格式排版，想着新建的word文档放在哪个目录等各种非技术细节。

word文档零零散散地放在团队不同人那里，需要文档的人基本靠吼，吼一声然后上qq或者邮箱接收对方丢过来的文档。这种沟通方式当然可以，只是效率不高。

ShowDoc就是一个非常适合IT团队的在线文档分享工具，它可以加快团队之间沟通的效率。

它可以用来做什么

（1）API文档 http://www.showdoc.cc/demo?page_id=7
随着移动互联网的发展，BaaS（后端即服务）越来越流行。服务端提供API，APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档。

（2）数据字典 http://www.showdoc.cc/data-dictionary?page_id=13
一份好的数据字典可以很方便地向别人说明你的数据库结构，如各个字段的释义等。

（3）说明文档 http://www.showdoc.cc/help?page_id=14

使用方式

1、部署到自己的服务器：http://blog.star7th.com/2016/05/2007.html

2、使用在线的ShowDOc：http://www.showdoc.cc