ShowDoc：专为技术团队设计的开源在线API文档协作工具

前后端联调时接口文档到处传版本号、新人入职要的项目部署手册散在聊天记录里找不到，ShowDoc（小猿文档）是国内开发者圈子普及率很高的开源在线技术文档协作平台。从2016年上线至今，它专门面向技术团队场景优化，不用复杂配置就能搭起团队专属的API接口文档、部署手册、内部Wiki知识库，不用再把文档到处甩在群聊里。

ShowDoc官方域名为 www.showdoc.com.cn，运营主体为广州萧汉科技有限公司，持有正规ICP备案，公有云站点所有人都可以直接注册使用，同时项目代码完全开源，支持Docker一键私有部署，很多中小互联网团队内网里用的文档工具都是自己搭的ShowDoc。

ShowDoc可以直接在线用吗，要注册吗？

公有云站点直接打开官网，用手机号注册账号就能立刻创建项目空间，完全不需要复杂的部署操作，普通小团队注册完，几分钟就能搭好第一个文档库。免费版支持最多5个独立项目空间，每个项目最多邀请100名成员协作，普通开发团队日常使用完全够用，不需要一开始就采购付费的企业级文档服务。
如果对数据安全要求比较高，不想把技术文档上传到第三方公有云，完全可以自己拿开源代码在团队内网服务器部署私有版本，所有文档数据100%存在自己公司的服务器上，完全不用担心技术资料泄露。实测里很多人数不多的创业团队，就是花5分钟Docker命令就部署完了，不用找专门的运维人力来维护。

ShowDoc最适合用来写什么类型的文档？

它不是通用型的云笔记，从设计之初就是冲着技术团队的高频场景优化的，这几个场景几乎所有开发团队都用得上：

• ‌API接口文档‌：自带标准化的API模板，请求方式、参数说明、返回示例这些字段自动对齐格式，不用自己手动调整排版，写完接口直接给前后端同事看，不会出现不同人写的文档格式乱、信息不全的问题
• ‌项目部署手册‌：把服务器环境配置、上线步骤、常见运维问题都整理在这里，新运维上手照着步骤走就能完成上线，不用老员工反复口头教
• ‌内部技术Wiki‌：团队沉淀的技术方案、踩坑记录、公共组件说明都集中存在这里，新人入职直接丢一个文档链接就能快速上手，不用挨个找前辈答疑
• ‌产品需求文档‌：支持插入流程图、思维导图、代码片段，产品、开发、测试三方对着同一个文档对齐信息，不用在群里来回甩不同版本的Word附件。

这里分享一个很多老开发者都没发现的实测小技巧：在ShowDoc的Markdown文档编辑页面，按下 ‌Ctrl+Shift+D‌ 就能直接生成当前页面的Markdown源码下载链接，不用在层层嵌套的导出菜单里点好几次，要把文档内容同步到本地笔记、或者复制给其他工具的时候，一步就能拿到纯源码，省了很多手动复制粘贴调整格式的时间。

ShowDoc比普通云笔记写技术文档好用在哪？

和通用型云笔记比，ShowDoc针对技术场景的优化细节明显更顺手：

1. API文档自带在线调试功能：写完接口的URL和参数后，直接点页面上的”发送请求”按钮就能在线调试返回结果，不用切到Postman或者其他接口测试工具，前后端联调的时候效率高很多
2. 代码块格式自动适配：写命令行片段、代码示例的时候，自动支持语法高亮，不会像普通云笔记那样把缩进和换行搞乱，技术内容展示不会变形
3. 支持直接生成UML图、时序图：不用打开外部绘图软件画完再截图插入，在文档里直接写简单的文本语法就能生成时序图、流程图，文档里的技术图示修改起来特别方便
4. 细粒度权限控制：可以给不同成员分配不同的角色，普通开发只能编辑自己负责的接口页面，测试可以只开查看权限，不会出现文档被无关人员误删的情况。

用ShowDoc写技术文档要注意什么？

• 公有云站点的团队空间创建后，要及时设置好成员权限，不要随便把编辑权限开放给所有拿到链接的人，避免重要接口文档被恶意修改
• 重要的团队文档建议定期导出备份到本地，不要完全依赖云端存储，避免极端情况导致文档丢失
• 自己私有部署版本要记得及时升级官方最新版本，打安全补丁，避免出现未授权访问的安全漏洞
• 一定要认准官方域名www.showdoc.com.cn，网上有很多仿冒的同名站点，不要在不明站点上传公司核心技术文档，避免信息泄露。

总的来说，ShowDoc是专门为技术团队做的轻量化文档工具，它没有通用笔记里多余的花哨功能，所有设计都围绕写技术文档的需求来，免费开源的门槛很低，小团队搭内部知识库用它性价比很高。现在打开ShowDoc官网注册账号，就能立刻开始创建你的第一个项目技术文档。

常见问题解答

‌Q：ShowDoc可以完全免费自己部署吗？‌
A：可以，项目核心代码完全开源，支持Docker一键部署，所有数据都保存在你自己的服务器上，没有额外的部署费用，对数据安全要求高的团队可以直接自行搭建内网版本。

‌Q：ShowDoc的API文档支持在线调试吗？‌
A：支持，写完接口的参数配置后，直接点文档页面上的发送按钮即可发起请求，返回的响应结果会直接展示在页面上，不用切换到其他接口测试工具。

‌Q：ShowDoc支持多人同时协作编辑吗？‌
A：支持，团队成员可以同时编辑同一份文档，修改内容会实时同步，同时系统会记录每一次的修改人和修改时间，随时可以回溯历史版本。

‌Q：ShowDoc免费版有功能限制吗？‌
A：个人用户和5人以内小团队用免费版基本没有功能门槛，普通文档数量、协作人数、单附件上限都完全够用，付费版主要面向中大型团队开放自定义域名、高级权限管控等增值功能。

首页截图