ShowDoc

ShowDoc官方主站（https://www.showdoc.com.cn）是国内主流IT技术文档协同开源平台官网，主打API接口文档、数据库字典、技术规范、团队知识库一体化管理，同时提供云端在线托管服务与免费私有化开源部署方案，深度联动RunAPI接口调试工具，集成AI辅助写文档、多格式自动导入、精细化权限、版本回溯能力，网页端支持在线文档编辑、项目创建、团队管理、私有化部署教程、客户端下载，是研发团队、技术人员搭建线上知识库、维护接口文档的核心官方门户。

ShowDoc官网入口：https://www.showdoc.com.cn

核心功能

• API文档自动生成+私有化开源双核心生态（平台核心特色）：专为前后端研发团队打造，内置专用API、数据字典Markdown模板，支持代码注释、Swagger、Postman、RunAPI一键导入自动生成接口文档；提供在线云端托管与Apache开源私有化部署两套模式，数据自主可控，十万级互联网企业团队（腾讯、华为、字节等）长期落地使用。
• 全类型技术文档创作引擎：原生强化Markdown编辑器，适配接口文档、数据库表结构、产品需求、运维手册、开发规范、内部知识库；支持代码块、表格、流程图、图片附件、视频嵌入，暗黑/明亮双主题，中英文界面一键切换。
• RunAPI深度联动一体化工作流：配套自研接口调试工具RunAPI，调试请求响应数据实时同步至ShowDoc，边测接口边自动更新文档，消除调试与文档分离、接口文档滞后痛点，大幅降低前后端沟通成本。
• AI智能文档辅助能力：内置大模型AI助手，支持接口说明生成、文案润色、内容翻译、需求文档自动撰写，输入关键字快速产出标准化技术内容，减少重复文案编写工作量。
• 多层级项目权限管控：区分公开项目、私密加密项目，自定义成员只读/可编辑/管理员角色；支持项目转让、外链密码、访问时效、水印管控，适配内部涉密技术资料对外合作分享。
• 完整版本追溯与评论体系：每一次编辑自动留存历史快照，一键对比差异、回滚旧版本；页面支持划词评论，研发、产品、测试在线批注同步沟通，无需IM反复传输文档。
• 多格式导入导出能力：兼容Swagger、Postman、Markdown压缩包批量导入；文档可导出Word、离线静态网页，支持完整项目打包备份，方便线下归档交付第三方。
• 全域高速全文检索：海量项目文档秒级检索，支持标题、正文、接口路径、字段关键词模糊匹配，快速定位历史接口、数据库字段、技术规范。
• 全终端跨端适配：网页端完整功能，配套Windows、macOS、iOS、Android多端客户端，手机随时随地查阅接口文档、修改简短说明。
• 灵活部署与存储方案：公有云托管开箱即用，私有部署支持Docker、宝塔、脚本多种安装方式，附件可对接阿里云、七牛云对象存储，满足政企数据合规隔离需求。

用户群体

ShowDoc网页平台面向后端开发、前端工程师、测试工程师、产品经理、运维人员、架构师、外包研发团队、互联网企业、政企技术部门、软件创业公司、独立开发者、计算机专业学生使用。覆盖API接口文档维护、数据库字典整理、研发知识库沉淀、前后端协同、私有化技术平台搭建、Postman/Swagger批量导入、接口调试联动文档、技术手册编写等场景。

showdoc.com官网以API专用文档模板、RunAPI接口调试联动、开源私有化部署、AI辅助技术写作、精细化项目权限、全格式自动导入、完整版本管理、十万企业落地验证为核心定位，解决传统Word接口文档版本混乱、更新滞后、团队传阅低效、企业技术数据无法自主管控等痛点，国内专业研发团队技术文档协同开源官方门户。