程序员怎么写文档

1. 为什么程序员不愿写文档

其中的原因很多,我自己归纳了几点:1.怕烦程序员从入门之日起,就在心里埋藏了一颗编程的种子,认为程序员就是编程序的,就是和计算机打交道的,程序就是程序员的全部。

无论是在编程之前写文档,还是在编程之后写文档。他们都认为写文档很烦人。

1)文档种类太多。越正规越多。

一想到要写那么多的文档,程序员的头都要大了。2)文档写作要求不低。

有格式要求、内容要求,还需要画各种流程图、示意图、关系图、界面图和填写各种表格说明,以及要收集各种资料。虽然没有技术含量,但是要花的时间比编程序多,而且也不一定能写好。

3)在正规的开发公司中一般一个变更就要编写一系列的变更文档。当不断变更时,只有最后的变更文档是最重要的。

当我们不知道当前是不是最后一个文档时,我们就不愿意写可能被后面的文档替代的文档。4)当写了文档之后,就会不断有使用文档的人来询问细节,这些询问往往会让人崩溃。

这是因为很难写出让每个人都提不出问题的文档。2.没空在很多情况下,程序员都处于一种“时间紧、任务重”状态。

在急于得出编程结果的驱使下,程序员一心扑在编程上,恨不得一分钟一个变化,哪有心思和时间先把文档写好再去编程呢?即使他们拥有先把程序编出来,然后再补写文档的想法,但是一旦他们完成一段程序之后,就会立即扑向第二段程序。如此下来,编写文档只能放在项目开发的后期了。

你要是真的写文档,那写文档的时间早已将编程时间给挤占了,你的编程工作就完不成了。3.没有用文档的重要性其实对不同对象是不一样的。

如果你说文档没有用,立即会有人用唾沫把你淹死,他们立即会搬出哪个哪个说文档是重要的,文档是不可缺的。唯独不敢说“我自己认为文档是重要的”。

这也反过来说明文档的有用性程度对不同人是不一样的。对于程序员来说,只要能把程序编出来就行了。

很多程序员不写文档照样编出程序来,在他们的观念中文档不写也罢。如果按文档编程序,那就要确保文档的正确性、不可更改性。

而实际上,文档不如编程快,编程不如变化快,不断变化的需求和代码让文档如同一张过时的废纸一样。在现实中,有的文档变成了项目开发后的总结,对开发本身并不起作用,只是保留一个存在的形式,以应付各种各样规范的需要。

在这种情况下,文档没有任何实用价值,所以即使程序员写了,也没有什么作用。尤其是项目投产后,几经升级,最初的文档早已和现实的情况对不上号了,文档更新和系统的一致性更是难于控制。

4.没好处既然认为编程序才是正道,那么程序员写文档就是一种额外和辅助的工作,做了就做了,对于程序员来说没有任何好处。当然,文档的好处更多地体现在软件公司、单位、软件用户、后续程序员身上,它是一种“前人栽树,后人乘凉”的好事。

所以程序员不愿意写文档。文档有多么重要呢?有人把它上升到“程序员头脑的拷贝”的高度,有的人甚至说,程序员走了后,只要有了文档,软件公司可以再招新人,公司照样运转起来。

如此说来,天性聪明的程序员会把文档写得清清楚楚吗?5.不会写从写作本身来看,写好一篇文档不是一件容易的事。文档有文档的格式和写作要求。

现在的人只喜欢动嘴说事,没有多少人在平时会动笔写字,更不用说写文章了。所以,写文档从理论上来说也是需要学习和训练的,需要在平时进行写作积累。

当要求一些程序员写文档的时候,他往往会回答你:“怎么写呀?我不会。”你不会写可以不怪你,你不去学,反而理直气壮地说不会,则是你的不对了。

难道那些会写文档的人都是“呆子”吗?难道他们不懂干活辛苦的道理吗?当一个男子向一个自己喜欢的女子示爱,需要用情书来表白的时候,难道他不会写情书吗?即使他不会写,他也一定会克服千难万险把情书写出来的,这是他的主观使然。如果程序员主观上想写文档,怎么会怕烦?怎么会怕没空?怎么会怕文档没有用?怎么会怕不会写?这些怕其实都是借口。

