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

程序员到底需不需要写文档,第1张

您好:

需要写,而且需要好好写。

不论是前期的设计文档,开发文档。

还是后期的测试文档,实施文档,用户手册,FAQ。

这些文档是伴随着整个工作来的。。。

降低沟通成本,提高沟通效率。。。

不可以,你在公司工作期间,所有的工作包括打包好的项目完成后都必须上交,交接的事情不需要你 *** 心,但是你要把你的东西都留下,不能带走,这个规定的原因就是害怕泄露公司核心技术,为了不造成多种麻烦,你还是开源上交的好!

前端工程师,。

前端工程师,他们需要与UI对接,即负责网站建设中的整体格式,通过代码编辑网站,实现UI设计师给出的设计方案,随着用户体验的调整。

UI设计师主要负责在网站中设置界面设计,也就是我们看到的界面,采用一些画图工具和画板来保证其美观的风格和图案,让客户满意美观,好的UI设计不仅是让网站变得有个性有品位,还要让网站的 *** 作变得舒适简单、自由,充分体现软件的定位和特点。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2 IT文档工程师有什么要求

我就是文档工程师。就技术要求上说

1需要你对文字的表达能力,毕竟多是要你自己“写”文档,而且针对对象不同,表达的方式不同。写作技巧,文字细节等,需要揣摩。主要是简介明了,准确易懂,有针对,不罗嗦。

2需要你能比较熟练 *** 作MS 工具,主要是word,写文档主要靠这个,其次还有excel和PPT,较之word少。不是说非要精通,很多东西都是在实际工作中慢慢学来的。

3需要你对公司产品有个了解,比如产品系统架构,主要的工作流程,各个组件的功能和原理。由于写文档很直接跟这些相关,所以要尽快掌握。

4要不断自我学习。虽然文档工程师不像,研发和测试工程师那么累,但是也要不断学习。学习英语,因为可能需要翻译。学习IT行业的一些基本知识,买几本书,手头翻翻。学习产品相关的软件使用,比如Linux指令等。如果涉及程序代码的,就要学习那些编程语言了,不过也只是架构上的,不需要你看懂每一行语句。

差不多就这些了。任何职业都要有自己的能力和兴趣的融入,才能工作开心,生活开心。祝你好运

