程序员怎么写文档

1. 为什么程序员不愿写文档 其中的原因很多,我自己归纳了几点:1.怕烦程序员从入门之日起,就在心里埋藏了一颗编程的种子,认为程序员就是编程序的,就是和计算机打交道的,程序就是程序员的全部 。
无论是在编程之前写文档,还是在编程之后写文档 。他们都认为写文档很烦人 。
1)文档种类太多 。越正规越多 。
一想到要写那么多的文档,程序员的头都要大了 。2)文档写作要求不低 。
有格式要求、内容要求,还需要画各种流程图、示意图、关系图、界面图和填写各种表格说明,以及要收集各种资料 。虽然没有技术含量,但是要花的时间比编程序多,而且也不一定能写好 。
3)在正规的开发公司中一般一个变更就要编写一系列的变更文档 。当不断变更时,只有最后的变更文档是最重要的 。
当我们不知道当前是不是最后一个文档时,我们就不愿意写可能被后面的文档替代的文档 。4)当写了文档之后,就会不断有使用文档的人来询问细节,这些询问往往会让人崩溃 。
这是因为很难写出让每个人都提不出问题的文档 。2.没空在很多情况下,程序员都处于一种“时间紧、任务重”状态 。
在急于得出编程结果的驱使下,程序员一心扑在编程上,恨不得一分钟一个变化,哪有心思和时间先把文档写好再去编程呢?即使他们拥有先把程序编出来,然后再补写文档的想法,但是一旦他们完成一段程序之后,就会立即扑向第二段程序 。如此下来,编写文档只能放在项目开发的后期了 。
你要是真的写文档,那写文档的时间早已将编程时间给挤占了,你的编程工作就完不成了 。3.没有用文档的重要性其实对不同对象是不一样的 。
如果你说文档没有用,立即会有人用唾沫把你淹死,他们立即会搬出哪个哪个说文档是重要的,文档是不可缺的 。唯独不敢说“我自己认为文档是重要的” 。
这也反过来说明文档的有用性程度对不同人是不一样的 。对于程序员来说,只要能把程序编出来就行了 。
很多程序员不写文档照样编出程序来,在他们的观念中文档不写也罢 。如果按文档编程序,那就要确保文档的正确性、不可更改性 。
而实际上,文档不如编程快,编程不如变化快,不断变化的需求和代码让文档如同一张过时的废纸一样 。在现实中,有的文档变成了项目开发后的总结,对开发本身并不起作用,只是保留一个存在的形式,以应付各种各样规范的需要 。
在这种情况下,文档没有任何实用价值,所以即使程序员写了,也没有什么作用 。尤其是项目投产后,几经升级,最初的文档早已和现实的情况对不上号了,文档更新和系统的一致性更是难于控制 。
4.没好处既然认为编程序才是正道,那么程序员写文档就是一种额外和辅助的工作,做了就做了,对于程序员来说没有任何好处 。当然,文档的好处更多地体现在软件公司、单位、软件用户、后续程序员身上,它是一种“前人栽树,后人乘凉”的好事 。
所以程序员不愿意写文档 。文档有多么重要呢?有人把它上升到“程序员头脑的拷贝”的高度,有的人甚至说,程序员走了后,只要有了文档,软件公司可以再招新人,公司照样运转起来 。
如此说来,天性聪明的程序员会把文档写得清清楚楚吗?5.不会写从写作本身来看,写好一篇文档不是一件容易的事 。文档有文档的格式和写作要求 。
现在的人只喜欢动嘴说事,没有多少人在平时会动笔写字,更不用说写文章了 。所以,写文档从理论上来说也是需要学习和训练的,需要在平时进行写作积累 。