目录
ShowDoc由东莞市冬惊鱼网络科技有限公司开发,诞生源于程序员群体普遍面临的一个痛点:接手项目时缺乏文档,或文档散落在各处难以维护。它提供了一个结构化的在线文档中心,让团队成员可以通过“项目-目录-页面”的方式组织文档,原生支持Markdown语法,并内置了接口模板和数据字典模板,大幅降低了技术文档的编写和维护成本。如今,已有超过10万家团队在使用ShowDoc,中不乏腾讯、华为、百度、字节跳动等知名企业。
官网入口地址
下载地址
可通过官网首页下载适用于Windows、Mac的桌面客户端,以及iOS和Android的手机App。
功能介绍
ShowDoc的功能精准围绕技术团队的文档协作流程设计。
-
结构化的文档组织:以项目(对应一个系统或业务线)、目录(按模块归类)、页面(具体文档)三级结构管理文档,告别散乱。
-
Markdown与模板编辑:原生支持Markdown语法和代码高亮,并可一键插入“API接口模板”和“数据字典模板”,直接填入信息即可快速生成格式规范的文档。
-
自动化文档生成:支持从代码注释自动生成API文档;更推荐配合RunApi客户端使用,在调试接口后点击“同步到ShowDoc”,即可自动生成或更新接口文档,极大地减少手工维护工作量。
-
团队协作与权限管理:支持添加项目成员协同编辑。项目分为“公开项目”(任何人可访问)和“私密项目”(需密码访问),便于控制文档的对外分享范围。
-
历史版本与导出:每个页面都保存历史版本,可随时回滚。项目支持导出为Word文件,方便线下存档或发送给外部合作方。
-
多平台与部署方式:提供网页版、电脑客户端和手机App。同时支持私有化部署,企业可将数据掌控在自己的服务器上。
应用场景
-
API文档中心:统一管理所有系统接口的地址、入参、出参、错误码和示例,方便前后端开发及外部对接方查阅。
-
数据字典:清晰说明数据库各表、各字段的含义(如订单状态值代表什么),减少沟通歧义。
-
系统/产品说明书:记录系统架构、模块划分、关键业务流程,供新入职同事或业务方快速了解系统。
-
运维与排错手册:沉淀常见故障的排查步骤、日志位置、紧急联系人等信息,保障系统出问题时能快速响应。
-
团队技术知识库:集中存放踩坑记录、实践、FAQ,促进团队知识积累与共享。
定价信息
ShowDoc采用SaaS服务收费与开源版本免费并行的模式。
-
免费版:可使用绝大部分功能,但有一定的配额限制,适合小型团队或个人入门使用。
-
付费版:
-
高级版:99元/年。协作成员10人,项目30个,存储空间2G等。
-
专业版:299元/年。协作成员30人,项目60个,存储空间5G等。
-
旗舰版:999元/年。不限协作成员和项目数,存储空间100G等。
-
-
开源免费版:ShowDoc本身是基于Apache2开源协议发布的,开发者可以获取开源代码自行部署,免费核心功能,适合有私有化部署需求和技术能力的团队。
| 源码反馈/咨询 (共有 条反馈) |
Showdoc常见问题
是由东莞市冬惊鱼网络科技有限公司(前身或关联开发者也可追溯到个人开发者star7th)开发和运营的。
是为IT团队设计的在线API文档和技术文档协作工具。你可以理解为一个专门存放和管理技术文档的在线“图书馆”,尤适合整理API接口说明、数据字典、系统设计文档等。
用起来很贴合技术人员的习惯。注册账号后,先为你的系统创建一个“项目”,然后在项目里用“目录”来分类,在“页面”里用Markdown编写具体文档。最方便的是,在编辑页面点击“插入模板”,选择“API接口模板”或“数据字典模板”,填上信息就行。还能配合RunApi工具,调试完接口后一键同步生成文档。
有免费的版本,同时提供付费SaaS服务。在官网注册使用的版本有免费配额,够小团队起步。如果需要更多协作人数、项目数或存储空间,可以升级到付费版,价格从99元/年到999元/年不等。ShowDoc也提供开源免费版,可以自行部署到自己的服务器上。
在安全方面给了用户选择权。它支持私有化部署,你可以把整个系统安装在自己的服务器上,数据自主掌控。在权限上,项目可以设置成需要登录或输入密码才能访问的“私密项目”,并且可以控制哪些成员是编辑者,哪些是查看者。对数据安全有高要求的团队可以考虑私有化方案。
核心的技巧是利用自动化能力,别纯手工写文档。如果配合RunApi客户端,在调试接口通过后点“同步到ShowDoc”,就能自动生成或更新接口文档,省去大量手动录入。善用内置模板,新建页面时插入API模板或数据字典模板,只用修改数据,格式和排版都不用操心。写文档时,多用Markdown,效率和体验都比富文本好很多。
鲜明的特色是面向技术文档场景的深度定制。比如内置的API接口模板和数据字典模板,非常贴合开发者的实际工作流。与他通用文档工具不同,ShowDoc的理念是“调完接口,文档也就写好了”。因此它的核心用途非常聚焦:高效地编写、维护和分享API文档、数据字典和技术规范,很适合作为团队的官方接口文档中心。
数据安全有相应的保障。一方面是前面提到的私有化部署选项,能从物理上保证数据不外流。另一方面,SaaS版本的数据存储在云端,平台会负责数据备份。同时,ShowDoc的页面提供历史版本管理,每次修改都会保存,误删或改错可以随时恢复,相当于给文档上了一层保险。
对于需要管理API文档和技术文档的团队来说,它是很顺手的工具。它界面简洁,功能围绕技术文档这一核心场景设计,没有太多冗余功能。而且它提供了网页版、电脑客户端和手机App,随时随地都能查看或编辑文档。对技术人员来说,用熟悉的Markdown语法就能写出排版漂亮的文档,学习成本很低。
作为一款基于网页技术构建的在线文档工具,它在日常使用中非常轻量。无论是通过浏览器访问,还是使用桌面客户端,编辑文字、查看文档时对电脑资源的占用都很小,不会影响他开发工具或大型软件的运行。只有在大量上传图片或附件时,才会有短时的网络和资源占用。
支持的平台比较全面。包括Windows、Mac电脑客户端,iOS、Android手机App,以及网页版。这样无论是开发人员在工位上,还是需要在外处理工作,都能访问到的文档。
可以。文档保存在云端,团队成员在任何端(电脑、手机)进行编辑或修改后,他成员刷新页面就能看到内容。这种实时的同步和共享能力,正是它作为协作工具的核心价值,可确保团队所有人查阅的都是同一份的文档,避免了版本混乱的问题。