【资源推荐】良心之作！超过 10000+ 的互联网团队正在使用的在线 API 文档、技术文档工具...

搞开发的同学都知道一个好的 API 文档是有多重要！

每当接手一个别人开发好的项目，看着那些没有注释的代码，真的头大。

程序员都很希望别人能写技术文档，因为可以提高自己开发的效率，而往往自己却很不希望要写文档。毕竟写文档要花大量的时间去弄格式和排版，很多琐碎的事情并不是程序员关心的。

而如果一直以word文档传来传去，或者靠吼，一是显得不专业，二是不利于团队长期高效工作。

本次给大家推荐一个在线 API 文档的开源工具：ShowDoc

目前该开源项目已经星标7.5k了，作者是 star7th。

链接：https://github.com/star7th/showdoc

▍ShowDoc介绍

相信很多朋友也知道这个开源项目，因为这个开源团队宣称已经有超过1万多个互联网团队在使用它了。

当然了，一般大公司肯定都有比较成体系的内部工具，所以这个项目对于小公司开发团队来说无疑是一个宝藏。

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

▍ShowDoc可以用来做什么？

01 API文档

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

02 数据字典

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

03 说明文档

你完全可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。showdoc的帮助文档就是一个很好的示例，而且全部是中文。

https://www.showdoc.cc/

▍ShowDoc都有哪些功能？

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

01 分享与导出

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

02 权限管理

• 公开项目与私密项目

• 项目转让

• 项目成员

• 团队管理

03 编辑功能

• markdown编辑

• 模板插入

• 历史版本

04 多平台

showdoc支持网页版、手机app版和电脑客户端版。客户端地址可见：

https://www.showdoc.cc/clients

▍使用在线的ShowDoc

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

• 在线showdoc作为在线服务会长期维护，请放心托管数据

▍部署到自己的服务器

• ShowDoc部署手册请参考：

  https://www.showdoc.cc/help?page_id=13732

• 开源地址：

  https://github.com/star7th/showdoc 

• 二次开发指引：

  https://www.showdoc.cc/help?page_id=1385576954326448

- end -



往期精彩回顾



适合初学者入门人工智能的路线及资料下载机器学习及深度学习笔记等资料打印机器学习在线手册深度学习笔记专辑《统计学习方法》的代码复现专辑
AI基础下载机器学习的数学基础专辑获取一折本站知识星球优惠券，复制链接直接打开：https://t.zsxq.com/yFQV7am本站qq群1003271085。加入微信群请扫码进群：