搜索
写经验 领红包
 > 知识

为什么要写开发文档(开发文档的作用)

导语:聊聊开发为啥要写文档/(ㄒoㄒ)/

为什么要写开发文档(开发文档的作用)

今天不想说别的,聊一聊开发文档,实在不想谈论这个话题。程序员最讨厌的两件事情,写文档和写注释。都是一些很繁琐的事情。那么我们聊一聊为啥要写文档。

在这之前我们要知道文档是用来做什么的,开发所用的的文档一般就是功能设计文档,这个文档中会写清楚这个软件开发过程中,涉及到的所有功能的实现,功能所涉及的数据量是什么样的,同意的变量名称 ,同意的方法,类及接口名称都是在内部规定好的。

一、是有助于在开发过程中的协作,因为开发是一个团队的工作,他不是一个人的事情,统一的文档可以减少很多不必要的交涉,例如调用接口时出错,后来发现在代码中定义的名称不同,导致无法调用等。

二、如果有新人加入团队了,可以通过文档快速的了解项目的构造和开发逻辑。(当然,具体实现还是要看代码中注释的)这样也可以减少很多的人工损耗,毕竟减少了交流就可以有更多的时间来做其他的东西。

其实说白了,写文档就是为了说明开发的思路及过程的,让一个外行人也能一目了然地看懂这个项目的构造和实现是最好的

(最后补一句,我不想写文档。。。/(ㄒoㄒ)/~~)

本文内容由小涵整理编辑!