真正优秀的程序员应该不单是编程的高手,同时也应该是写文档的高手。程序员真正不喜欢写文档的原因是:文档是给别人看的,不是给自己看的。

如果要使程序员喜欢写文档,那就要提高程序员的意识和境界,或者要给写文档的程序员以奖励。而靠制度、管理让程序员去写文档只能是一种职业上的弊端。

当有一天写文档也成为一个专业化的岗位,程序员和文档人员分开时,程序员就会一心一意看文档写代码,文档员就会以此为职业,一心一意写文档拿工资。我们将不再为此进行讨论。

这种分工一定是未来的趋势。一些大的公司或管理规范的公司都已经有这样的分工了。

只是很多中小软件公司或企事业单位里的IT部门还没有专业化到如此程度。程序员不喜欢写文档也许说明他们不愿意承担太多的角色吧。

不管怎么说,作为一个程序员(尤其想成为优秀程序员)一定要学会写文档,一定要学会欣赏文档。无论你是否喜欢,你都应该可以在文档的各种问题面前可进可退。

可以这样说,那些既不会写文档,又不会欣赏文档的程序员是没有资格说“我就不喜欢写文档”这种话的。

2. java程序员需要些什么文档

我很少写文档,懒得写,除非项目有要求

对于文档这个东西简单谈一下

1. 做项目之前就有文档

这个是可遇不可求的,现在做的项目很多都是临时突然说要做的,什么需求都没有,只能靠程序员自己去发现,项目经理的要求,客户的临时需求(这个比较痛苦,他们有时候根本就不知道要什么,所以必须写好文档,跟客户谈好,不然又要变的时候,你就痛苦了)

如果项目一开始就有文档,当然也可能是你自己写的,也可能是其他人写好的,有些公司有人专门负责写,需求分档,项目分析文档,项目结构文档,数据库文档等等,不过之后可能需要你写测试文档,这个就没有听说过谁帮你做了,但是更多的情况也是不用写,就几个功能,自己和测试人员测测就算了,也有可能需要写使用文档,这个看情况了

2. 做项目之前没有文档

如果项目紧张,根本就不会写任何文档,但是当项目结束的时候,你又没有项目做,项目精灵可能就让你写写文档打发打发时间,

文档对于公司来说是很重要的,但是对于个人的话,就要看情况,如果你做了很多项目,其实什么文档也不需要,你大体上都知道这个项目就做什么用的,怎么架构的,那些代码是什么意思(你的编程习惯很好的情况下),所以很多公司都会要求程序员写文档,不然你走的时候,别的人怎么接受,让别人理解你的思想是很痛苦的,每个人的思想都是不一样的

3. java面试官问有没有写过文档(面试java程序员),我想知道写文档是

我想他的文档是指在项目开发过程中 不同阶段的文档

我们项目组开发基本是基于瀑布模型开发 每个阶段都会输出文档指导后续工作开展

一般se下发需求后 由我们出 详细需求设计文档

代码开发完成了 转测试时我们会写 数据库设计文档 ,操作手册 (这个也算)

还有就是 版本升级说明书 版本功能清单 软件介绍

这个是大概的文档 还有其他的。文档编写时间 主要是代码开发前 与 转测试后

4. 我是个编程的自学者,想当程序员不知道公司写文档是什么意思知道

以鄙人在软件公司工作的经验与你分享一下吧。

我们平时做项目,一般有一半以上时间都在管理文档,包括基本设计书,详细设计书,静态样式书,各种UML建模图,单体测试书,系统测试数,结合测试书,DB设计书,DB脚本,以及各种工具类管理文档,如资源文件管理,VBA管理等等,这还不包括项目前期的需求建设书,项目中期与客户交流的反馈书,项目后期的BUG管理书,以及贯穿项目的工程进度表和版本控制书。当然你的代码资源(包括注释,图片,脚本等)也属于文档,需要统一管理。

对于追求简短快的团队,未必会太重视文档的组织与管理,但是一定要相信文档看似浪费时间,其实无形中提高了很大的效率,而且在未来的开发提供了宝贵的参考资料。属于团队积累的一种。

5. java程序员需要些什么文档

