ShowDoc——非常适合IT团队的在线API文档、技术文档工具

演示Demo：showdoc-demo

安装手册：https://www.showdoc.cc/help?page_id=13732

客户端下载地址：https://www.showdoc.cc/clients

目前支持Windows客户端、IOS客户端、安卓客户端；

ShowDoc是什么

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

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

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

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

它可以用来做什么

API文档

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

数据字典

一份好的数据字典可以很方便地向别人说明你的数据库结构，如各个字段的释义等。

说明文档

你完全可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅

部署方式

在线ShowDoc

如果你没有自己的服务器，但又想使用ShowDoc作为分档分享工具，你可以使用在线的ShowDoc
在线showdoc作为在线服务会长期维护，请放心托管数据

部署到自己的服务器

ShowDoc部署手册请参考：

常见问题

错误提示“Could not find driver”

请安装php-pdo 和 pdo_sqlite 。
Linux服务器安装php5.3以上版本时理论上默认是开启了php-pdo和pdo_sqlite的。如果你安装的PHP依然没有，则可搜索网络教程安装之。

错误提示”General error: 11 database disk image is malformed”

请确保服务器安装好了php环境和php-sqlite扩展；
如果你以FTP方式上传代码到服务器，那么请使用二进制模式上传，否则会损害数据库文件，导致此错误提示

可以使用mysql数据库吗

官方已经不再支持mysql数据库

验证码不显示

请检查是否安装了php-gd库

提示验证码验证失败

先到php.ini文件下找找session的保存目录，然后检查安装session目录有没有写入权限，或者可不可能是磁盘空间满了的问题

一直提示register fail

如果是在ubuntu下，尝试执行apt-get install php5-sqlite 或者apt-get install php7-sqlite3 以安装sqlite支持
对于其他的情况，出现register fail的错误时候请检查本机是否安装好了php-sqlite，以及文件确保可写。

怎么进入管理后台

新安装完成后，默认管理员账号是showdoc/123456 。使用管理员帐户登录后，在项目列表页面的右上角便能看到管理后台入口。如果不能，请重新登录或者刷新浏览器缓存试试

Github项目地址：https://github.com/star7th/showdoc