ShowDoc(API文档,技术文档工具)2.4.0官方版

Tags：ShowDoc,编辑器

ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具，一款优秀的API文档编写工具，可以帮助广大开发者和用户快速编写出集美观和实用为一体的API文档，支持团队合作和任务分配等等功能，操作十分简单，有需要搭配朋友欢迎体验。

ShowDoc是什么：

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

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

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

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

它可以用来做什么：

API文档（ 查看Demo）

随着移动互联网的发展，BaaS（后端即服务）越来越流行。服务端提供API，APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档，同时还将支持从代码文件中自动生成API文档

数据字典（ 查看Demo）

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

说明文档（查看Demo ）

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

它都有些什么功能：

分享与导出

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

权限管理

公开项目与私密项目

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

项目转让

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

项目成员

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

团队管理

你可以自行添加多个团队，为团队分配不同的项目，同时设置团队里每个人的权限。

编辑功能

markdown编辑

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

模板插入

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

历史版本

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

使用说明：

安装到自己的服务器

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

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

使用在线的ShowDoc

如果你没有自己的服务器，但又想使用ShowDoc作为分档分享工具，你可以使用在线的ShowDoc http://www.showdoc.cc

http://www.showdoc.cc 作为在线服务会长期维护，请放心托管你的文档数据。使用在线服务时请记住showdoc唯一官方网址https://www.showdoc.cc

ShowDoc交流群

ShowDoc使用交流qq群

交流群①：564671853（已满）

交流群②：174709989（已满）

交流群③：667194478

如果你觉得ShowDoc好用，可以转发此文到你的技术社区以支持ShowDoc。感谢支持。