每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂。文档呢?!文档呢?!Show me the doc !!
程序员都很希望别人能写技术文档,而自己却很不希望要写文档。因为写文档需要花大量的时间去处理格式排版,想着新建的 word 文档放在哪个目录等各种非技术细节。
word 文档零零散散地放在团队不同人那里,需要文档的人基本靠吼,吼一声然后上 qq 或者邮箱接收对方丢过来的文档。这种沟通方式当然可以,只是效率不高。
ShowDoc 就是一个非常适合 IT 团队的在线文档分享工具,它可以加快团队之间沟通的效率。
API 文档( 查看 Demo)
随着移动互联网的发展, BaaS (后端即服务)越来越流行。服务端提供 API , APP 端或者网页前端便可方便调用数据。用 ShowDoc 可以非常方便快速地编写出美观的 API 文档。
数据字典( 查看 Demo)
一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。
说明文档(查看 Demo )
你完全可以使用 showdoc 来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。
** 分享与导出 **
** 权限管理 **
公开项目与私密项目
ShowDoc 上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问,而私密项目则需要输入密码验证访问。密码由项目创建者设置。
项目转让
项目创建者可以自由地把项目转让给网站的其他用户。
项目成员
你可以很方便地为 ShowDoc 的项目添加、删除项目成员。项目成员可以对项目进行编辑,但不可转让或删除项目(只有项目创建者才有权限)
** 编辑功能 **
markdown 编辑
ShowDoc 采用 markdown 编辑器,无论是编辑还是阅读体验都极佳很棒。如果你不了解 Markdown ,请在搜索引擎搜索"认识与入门 Markdown"
模板插入
在 ShowDoc 的编辑页面,点击编辑器上方的按钮可方便地插入 API 接口模板和数据字典模板。插入模板后,剩下的就是改动数据了,省去了很多编辑的力气。
历史版本
ShowDoc 为页面提供历史版本功能,你可以方便地把页面恢复到之前的版本。
ShowDoc 部署手册
如果你没有自己的服务器,但又想使用 ShowDoc 作为分档分享工具,你可以使用在线的 ShowDoc http://www.showdoc.cc
http://www.showdoc.cc 作为在线服务会长期维护,请放心托管你的文档数据,不用担心突然关站的问题。如对数据非常敏感的个人或企业,还是把 ShowDoc 部署到自己的服务器比较好。
1
YORYOR 2016-09-05 23:31:51 +08:00
不错 先收藏 再试用
|
2
azh7138m 2016-09-06 00:00:07 +08:00 via Android
正在用,支持一个
|
3
gouki 2016-09-06 00:51:15 +08:00
呵呵一笑
|
4
fengxucn 2016-09-06 08:08:12 +08:00
用了好久了。
|
5
ersic 2016-09-06 08:40:27 +08:00
看云有在线 API 调试和 Git 版本控制,感觉你们产品没什么优势。
|
6
johnzh 2016-09-06 09:45:41 +08:00
对比下 readthedoc 呢?有啥优缺点?
|
9
janesccot 2016-09-06 11:47:10 +08:00
我正想找的,原来您这就有, 666
|
10
star7th OP @ersic “在线 API 调试和 Git 版本控制””,其实 ShowDoc 也提供了简单的在线调试以及页面历史版本功能。另外, ShowDoc 相比看云最大的优势在于开源。很多企业或者团队对数据比较敏感,开源部署到他们服务器的话他们比较放心。
|
11
star7th OP @johnzh 没怎么用过 readthedocs 。 ShowDoc 最大的优势在于开源。很多企业或者团队对数据比较敏感,开源部署到他们服务器的话他们比较放心。另外不太清楚 readthedocs 是否有团队协作功能
|
12
tomczhen 2016-09-06 16:48:18 +08:00
我还是继续用 fitnesse 了,测试和文档一体化。
|
13
zhihaofans 2016-09-06 18:44:16 +08:00 via Android
收藏
|
14
star7th OP @tomczhen fitnesse 也不错, ShowDoc 跟它的定位不一样。 ShowDoc 更多定位于文档的编辑与阅读,不限于 api 文档。所以 api 测试功能在 ShowDoc 上会是个很轻量的附加功能
|
15
ixinshang 2016-09-06 23:03:06 +08:00
感谢第七 星尘的 MP3 盘
|
16
star7th OP @ixinshang 三四年前的开源项目还有人用啊!不知用 mp3 盘的用户群主要集中在哪里,如果还比较有需求,我再重写下
|
17
BrightDawn 2016-09-07 10:04:48 +08:00
http://www.showdoc.cc/php?page_id=15072 这页的侧栏应该是 Ubuntu 安装,原文是 Ubutun 。
|
19
star7th OP @BrightDawn 不太懂你的意思。它的侧栏文字不是“ Ubutun 安装 PHP ”么
|
20
BrightDawn 2016-09-07 15:39:23 +08:00
@star7th Ubutun ->Ubuntu
|
22
balabalaguguji 2019-01-17 09:52:37 +08:00
推荐你试下 https://easydoc.xyz 这个是我用过最好的
|