showdoc(API文档编辑工具) v1.0.1 官方免费版

Showdoc是一款强大的API文档编辑工具，官方免费版使用起来毫无负担，它支持多人协作编辑，能高效产出清晰规范的API文档。我超喜欢它的在线预览功能，在编写文档时能实时看到展示效果。以前用其他工具，写完文档还得手动部署查看，特别麻烦，还容易出错。有了Showdoc的在线预览，能及时发现排版、格式等问题并修改，大大提高了我的工作效率。

showdoc for mac (API文档编辑工具) 苹果电脑版

软件功能

1、编辑功能

（1）markdown编辑

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

（2）模板插入

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

（3）历史版本

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

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

3、权限管理

（1）公开项目与私密项目

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

（2）项目转让

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

（3）项目成员

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

（4）团队管理

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

软件用途

1、API文档

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

2、数据字典

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

3、说明文档

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

ShowDoc是什么

每当接手一个他人的模块或者项目，看着那些没有解释说明的资料，我们都无比抓狂。文档呢？！文档呢？！Show me the doc ！！

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

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

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

更新日志

Showdoc v2.4.0更新日志：

1、界面简洁友好

2、性能体验优化提升

3、修复了已知bug