← 全部用户案例

产品与研发

交接文档:把没人敢动的代码讲透

用时
29 分钟 + 6 分钟
说了几句
2 句话
交出
交接文档,讲透 9 处代码

成品

Koa 代码交接手册 · 点开就能翻全屏打开 ↗

怎么做出来

交代的那一句(原话)

工作区里这个仓库(koa/ 目录)要交给新同事接手维护,里面有几处代码一直没人敢动。帮我把它读透,写一份交接文档:先画一张模块图,讲清各个文件怎么配合、一个请求从进来到响应出去经过哪些地方;再挑出最容易改出问题的几处代码,逐处讲它在干什么、为什么这么写、改的时候要注意什么(能用测试或提交记录佐证的就附上);最后列一份改动注意事项清单。交一份排好版的 HTML(handover/index.html),给新同事在浏览器里看,离线能直接打开、不用 CDN,代码片段标上文件和行号。仓库里的代码不要改。

  1. 把仓库放进工作区,发上面那一句

    把仓库放进工作区,发上面那一句
  2. 29 分钟后交回文档,全部测试都跑过

    29 分钟后交回文档,全部测试都跑过
  3. 再说一句:照格式补一节 fresh()

    再说一句:照格式补一节 fresh()
  4. 6 分钟后补好第 9 节

    6 分钟后补好第 9 节