3 我是学it的(想在网上写小说怎么写

第一种是先把自己的文存在word文档里 在相应的贴吧发文

例如 言情小说 可以在言情小说吧里发文 不过这种一般都是写的好玩的

第二种是在小说网上

比较好的就是 小说阅读网 起点 晋江

如果是校园的小说的话 可以去聚星 不过聚星很卡

如果文笔比较淡 比较成熟的话 可以去花火

不过这种方法一般要通过审核才可以发表 第一种可以自己发表

第二种方式比较考文笔

如果ll不想审核的话 可以去贴吧发 不过吧友的回复也是一种审核吧

第二种如果文笔比较拖沓的话 就很容易功亏一篑了 可能写了一大堆 但通不过审核╮(╯▽╰)╭

但这两种都最好要把文文存在word文档里 虽然小说网一般可以作家存稿 但还是文档里保险一些

4 知名企业招聘网络工程师要求

网络工程师每个公司和任职要求不一样,一般分为初级、中级和高级,初级任职要求相对较低,任职要求一般为: 计算机及相关专业大专以上学历; 熟悉相关系统;熟悉网络协议,对网络有一定了解;具有一定的英语阅读能力和英语基础; 了解相关服务器。

中级和高级要求工作经验两年以上,任职要求也较高具备网络维护或相关工作经验,掌握各种网络环境搭建(LAN/WAN),具备较强的技术基础;掌握数据网络基础知识;具备较强的网络维护和故障处理能力,熟悉网络测试工具;熟悉网络安全、主机安全相关知识,能熟练配置主流的防火墙,等等,不过每个公司的职位要求还得视该公司具体职位要求为准。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

6 如何才能写出好的产品文档

一般来说,产品文档分为产品需求文档和产品使用文档两种。产品需求文档主要面向的是产品的开发、设计者,期望是产品的实际开发人员了解产品的细节,让开发完成的产品达到前期设计需求的预期;产品使用文档面向的主要是使用者,使其通过产品文档掌握产品的功能使用,也就是我们常说的产品使用帮助;如果不搞清楚文档面向的对象,往往写出来达不到预想的效果。类似这样专业的文档文案,其实是有一定共通性的;掌握这类文案的写作技巧,尤其对我们IT从业人员来说,是一项非常不错的技能。笔者从业这两年,跟此类文档打过不少交道,在这里跟各位分享一些经验。

1、对象要清楚

开篇就提到了,清楚文档面向的对象的重要性。对于不同的对象,必须使用不同的写作思路来对待,尽可能的站在对方的角度去思考。他需要看到什么?什么内容对他有用?我如何阐述给他?对于产品设计人员,他所需要了解的是产品的样式、界面、交互等情况,对于实际编码人员,他则偏重于产品的可实现性,你的内容则需要偏注产品的功能细节和内部处理。所以,文档面向的对象决定了文档的功能和内容。确定文档面向的对象才能做到有的放矢。

2、条理要清晰

文档的条理清晰不仅让你的文档看起来比较顺畅,更让阅读者能够很清楚的理解。所以,下笔之前就应当知道自己的文档内容大致分为哪几个大的模块、模块下又细分了多少个子模块,然后在大纲的基础上,再进行详细的内容填充。笔者之前的经验,往往在文档下笔之前认真思考了好几天,总希望在下笔之前就希望把所有的问题都想清楚。这对于写作者来说,是一件不好的举动。其实,东西在脑子里转悠,不如在纸上来的直观。大纲列出来之后,然后再来反复的添加、修改,比你按笔不动要来的有效率得多。对于写作来说,最难的也是开始。

3、逻辑要严谨

产品类的文档不同于平常我们书写的文档类型。对于内容叙述的严谨性要求非常严格。因为你的文档不单单是一个你对这个项目、产品的理解,它更是需要做为一个协作的载体让其他的同事同时使用,更可能成为其他同事工作方向的指引。因此,严谨是必须的。所以,在满足了文档条理清楚的前提下,仔细斟酌、思考文档可能会出现歧义、漏缺的部分,反复修改文档成为了一项必须的工作。在大家协调工作的背景下,你一个人不可能将所有的问题都考虑清楚。所以往往出现同事指出你文档中存在的毛病和漏洞。但是你还是应当在前期多做一些考虑,将问题尽量减少。

4、用词要专业

专业的用词不当可以帮助你提升文档的专业度,更可以帮助你提升效率,减少重复和不必要的沟通成本。既然是行业那就需要行业标准,使用专业的行业术语是一种职业化的表现,这样既可以很快和同事达成共识,又让别人觉得你很专业。我想,同事之前这样的协作才是有效率的。当然,对于新手来说,如何掌握专业的用词,这就需要平时多看多读了。多了解小众的博客,多认识一些前辈和朋友,无论是对写作还是对工作的认识,都是很有帮助的。

5、格式要规范

对于一个IT行业从业人员来讲,规范化、流程化的工作模式是非常重要的。对于需要经他人手的文档、或者需要进行存档的文档来说,格式的规范与否是一个衡量你专业化程度高低的重要衡量标准。当然,说到这个规范,你在第一次写作之前就应该了解这个规范是一个什么样的规范。是行业规范?还是公司内部的规范?这取决于你所在公司或所从事项目的情况。对于大公司,你所要做的就是找之前前辈们写过的同类文档进行拜读,了解这些规范。对于小公司或者新创的项目,之前没有过同类产品文档的情况。你所要做的就是沿用标准规范再加上项目特点,尽可能细致的书写。相信,经过你的努力的,你写的文档将会成为该类文档的案例,成为规范。

其实无论是产品需求文档(PRD)、产品策划书还是商业计划书,其实都是需要我们下功夫仔细研究的。毕竟中国互联网发展才十几年,很多细节都还不是很专业。对于一个会思考的互联网人,武装自己的头脑,丰富自己的技能才能找到更好的职业发展。

以上就是关于程序员到底需不需要写文档全部的内容,包括:程序员到底需不需要写文档、程序员离职封装核心代码后上交可以吗、UI做网页跟哪些程序员交接 - 百度等相关内容解答,如果想了解更多相关内容,可以关注我们,你们的支持是我们更新的动力!

欢迎分享,转载请注明来源:内存溢出

原文地址: http://outofmemory.cn/zz/9759478.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2023-05-01
下一篇 2023-05-01

发表评论

登录后才能评论

评论列表(0条)

保存