ShowDoc 简介
概念:一个非常适合互联网IT技术团队的在线API接口文档、技术文档工具。也就是一个制作API接口的Web开源系统,通过这个系统我们可以将自己写的程序接口放入系统中,可以让团队中的人方便的通过网页查看和使用。
特性:
- 制作API文档:随着移动互联网的发展,BaaS(后端即服务)越来越流行。服务端提供API,APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档。
- 数据字典:一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。
- 说明文档:你完全可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅
- 团队协作:团队权限管理机制让团队良好地协同编写文档
- 免费开源:ShowDoc提供免费开源的版本,你可以选择将ShowDoc部署到你的服务器
- 在线托管:www.showdoc.cc 提供安全稳定的在线文档托管服务,你可以放心地选择托管你的文档数据在云端
ShowDoc 历史及由来
由来:
- 每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂。文档呢?!文档呢?!Show me the doc !!
- 程序员都很希望别人能写技术文档,而自己却很不希望要写文档。因为写文档需要花大量的时间去处理格式排版,想着新建的word文档放在哪个目录等各种非技术细节。
- word文档零零散散地放在团队不同人那里,需要文档的人基本靠吼,吼一声然后上qq或者邮箱接收对方丢过来的文档。这种沟通方式当然可以,只是效率不高。
- ShowDoc就是一个非常适合IT团队的在线文档分享工具,它可以加快团队之间沟通的效率。
ShowDoc 版本更新说明
本版本主要更新:
- 可在管理后台设置图片和附件上传到阿里云或七牛云
- 修复了一个上传文件的安全漏洞
- 编辑器增加三个按钮,对应的功能分别是插入标题目录TOC、插入视频和图文居中
- 让编辑器的预览效果和实际样式保持一致,同时优化markdown渲染样式
- 新增批量分配项目到团队功能
- 新增团队转让功能
本版本同时包含的次要更新:
- 修复了一个单页分享地址的bug
- 分享的网页标题改为页面标题
- 访问密码页面对回车键支持
- 编辑器初始化时保持工具栏在网页顶部
- 修正卡片式页面里的元素对齐问题
- 修复代码块中换行符丢失的问题
- 解决标题过长时隐藏的bug
更新步骤请参考请参考手册的升级安装部分:https://www.showdoc.cc/help?page_id=13732,关于Showdoc的详细介绍,请看:https://www.showdoc.cc/help