介绍

每当我们接管其他人开发的模块或项目时，我们总是会疯狂地看着那些没有注释的代码。程序员经常希望其他人写技术文档，而不希望自己写技术文档。因为编写技术文档需要花费大量时间来处理格式和布局，所以编写该文档的人必须考虑各种非技术细节，例如在新建的Word文档中应放入哪个目录，各种文档由不同的人分散地保存在一个团队中。然后通过IM或电子邮件从其他人那里接收文件。这种通信还不错，但是效率不高。ShowDoc是非常适合IT团队在线共享文档的工具。它可以提高团队成员之间的沟通效率。

Github坐标

https://github.com/star7th/showdoc

它能做什么？

• API文档

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

• 数据字典

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

• 说明文档

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

功能

• 分享与导出

响应式网页设计，可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成word文件，以便离线浏览。

• 权限管理

1. 公开项目与私密项目

ShowDoc上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问，而私密项目则需要输入密码验证访问。密码由项目创建者设置。

2、项目转让

项目创建者可以自由地把项目转让给网站的其他用户。

3、项目成员

你可以很方便地为ShowDoc的项目添加、删除项目成员。项目成员可以对项目进行编辑，但不可转让或删除项目（只有项目创建者才有权限）

4、团队管理

利用showdoc的团队功能你可以更好地进行团队协作

• 编辑功能

1、markdown编辑

ShowDoc采用markdown编辑器，无论是编辑还是阅读体验都极佳很棒。如果你不了解Markdown，请在搜索引擎搜索”认识与入门 Markdown”

2、模板插入

在ShowDoc的编辑页面，点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。插入模板后，剩下的就是改动数据了，省去了很多编辑的力气。

3、历史版本

ShowDoc为页面提供历史版本功能，你可以方便地把页面恢复到之前的版本。

使用方式

你可以选择使用在线版本或者部署到自己的服务器两种方式可供选择，在线版本长期支持维护，或者参考部署手册部署到自己的服务器：

官方提供了详细的部署安装文档，还包括二次开发的一些说明

在线版本

• 首先需要注册账号

• 文档管理首页

• API文档示例

• 数据字典示例

• 技术文档示例

• 新建文档页面

• 在线API测试

总结

文档管理有很多方式，ShowDoc的主要目的就是解决团队之间的这种文档之间的协作，而且管理起来非常方便，方便互相分享和使用！既可以使用在线版本也可以选择在自己本地部署非常方便！

PS:Javascript和Python的经典书籍，有哪位仁兄可以推荐一二，在此感谢！