在线文档分享工具 ShowDoc

Apache
PHP
跨平台
2015-11-28
xingchen

ShowDoc是什么

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

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

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

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

的码云指数为
超过 的项目
加载中

评论(18)

李虎头
李虎头
用go语言写了一个版本,供大家参考,不推荐实际应用 https://github.com/kphcdr/godoc
风里的叶子
风里的叶子
可以试下https://gitee.com/treeleaf/xDoc, 基于java注释生成在线和离线文档
hc24
hc24
swagger了解下
杜福忠
杜福忠
好东西, 找了很久, 差点自己写了, 还好遇见你
叶海
叶海
求大神解惑,如何设置showdoc的目录顺序?
x
xuzhibin
不想写数据字典的,可以用这个http://sql.qwolf.com,支持showdoc
RoyMiller
RoyMiller
有图片转word的时候,word里图片大小有问题
元谷
元谷
看样子很不错
r
romeo0
感觉写markdown还是不够方便啊...这个和目前项目组编写的差不多,我们还是每次写文档都很抓狂。最好是可以直接根据api请求直接生成文档的。
曹令辉
曹令辉
先赞一下。我也考虑设计一个研发过程专用文档管理工具。建议考虑研发过程中需求、设计、测试文档,以及在三种文档之前建立关联。如果仅仅是通用文档管理,用wiki就可以做到。

ShowDoc v2.4.3 发布,IT 团队的在线 API 文档工具

更新内容: 1,修复了一个安全问题,此问题将导致文档数据被越权修改。请使用开源版showdoc的用户尽快升级到新版。 2,新增用户姓名字段并在团队成员中显示 3,优化表格宽度。当表格列数少于...

2018/12/03 09:12

ShowDoc 发布 v2.4.1,支持 LDAP 认证登录

【showdoc v2.4.1 更新公告】 开源版showdoc增加了企业ldap登录的支持,可在管理后台配置。 开源版showdoc增加了是否允许公开注册的开关,可在管理后台配置。 对于showdoc原用户,如果要启用...

2018/11/20 16:07

ShowDoc v2.4.0 发布,IT 团队的在线 API 文档工具

更新内容: 为了加强多人多团队情形下的项目协作,showdoc正式推出团队管理功能。Team leader可以在项目列表页面找到团队管理按钮,然后添加团队。添加团队后,可以随时增加/删除团队成员、批...

2018/11/03 15:04

ShowDoc v2.3.3 发布,IT 团队的在线 API 文档工具

ShowDoc v2.3.3 已发布,这是一个 IT 团队的在线 API 文档工具。 更新内容: 为了应对复杂项目内容的分类需求,showdoc在原来目录支持的基础上增加一层子目录,支持到了三级目录。用户在新建...

2018/10/26 11:17

ShowDoc 更新:新增一键自动安装/升级脚本

前言 自动脚本脚本利用docker来安装运行环境,适用于linux服务器。如果你的服务器没有docker服务,脚本会尝试安装之。如果你已经安装过docker,脚本会省略部分步骤,从而加快showdoc安装进度...

2018/09/01 09:10

ShowDoc v2.3.0 发布,可通过程序自动生成API文档

ShowDoc v2.3.0 发布了,更新内容: 1、可以通过代码注释自动生成API文档,详情看文档https://www.showdoc.cc/page/741656402509783 2、优化json格式化功能 3、fix管理后台的控制台报错 4、登...

2018/08/19 10:26

ShowDoc v2.2.1 发布,IT 团队的在线 API 文档工具

更新内容: 增加对IE11和edge浏览器的兼容支持 登录/注册页面,项目密码页面增加回车快捷键支持 修改个人设置页面在某些浏览器下不能点击返回的bug 调整了左侧栏的行高 修复编辑器在某些情况...

2018/08/05 12:51

ShowDoc v2.2.0 发布,IT 团队的在线 API 文档工具

ShowDoc v2.2.0 发布,IT 团队的在线 API 文档工具。 更新内容: 开源版 showdoc 新增管理后功能,可以从管理后台新增、删除用户,以及对全部项目进行集中管理等。 默认管理员账户密码是 sh...

2018/07/25 08:45

ShowDoc v2.1.0 发布,IT 团队的在线 API 文档工具

ShowDoc v2.1.0 发布,IT 团队的在线 API 文档工具 更新内容: 支持自动生成数据字典文档:脚本自动运行,更改表结构后会同步更新文档,以后更新数据字典再也不用手动维护。详情可见:https...

2018/04/23 09:49

ShowDoc 2.0.5 发布,IT 团队的在线 API 文档工具

ShowDoc 2.0.5 发布了。 更新内容: 1、优化UI 2、修复编辑目录的bug。此bug可能会导致目录消失不见 3、修复粘贴图片上传问题。从网络或者截屏处复制过来的图片可以在编辑器直接粘贴 4、修复...

2018/03/01 11:10

没有更多内容

加载失败,请刷新页面

暂无问答

centos7:搭建ShowDoc

1、nginx yum install -y epel-release yum install -y nginx cp /etc/nginx/nginx.conf /etc/nginx/nginx.conf.bak #修改nginx配置文件 vim /etc/nginx/nginx.conf 38 server { 39 listen ...

2018/08/03 17:31
166
0
showdoc

现在在公司的文档中心是基于git+docsify来的。这种方式,就是对于程序员来说还好,因为让程序员写markdown文档还是比较方便的。 但是没有一个网站来写文档,对于很多人来说确实是不够方便的。...

2018/10/30 07:11
14
0
showdoc的安装与密码找回

这次showdoc的安装方式,我采用的是docker的方式来安装的。这样可以简化一些安装。 showdoc帮助文档 Docke方式安装 showdoc找回账号密码

2018/11/19 17:25
268
0
节假日API 新增整月整年 接口 方便万年历调用

更新日志 1.新增type= 8 返回一年的节日和补休日 可结合info=1获取详细信息 2.新增type= 9 返回一个月的详细信息包括农历,黄历,节日信息结合backtype 1黄历 2黄历农历 3黄历节日 4黄历农历节...

2018/12/06 17:47
61
0
开放文档api编写

开放文档api编写

2018/04/18 10:49
30
0
车型车系品牌api离线版 CarApi

CarApi 介绍 免费车型车系品牌api 参数 ?type=(brand,series,series_group,info,detail)&id= 支持http https 的get 和 post 请求 采用汽车之家离线数据源可部署到自己服务器 软件架构 PHP+tx...

01/18 16:39
30
0
Linux下数据库sqlite3常用命令

今天遇到同事showdoc忘记密码了。需要重构一下密码。因为采用的是用sqllite来存数据的方式。 所以需要修改数据库的方式了。 sudo apt install sqlite3 Linux下数据库sqlite3常用命令 .heade...

2018/11/30 18:17
20
0
ipa 安装包不用市场如果扫码下载安装 免费IOS安装API

在做开发过程中可能会用于生成测试包的情况,不过测试包不能直接安装,非常不方便,所以我提供给大家一下可通过链接下载安装的方法也可以把链接生成二维码扫码下载 api地址: https://tool.bite...

2018/07/17 14:38
345
0
新增免费根据商品条码查询商品名称API

免费API 可根据商品条码查询商品名称 本人把搜集成的一些网上公开的一些条码数据导入到一个数据库中,做了本api供大家免费调用. http://tool.bitefu.net/barcode/?code=6901294171206 当然商品...

2018/09/29 18:25
102
0

没有更多内容

加载失败,请刷新页面

返回顶部
顶部