首页 > 如何写好交接文档

如何写好交接文档

最近准备辞职,但是交接文档总是感觉写的不好不够详细,想问问怎么才能写好一个交接文档


没客观标准。谁接手让谁看。

我们重来不弄这个。接收的,移交的,两人一起做两周的结对编程,什么代码也都搞定。多年的复杂代码,2周接下来。当然两人都是高手,我这里也没低手。低手进不来,进来也待不下来。

很多时候,看起来是文档的问题,其实根本不是。你遇到的这个问题,是新手接代码,真正的问题是新手的业务和技术实力不够,而不一定是你的文档写的不好。

说的远点:我多年前带队伍,常常听到程序员说文档不足,其实不过是多个具体问题卡壳,有不愿意正对问题去解决,缺乏提炼问题的能力,以至于只能说,文档不足。何况内部的代码就那么几个人用(反正是内部用,怎么也比不上OS,常用系统软件的),写文档干么。写了文档的人,会被点赞吗。代码就在那里。看啊,有问题就提啊。数据库的字段不懂,就问啊。代码逻辑混乱,写单元测试啊,重构啊,蚂蚁同大象改变现状;也有确实重构成本高的,痛下决心,重写一遍。

我的观点是比较极端的:说文档不足的,和现在动不动就说“没有音乐细胞”,“缺乏路联网基因”类似,是含糊的提法。是确实技术思维的人说出来的话。

确实要写的话,方法比较多,也需要一个修炼的过程,光是UML,Use case 一套东西,都很多人喝几年的。文档也没有编译器,没有机器帮你把关的。

说以,大部分问题,可以通过代码解决,即使业务代码本身不清,也可以先考虑单元测试,因为这些也是代码,并且和代码一起走。文档一定会过期的。能不写就不写。


找个小白看你写的文档,问问能看懂不,能看懂就OK。

【热门文章】
【热门文章】