ShowDoc

ShowDoc 是一个给技术团队写文档的在线工具。后端写接口、前端对接、测试查参数，这些场景里同一份 API 说明往往要反复传阅，它把这些内容集中到网页上编辑和查看。除了 API 文档，也能用来写数据库的数据字典、工具说明书和技术规范。

主要功能

编辑方式是网页上的富文本与 Markdown 编辑，写接口时按路径、请求参数、返回示例分块填写，出来的页面排版整齐，方便直接发给对接方。数据字典用来描述数据库表结构，说明文档则适合放规范、流程这类需要团队长期查阅的内容。

• 团队权限管理，多人协同编写同一批文档
• 可从代码注释自动生成文档
• 搭配 RunApi 客户端调试接口，并自动生成文档

托管与开源

官方提供在线托管服务，文档数据放在云端；同时有免费开源版本，可以部署到自己的服务器上，适合对数据存放位置有要求的团队。页面上标注平台已稳定运行 3996 天，托管文档数超过一千万，服务用户超过五十万。

适合谁

主要面向有接口对接需求的研发团队，尤其是后端与前端、外部合作方之间需要共享接口说明的场合。页面提到腾讯、百度、华为、字节跳动、顺丰等团队在使用。如果只是个人记笔记，功能会偏重；团队规模小、文档量不大时，用普通文档工具也能应付。