我很少写文档,懒得写,除非项目有要求 对于文档这个东西简单谈一下 做项目之前就有文档 这个是可遇不可求的,现在做的项目很多都是临时突然说要做的,什么需求都没有,只能靠程序员自己去发现,项目经理的要求,客户的临时需求(这个比较痛苦,他们有时候根本就不知道要什么,所以必须写好文档,跟客户谈好,不然又要变的时候,你就痛苦了) 如果项目一开始就有文档,当然也可能是你自己写的,也可能是其他人写好的,有些公司有人专门负责写,需求分档,项目分析文档,项目结构文档,数据库文档等等,不过之后可能需要你写测试文档,这个就没有听说过谁帮你做了,但是更多的情况也是不用写,就几个功能,自己和测试人员测测就算了,也有可能需要写使用文档,这个看情况了做项目之前没有文档 如果项目紧张,根本就不会写任何文档,但是当项目结束的时候,你又没有项目做,项目精灵可能就让你写写文档打发打发时间,文档对于公司来说是很重要的,但是对于个人的话,就要看情况,如果你做了很多项目,其实什么文档也不需要,你大体上都知道这个项目就做什么用的,怎么架构的,那些代码是什么意思(你的编程习惯很好的情况下),所以很多公司都会要求程序员写文档,不然你走的时候,别的人怎么接受,让别人理解你的思想是很痛苦的,每个人的思想都是不一样的。

程序员怎么写文档

转载请注明出处育才学习网 » 程序员怎么写文档

知识

视在田字格怎么写

阅读(179)

本文主要为您介绍视在田字格怎么写,内容包括种字的田字格怎么写,幕在田字格中怎么写,中字在田字格怎么写。

知识

99的序数词怎么写

阅读(200)

本文主要为您介绍99的序数词怎么写,内容包括199的英语序数词怎么写,1至99序数词怎么写啊谢谢~·,第一到第九十九的英语单词怎么写序数词。序数词:第1 first 第2 second 第3 third 第4 fourth 第5 fifth 第6 sixth 第7 seven

知识

推广短信怎么写

阅读(165)

本文主要为您介绍推广短信怎么写,内容包括如何写推广短信,如何写推广短信,营销短信怎样写效果才会更好。那要看什么类型的了 首先要选要切入点,即如何把需要宣传的产品、服务或品牌等信息完美的嵌入文章内容,好的切入点能让整篇软文看起来浑

知识

草书坤怎么写

阅读(253)

本文主要为您介绍草书坤怎么写,内容包括厚德载物草书怎么写,哪位大佬写个草书的天行健君子以自强不息,地势坤君子,王金坤草书怎么写。厚德载物草书写法如下:

知识

更篆书怎么写

阅读(211)

本文主要为您介绍更篆书怎么写,内容包括更字篆体怎么写,更字篆书写法,请回答,求答案,明天会更好的篆书怎么写。篆书是大篆、小篆的统称。笔法瘦劲挺拔,直线较多。起笔有方笔、圆笔,也有尖笔,手笔“悬针”较多。篆书是最早的一种书体,其笔法比其

知识

家字连笔怎么写

阅读(690)

本文主要为您介绍家字连笔怎么写,内容包括家字连笔怎么写,家字连笔怎么写,家和字连笔怎么写帮帮忙急。家

知识

农历2016怎么写

阅读(223)

本文主要为您介绍农历2016怎么写,内容包括2016年1月1日在农历怎么写,农历2016年l月27日日记怎么写,农历2016年l月27日日记怎么写。农历2016年l月27日 紧跟着后面写上星期几,最后写天气情况写完日期后开始写正文。正文第一行可以顶头写,也可以

知识

企的繁体字怎么写

阅读(162)

本文主要为您介绍企的繁体字怎么写,内容包括企的繁体字怎么写,企繁体字怎么写,企龙的繁体字怎么写。

知识

变更资料怎么写

阅读(176)

本文主要为您介绍变更资料怎么写,内容包括变更姓名申请书咋写,你的变更申请都需要写什么资料啊我也要做变更申请,增值税资料变更书怎么写。公民有正当理由要求变更姓名的,可向常住户口所在地派出所提出申请。依法被剥夺政治权利的分子和受刑

知识

韩语没关系怎么写

阅读(237)

本文主要为您介绍韩语没关系怎么写,内容包括韩文没关系怎么说,没关系用韩语怎么写,韩语中没关系用韩语怎么写。“没关系”译成韩语为:“괜찮아요”、“괜찮아”、“괜찮다”或者“괜찮습니다”。“괜찮아요”表示:【常用句】没事儿。/ 别客气

