开源的在线 API 文档、技术文档工具 ShowDoc

2016-09-05 22:43:12 +08:00
 star7th

ShowDoc 是什么

每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂。文档呢?!文档呢?!Show me the doc !!

程序员都很希望别人能写技术文档,而自己却很不希望要写文档。因为写文档需要花大量的时间去处理格式排版,想着新建的 word 文档放在哪个目录等各种非技术细节。

word 文档零零散散地放在团队不同人那里,需要文档的人基本靠吼,吼一声然后上 qq 或者邮箱接收对方丢过来的文档。这种沟通方式当然可以,只是效率不高。

ShowDoc 就是一个非常适合 IT 团队的在线文档分享工具,它可以加快团队之间沟通的效率。

它可以用来做什么

它都有些什么功能

部署到自己的服务器

使用在线的 ShowDoc

版权

ShowDoc 交流群

11615 次点击
所在节点    程序员
22 条回复
YORYOR
2016-09-05 23:31:51 +08:00
不错 先收藏 再试用
azh7138m
2016-09-06 00:00:07 +08:00
正在用,支持一个
gouki
2016-09-06 00:51:15 +08:00
呵呵一笑
fengxucn
2016-09-06 08:08:12 +08:00
用了好久了。
ersic
2016-09-06 08:40:27 +08:00
看云有在线 API 调试和 Git 版本控制,感觉你们产品没什么优势。
johnzh
2016-09-06 09:45:41 +08:00
对比下 readthedoc 呢?有啥优缺点?
SpicyCat
2016-09-06 10:53:23 +08:00
@johnzh readthedoc 貌似不支持 user management?
SpicyCat
2016-09-06 10:55:41 +08:00
@ersic 搜了下看云,貌似不开源?
janesccot
2016-09-06 11:47:10 +08:00
我正想找的,原来您这就有, 666
star7th
2016-09-06 14:34:03 +08:00
@ersic “在线 API 调试和 Git 版本控制””,其实 ShowDoc 也提供了简单的在线调试以及页面历史版本功能。另外, ShowDoc 相比看云最大的优势在于开源。很多企业或者团队对数据比较敏感,开源部署到他们服务器的话他们比较放心。
star7th
2016-09-06 14:35:57 +08:00
@johnzh 没怎么用过 readthedocs 。 ShowDoc 最大的优势在于开源。很多企业或者团队对数据比较敏感,开源部署到他们服务器的话他们比较放心。另外不太清楚 readthedocs 是否有团队协作功能
tomczhen
2016-09-06 16:48:18 +08:00
我还是继续用 fitnesse 了,测试和文档一体化。
zhihaofans
2016-09-06 18:44:16 +08:00
收藏
star7th
2016-09-06 20:13:21 +08:00
@tomczhen fitnesse 也不错, ShowDoc 跟它的定位不一样。 ShowDoc 更多定位于文档的编辑与阅读,不限于 api 文档。所以 api 测试功能在 ShowDoc 上会是个很轻量的附加功能
ixinshang
2016-09-06 23:03:06 +08:00
感谢第七 星尘的 MP3 盘
star7th
2016-09-07 00:25:56 +08:00
@ixinshang 三四年前的开源项目还有人用啊!不知用 mp3 盘的用户群主要集中在哪里,如果还比较有需求,我再重写下
BrightDawn
2016-09-07 10:04:48 +08:00
http://www.showdoc.cc/php?page_id=15072 这页的侧栏应该是 Ubuntu 安装,原文是 Ubutun 。
colincat
2016-09-07 10:11:06 +08:00
@johnzh 推荐你用 rap ,小光
star7th
2016-09-07 15:29:07 +08:00
@BrightDawn 不太懂你的意思。它的侧栏文字不是“ Ubutun 安装 PHP ”么
BrightDawn
2016-09-07 15:39:23 +08:00
@star7th Ubutun ->Ubuntu

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/304159

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX