导航:首页 > 程序命令 > 程序员写文档

程序员写文档

发布时间:2022-01-13 09:31:53

java面试官问有没有写过文档(面试java程序员),我想知道写文档是指什么,是设计文档还是需求文档还是其他

一般大点的公司需求文档还是不需要你去编写的,不过需要开发人员协同讨论与审批,
一般开发人员要写的是 概要设计文档,和详细设计文档之类的
至于步骤要看公司而定,有的是开发完成后才去补写这样的文档,有的是在开发前就需要
将文档写好,然后按照文档来开发。

㈡ 开发人员为什么不愿意写文档

有以下几点。
1.怕烦
程序员从入门之日起,就在心里埋藏了一颗编程的种子,认为程序员就是编程序的,就是和计算机打交道的,程序就是程序员的全部。无论是在编程之前写文档,还是在编程之后写文档。他们都认为写文档很烦人。
1)文档种类太多。越正规越多。一想到要写那么多的文档,程序员的头都要大了。
2)文档写作要求不低。有格式要求、内容要求,还需要画各种流程图、示意图、关系图、界面图和填写各种表格说明,以及要收集各种资料。虽然没有技术含量,但是要花的时间比编程序多,而且也不一定能写好。
3)在正规的开发公司中一般一个变更就要编写一系列的变更文档。当不断变更时,只有最后的变更文档是最重要的。当我们不知道当前是不是最后一个文档时,我们就不愿意写可能被后面的文档替代的文档。
4)当写了文档之后,就会不断有使用文档的人来询问细节,这些询问往往会让人崩溃。这是因为很难写出让每个人都提不出问题的文档。

2.没空
在很多情况下,程序员都处于一种“时间紧、任务重”状态。在急于得出编程结果的驱使下,程序员一心扑在编程上,恨不得一分钟一个变化,哪有心思和时间先把文档写好再去编程呢?即使他们拥有先把程序编出来,然后再补写文档的想法,但是一旦他们完成一段程序之后,就会立即扑向第二段程序。如此下来,编写文档只能放在项目开发的后期了。你要是真的写文档,那写文档的时间早已将编程时间给挤占了,你的编程工作就完不成了。

㈢ 有没有专门为程序员写文档的工作

兄弟,你若果真能有如此的悟性,足以成为一名出色的程序员!

㈣ 程序员的文档一般是怎样写的

www.csdn.net

㈤ java程序员需要些什么文档

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

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

  1. 做项目之前就有文档

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

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

  2. 做项目之前没有文档

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

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

㈥ Java程序员,你们在项目里写文档么

恩,要写,
这是你做项目前的预备工作啊~
你瞧我们在每学期最后做项目都要交的文档就有20来个包括软件系统分析,测试用例,系统设计报告等等一些。
一个文档就得发上那么2周的时间。
说老实话,如果一个项目没有做项目文档,那么那个软件将来出来一定会有很多的BAG。

㈦ 为什么程序员不愿写文档

其中的原因很多,我自己归纳了几点:

1.怕烦
程序员从入门之日起,就在心里埋藏了一颗编程的种子,认为程序员就是编程序的,就是和计算机打交道的,程序就是程序员的全部。无论是在编程之前写文档,还是在编程之后写文档。他们都认为写文档很烦人。
1)文档种类太多。越正规越多。一想到要写那么多的文档,程序员的头都要大了。
2)文档写作要求不低。有格式要求、内容要求,还需要画各种流程图、示意图、关系图、界面图和填写各种表格说明,以及要收集各种资料。虽然没有技术含量,但是要花的时间比编程序多,而且也不一定能写好。
3)在正规的开发公司中一般一个变更就要编写一系列的变更文档。当不断变更时,只有最后的变更文档是最重要的。当我们不知道当前是不是最后一个文档时,我们就不愿意写可能被后面的文档替代的文档。
4)当写了文档之后,就会不断有使用文档的人来询问细节,这些询问往往会让人崩溃。这是因为很难写出让每个人都提不出问题的文档。

2.没空
在很多情况下,程序员都处于一种“时间紧、任务重”状态。在急于得出编程结果的驱使下,程序员一心扑在编程上,恨不得一分钟一个变化,哪有心思和时间先把文档写好再去编程呢?即使他们拥有先把程序编出来,然后再补写文档的想法,但是一旦他们完成一段程序之后,就会立即扑向第二段程序。如此下来,编写文档只能放在项目开发的后期了。你要是真的写文档,那写文档的时间早已将编程时间给挤占了,你的编程工作就完不成了。

3.没有用
文档的重要性其实对不同对象是不一样的。如果你说文档没有用,立即会有人用唾沫把你淹死,他们立即会搬出哪个哪个说文档是重要的,文档是不可缺的。唯独不敢说“我自己认为文档是重要的”。这也反过来说明文档的有用性程度对不同人是不一样的。对于程序员来说,只要能把程序编出来就行了。很多程序员不写文档照样编出程序来,在他们的观念中文档不写也罢。如果按文档编程序,那就要确保文档的正确性、不可更改性。而实际上,文档不如编程快,编程不如变化快,不断变化的需求和代码让文档如同一张过时的废纸一样。
在现实中,有的文档变成了项目开发后的总结,对开发本身并不起作用,只是保留一个存在的形式,以应付各种各样规范的需要。在这种情况下,文档没有任何实用价值,所以即使程序员写了,也没有什么作用。尤其是项目投产后,几经升级,最初的文档早已和现实的情况对不上号了,文档更新和系统的一致性更是难于控制。

