程序员怎么写文档( 二 )


当要求一些程序员写文档的时候,他往往会回答你:“怎么写呀?我不会 。”你不会写可以不怪你,你不去学,反而理直气壮地说不会,则是你的不对了 。
难道那些会写文档的人都是“呆子”吗?难道他们不懂干活辛苦的道理吗?当一个男子向一个自己喜欢的女子示爱,需要用情书来表白的时候,难道他不会写情书吗?即使他不会写,他也一定会克服千难万险把情书写出来的,这是他的主观使然 。如果程序员主观上想写文档,怎么会怕烦?怎么会怕没空?怎么会怕文档没有用?怎么会怕不会写?这些怕其实都是借口 。
真正优秀的程序员应该不单是编程的高手,同时也应该是写文档的高手 。程序员真正不喜欢写文档的原因是:文档是给别人看的,不是给自己看的 。
如果要使程序员喜欢写文档,那就要提高程序员的意识和境界,或者要给写文档的程序员以奖励 。而靠制度、管理让程序员去写文档只能是一种职业上的弊端 。
当有一天写文档也成为一个专业化的岗位,程序员和文档人员分开时,程序员就会一心一意看文档写代码,文档员就会以此为职业,一心一意写文档拿工资 。我们将不再为此进行讨论 。
这种分工一定是未来的趋势 。一些大的公司或管理规范的公司都已经有这样的分工了 。
只是很多中小软件公司或企事业单位里的IT部门还没有专业化到如此程度 。程序员不喜欢写文档也许说明他们不愿意承担太多的角色吧 。
不管怎么说,作为一个程序员(尤其想成为优秀程序员)一定要学会写文档,一定要学会欣赏文档 。无论你是否喜欢,你都应该可以在文档的各种问题面前可进可退 。
可以这样说,那些既不会写文档,又不会欣赏文档的程序员是没有资格说“我就不喜欢写文档”这种话的 。
2. java程序员需要些什么文档 我很少写文档,懒得写,除非项目有要求
对于文档这个东西简单谈一下
1. 做项目之前就有文档
这个是可遇不可求的,现在做的项目很多都是临时突然说要做的,什么需求都没有,只能靠程序员自己去发现,项目经理的要求,客户的临时需求(这个比较痛苦,他们有时候根本就不知道要什么,所以必须写好文档,跟客户谈好,不然又要变的时候,你就痛苦了)
如果项目一开始就有文档,当然也可能是你自己写的,也可能是其他人写好的,有些公司有人专门负责写,需求分档,项目分析文档,项目结构文档,数据库文档等等,不过之后可能需要你写测试文档,这个就没有听说过谁帮你做了,但是更多的情况也是不用写,就几个功能,自己和测试人员测测就算了,也有可能需要写使用文档,这个看情况了
2. 做项目之前没有文档
如果项目紧张,根本就不会写任何文档,但是当项目结束的时候,你又没有项目做,项目精灵可能就让你写写文档打发打发时间,
文档对于公司来说是很重要的,但是对于个人的话,就要看情况,如果你做了很多项目,其实什么文档也不需要,你大体上都知道这个项目就做什么用的,怎么架构的,那些代码是什么意思(你的编程习惯很好的情况下),所以很多公司都会要求程序员写文档,不然你走的时候,别的人怎么接受,让别人理解你的思想是很痛苦的,每个人的思想都是不一样的
3. java面试官问有没有写过文档(面试java程序员),我想知道写文档是 我想他的文档是指在项目开发过程中 不同阶段的文档
我们项目组开发基本是基于瀑布模型开发 每个阶段都会输出文档指导后续工作开展
一般se下发需求后 由我们出 详细需求设计文档