ShowDoc(API文档,技术文档工具)

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://showdoc.cc/help?page_id=13732

开源系统详细地址：https://github/star7th/showdoc

应用网络的ShowDoc

假如你沒有自身的网络服务器，但又想应用ShowDoc做为划档共享专用工具，你能应用网络的ShowDoc http://showdoc.cc

http://showdoc.cc 做为在线客服会长期性维护保养，请安心代管你的文档数据信息。应用在线客服时请记牢showdoc唯一官方网网站地址https://showdoc.cc

ShowDoc交流群

ShowDoc应用沟通交流qq群

交流群①：564671853（已满）

交流群②：174709989（已满）

交流群③：667194478

如果你觉得ShowDoc功能强大，可以分享该文到你的技术社区以适用ShowDoc。感谢支持。