跳到正文
关注 Tooo

新代码一合入,文档自己长出来

从代码仓库里读懂新接口,一口气写出 README 和接口文档的草稿。不动代码,交出来的文档等你点头再放进去。

它会这样来找你
文档补齐消息示例
Hey,上次合入的 2 个新接口我补好文档了,草稿在语雀,今晚看一眼?
关注 Tooo 看它怎么管

运营文档补齐连着Gitee、GitHub

它怎么管这件事

交给它以后,它照这些去办。你随时能改:跟它说一句,它就记住。

先连上

交给它时,说这一句

“仓库的文档交给你写:每次新合入的代码有公开接口,你就从代码里把用法读出来,写成 README 和接口文档。写完了放在语雀上,我说可以了再往仓库里交。”

你只要给它这些

  • Gitee 或 GitHub 上仓库里的代码和最近的合并记录。
  • 代码里的注释和接口定义,它自己去看。

你会收到这些

  • 一版 README 和接口文档的草稿,放在语雀文档里。
  • 标出新文档跟旧文档接起来的地方,方便你检查。

它的做法

  • 从代码里读参数、返回值、报错信息,写成人能看懂的说明。
  • 新文档的格式跟仓库里原来的风格保持一致。
  • 接口没写注释的,照代码行为如实描述,不瞎猜。

什么时候来,什么时候不出声

  • 每次有新接口合入主干,第二天早上交草稿。
  • 没有新接口合入的日子,不出声。

这些事,它先问你

  • 往仓库里提交文档。
  • 删掉或大改已有的文档。
查看完整设定

Tooo Bot · 文档补齐

一句介绍
从代码仓库里读懂新接口,一口气写出 README 和接口文档的草稿。不动代码,交出来的文档等你点头再放进去。

交给它时说的第一句话
仓库的文档交给你写:每次新合入的代码有公开接口,你就从代码里把用法读出来,写成 README 和接口文档。写完了放在语雀上,我说可以了再往仓库里交。

第一件事
把主干分支上还没写文档的新接口找出来,今天给我交出第一版接口说明。

要连的应用
Gitee、GitHub

要给它的
- Gitee 或 GitHub 上仓库里的代码和最近的合并记录。
- 代码里的注释和接口定义,它自己去看。

它交回来的
- 一版 README 和接口文档的草稿,放在语雀文档里。
- 标出新文档跟旧文档接起来的地方,方便你检查。

它的做法
- 从代码里读参数、返回值、报错信息,写成人能看懂的说明。
- 新文档的格式跟仓库里原来的风格保持一致。
- 接口没写注释的,照代码行为如实描述,不瞎猜。

什么时候来,什么时候不出声
- 每次有新接口合入主干,第二天早上交草稿。
- 没有新接口合入的日子,不出声。

这些事先问你
- 往仓库里提交文档。
- 删掉或大改已有的文档。

怎么用上

  1. HeyTooo 还没上线。在微信里搜 HeyTooo,关注公众号,上线那天它来找你;在哪能用上见下载页。
  2. 上线以后,跟 Tooo 说上面那一句,把里面的情况换成你自己的。
  3. 再给它第一件事,比如:“把主干分支上还没写文档的新接口找出来,今天给我交出第一版接口说明。”当天看它交回什么。

差不多的事

你可能想问

它管什么、什么时候来找你、现在能不能用,还有谁在做 HeyTooo。

“文档补齐”交给它,它具体管什么?

从代码仓库里读懂新接口,一口气写出 README 和接口文档的草稿。不动代码,交出来的文档等你点头再放进去。

它什么时候来找我?

照这件事自己的节奏:每次有新接口合入主干,第二天早上交草稿;没有新接口合入的日子,不出声。比如:“Hey,上次合入的 2 个新接口我补好文档了,草稿在语雀,今晚看一眼?”

哪些事它会先问我?

往仓库里提交文档;删掉或大改已有的文档。花钱、发出去、删掉这类收不回的事,它都先停下来问你。

现在能用吗?

还不能。HeyTooo 还没上线;这一个是照大家分享的用法、用我们自己的话写的,我们还没用熟。在微信里搜 HeyTooo 关注公众号,上线那天它来找你。

它的做法能改吗?

能。跟它说一句就行,比如“以后一次别超过十分钟”。你纠正一次,它就记住,下回照新的做。