知识

出纳工作总结怎么写

阅读(172)

本文主要为您介绍出纳工作总结怎么写,内容包括出纳工作总结,出纳每月工作总结(200字内),出纳年终工作总结怎么写。哈哈,我也是个出纳,我可以帮帮你,我才刚刚写好年终总结 2009年年终总结 时间如梭,转眼间又将跨过一个年度,,在2009年中,在领导及

知识

活动主持词怎么写

阅读(204)

本文主要为您介绍活动主持词怎么写,内容包括主持词怎么写,串词怎么写,主持词,开场白结束语。主持人开场白主持人的开场一定要和活动的主题相契合,精彩的文案只有扣住主题思想才能发挥出最大的魅力所在。例如,您的主题是跨越,是征服,是挑

知识

石家庄地址怎么写

阅读(169)

本文主要为您介绍石家庄地址怎么写,内容包括快递地址怎么填写比如石家庄到浙江,写信到石家庄职业学院怎么写地址以及邮编啊,石家庄市新华区赵二街小区地址怎么写邮编是多少。河北市县名称所属地区邮政编码石家庄市石家庄050000辛集市石家庄

知识

可字行书怎么写

阅读(193)

本文主要为您介绍可字行书怎么写,内容包括可和贵的行书怎么写,能的行书怎么写,"休"字的行书写法、笔顺。可的行书写法:

知识

软件开发的文档怎么写

阅读(186)

本文主要为您介绍软件开发的文档怎么写,内容包括软件开发文档应该如何写,软件开发的技术实现文档要怎么写,怎么写项目开发的文档。模块开发卷宗(GB856788)1标题软件系统名称和标识符模块名称和标识符(如果本卷宗包含多于一个的模块,则用这组模

知识

文档怎么写拼音

阅读(170)

本文主要为您介绍文档怎么写拼音,内容包括怎样在office文档里写拼音,如何在word中写拼音,word中如何输入拼音。在word中写拼音,可以通过下面的操作步骤: 打开word文档,在文档中编辑需要增加拼音的文字,并注意文字间的空格,如下图; 选定要增加

知识

写文档怎么换行

阅读(259)

本文主要为您介绍写文档怎么换行,内容包括word文档怎么换行,Word怎么分行,怎么设置WORD文档的段落自动换行。有两种方法。我喜欢用第一种方法;仅供参考!word自动换行解决方法: 选择格式段落中文版式,勾选“允许西文在单词中间换行”。 注意:这种

知识

在文档里分数怎么写

阅读(227)

本文主要为您介绍在文档里分数怎么写,内容包括在word文档里如何写出分数,如何在word文档中写分数,怎样在word文档里写分数。两种实现方法:一种是用 Word本身提供的的EQ域。这种方法容易操作,但对大量的分数输入来讲太费事。另一种是利用Enter

知识

用手机怎么写文档

阅读(183)

本文主要为您介绍用手机怎么写文档,内容包括在手机上怎么写文档,怎么在手机上填写文档,怎么用手机写word文档。在手机上写文档需先下载办公软件,具体操作如下:先下载wps office 的软件,如下图图标。这款软件下包含了word、Excel等操作

知识

怎么写产品文档

阅读(210)

本文主要为您介绍怎么写产品文档,内容包括如何才能写出好的产品文档,如何写好产品开发文档,手机软件测试产品文档怎么写。一般来说,产品文档分为产品需求文档和产品使用文档两种。产品需求文档主要面向的是产品的开发、设计者,期望是产品的实

知识

帮助文档怎么写

阅读(162)

本文主要为您介绍帮助文档怎么写,内容包括如何编写帮助文档,怎么写一个项目的帮助文档,如何写帮助文档。每个开发人员都知道改写原有的应用程序是一项多么艰苦的事情。对先前开发小组思维模式进行逆向工程是对开发人员技术水平的真正测试。

知识

api文档怎么写

阅读(193)

本文主要为您介绍api文档怎么写,内容包括如何编写API的文档,数据接口api规范文档怎么写,javaapi接口文档编写。Java语言提供了一种强大的注释形式:文档注释。可以将源代码里的文档注释提取成一份系统的API文档。我们在开发中定义类、方法时

[/e:loop]