推荐一个API文档管理系统——ShowDoc
它可以做管理 API文档 数据字典和 说明文档。而且他的编辑界面可以记录历史修改的记录,还可以还原到以前修改的文档的历史,像SVN一样。
详细的介绍请看官网 https://www.showdoc.cc/
支持用户线上维护,也可以开源下载
github地址 https://github.com/star7th/showdoc
- API文档 (查看Demo)
随着移动互联网的发展,BaaS(后端即服务)越来越流行。服务端提供API,APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档。
- 数据字典 ( 查看Demo)
一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。
- 说明文档 (查看Demo )
你完全可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。