4.没好处
既然认为编程序才是正道,那么程序员写文档就是一种额外和辅助的工作,做了就做了,对于程序员来说没有任何好处。
当然,文档的好处更多地体现在软件公司、单位、软件用户、后续程序员身上,它是一种“前人栽树,后人乘凉”的好事。所以程序员不愿意写文档。
文档有多么重要呢?有人把它上升到“程序员头脑的拷贝”的高度,有的人甚至说,程序员走了后,只要有了文档,软件公司可以再招新人,公司照样运转起来。如此说来,天性聪明的程序员会把文档写得清清楚楚吗?

5.不会写
从写作本身来看,写好一篇文档不是一件容易的事。文档有文档的格式和写作要求。现在的人只喜欢动嘴说事,没有多少人在平时会动笔写字,更不用说写文章了。所以,写文档从理论上来说也是需要学习和训练的,需要在平时进行写作积累。当要求一些程序员写文档的时候,他往往会回答你:“怎么写呀?我不会。”你不会写可以不怪你,你不去学,反而理直气壮地说不会,则是你的不对了。难道那些会写文档的人都是“呆子”吗?难道他们不懂干活辛苦的道理吗?
当一个男子向一个自己喜欢的女子示爱,需要用情书来表白的时候,难道他不会写情书吗?即使他不会写,他也一定会克服千难万险把情书写出来的,这是他的主观使然。如果程序员主观上想写文档,怎么会怕烦?怎么会怕没空?怎么会怕文档没有用?怎么会怕不会写?这些怕其实都是借口。真正优秀的程序员应该不单是编程的高手,同时也应该是写文档的高手。
程序员真正不喜欢写文档的原因是:文档是给别人看的,不是给自己看的。如果要使程序员喜欢写文档,那就要提高程序员的意识和境界,或者要给写文档的程序员以奖励。而靠制度、管理让程序员去写文档只能是一种职业上的弊端。当有一天写文档也成为一个专业化的岗位,程序员和文档人员分开时,程序员就会一心一意看文档写代码,文档员就会以此为职业,一心一意写文档拿工资。我们将不再为此进行讨论。这种分工一定是未来的趋势。一些大的公司或管理规范的公司都已经有这样的分工了。只是很多中小软件公司或企事业单位里的IT部门还没有专业化到如此程度。程序员不喜欢写文档也许说明他们不愿意承担太多的角色吧。

不管怎么说,作为一个程序员(尤其想成为优秀程序员)一定要学会写文档,一定要学会欣赏文档。无论你是否喜欢,你都应该可以在文档的各种问题面前可进可退。可以这样说,那些既不会写文档,又不会欣赏文档的程序员是没有资格说“我就不喜欢写文档”这种话的。

㈧ 程序员到底需不需要写文档

您好:
需要写,而且需要好好写。
不论是前期的设计文档,开发文档。

还是后期的测试文档,实施文档,用户手册,FAQ。
这些文档是伴随着整个工作来的。。。
降低沟通成本,提高沟通效率。。。

㈨ 我是个编程的自学者,想当程序员不知道公司写文档是什么意思知道的情给我解释一下,还有具体是怎样工作的

以鄙人在软件公司工作的经验与你分享一下吧。
我们平时做项目,一般有一半以上时间都在管理文档,包括基本设计书,详细设计书,静态样式书,各种UML建模图,单体测试书,系统测试数,结合测试书,DB设计书,DB脚本,以及各种工具类管理文档,如资源文件管理,VBA管理等等,这还不包括项目前期的需求建设书,项目中期与客户交流的反馈书,项目后期的BUG管理书,以及贯穿项目的工程进度表和版本控制书。当然你的代码资源(包括注释,图片,脚本等)也属于文档,需要统一管理。
对于追求简短快的团队,未必会太重视文档的组织与管理,但是一定要相信文档看似浪费时间,其实无形中提高了很大的效率,而且在未来的开发提供了宝贵的参考资料。属于团队积累的一种。

阅读全文

与程序员写文档相关的资料

热点内容
华为防火墙cli命令手册 浏览:882
于正新剧玉楼春在什么App播放 浏览:127
学习社会经验下载什么app 浏览:475
php发布站程序 浏览:204
源码编译ntfs内核模块 浏览:120
r11s手机管家没有加密 浏览:781
怎么看电脑连接哪个服务器 浏览:191
二手服务器设备欺诈如何解决 浏览:877
单片机服务器安装win10 浏览:658
胸椎压缩性骨折伤残 浏览:954
mt怎么解压文件 浏览:41
达芬奇项目服务器有什么用 浏览:854
自制怎么捏都可以复原的解压球 浏览:615
qq软件管理怎么加密 浏览:740
手机使用代码编程器 浏览:939
单片机四位99秒表制作流程图 浏览:617
压缩包软件如何安装 浏览:767
我的世界服务器1122地址 浏览:7
苹果如何与安卓系统连接服务器 浏览:934
农业银行app学生缴费怎么切换 浏览:470