CodeArt-编码艺术

折腾来折腾去最后还是用WiKi

字数统计: 585阅读时长: 2 min
2019/03/28 Share

公司这么些年,人走的越来越快,文档输出的也越来越少,导致坑也越来越难填

曾经各类文档百花齐放,doc的,在线的,txt的,QQ聊天记录的

去年起我们开始着手对于新产品及新项目文档进行统一管理,主要从接口文档开始

一、 首先使用了广受好评的PostMan

我一直使用PostMan来测试管理我的接口,全局变量,Tests使用的相当舒心方便。

不过在文档共享方面对于我们来说有这样几个缺陷:

1.在线文档访问较慢

2.不能很好的对返回数据进行备注,容易被移动端一顿喷

所以对于文档功能,舍弃之。

二、 再使用rap2

rap2.taobao.com

RAP2组内几乎也是一致差评,问题主要集中在:

  1. 项目内的接口分组只能有一级,不能继续往下细分(上图)

  2. 返回数据编辑及查看及其不友好(下图上半部分)

经过当前组内成员一致吐槽后,我们决定弃用

三、 某大佬一怒之下决定使用GitBook😡

“你把我仓库拉下来 install 一下” 一后端大佬对前端同事如是说,我扭头一看,“诶呦老哥,换GitBook啦”,“是的,那个啥RAP2太难用了,以后我们就用这个吧”

“不错不错” 我感叹了两句,写MD文档习惯后,我还是挺愿意各类文档全用MD的。

“不过为啥不用Wiki,不启动GitBook的服务就可以在线看” 我问到,

“WiKi?哪里” 大佬有点疑惑,我打开公司的GitLab,点开一个仓库的WiKi:“诺,new page 写MD就好”

“把GitBook的内容直接推到我仓库的WiKi里试试” 大佬催促我,‘“还有这种操作?”我有点疑惑

1
git remote set-url --add origin

我增加了一个Push地址,把GitBook的内容推了上去

诶呦,居然很契合!

将GitBook的SUMMARY.md 复制成 Home.md 稍微调整一下即可完美展示home页

日后对外发布也可以直接生成Html,文档与代码仓管绑定,真香!

前端及客户端同事也一致觉得不错不错,

就这样吧,以后我接触到的:

四、都上WiKi吧

CATALOG
  1. 1. 一、 首先使用了广受好评的PostMan
  2. 2. 二、 再使用rap2
  3. 3. 三、 某大佬一怒之下决定使用GitBook😡
  4. 4. 四、都上WiKi吧