程序员写文档不清晰_一个程序员要具备的基本素质是什么

1. 本人程序员刚进一家公司，半个月了，现在写代码写不出来怎么办

我没有做过程序员，但稍稍会点简单的（自学）。我感觉一个成熟的程序是系统工程，初接触者：无从下配厅败手个人感觉很正常!

经常在网站上看到公司骂老的离职程序员代码烂。我认为有二个原因：

1、培颤新入职的员工看不懂，自己不懂但骂骂别人，可以转嫁风险，让离职的背锅，为自己争取时间过渡或重建。

2、程序代码易读性太差，相关伏含说明文档缺失。虽然实现了功能，但别人接手太难（普遍情况）。新入职除了重建，要么深入读懂每个逻辑结构（比重建难，要跟着前一程序员思维走）。

以上二点你大概也清楚什么意思了。不知道你是维护老代码呢，还是新项目？

如果是维护老代码，多看文档、查资料、了解程序思维，反正有工资拿，也不急。

如果入职的是新项目，说明你技术还不成熟，那就加紧学呗。我个人预计：程序员这行，边学边卖的占总比90%

个人见识有限，错误难免，重在交流交流!

2. it写作文档

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）文档种类太多。越正规越多。

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

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

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

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

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

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

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

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

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

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

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

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

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

1、对象要清楚

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

2、条理要清晰

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

3、逻辑要严谨

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

4、用词要专业

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

5、格式要规范

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

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

3. 一个程序员要具备的基本素质是什么

团队精神和协作能力：
把它作为基本素质，并不是不重要，恰恰相反，这是程序员应该具备的最基本的，也是最重要的安身立命之本。
文档习惯：
作为代码程序员，30％的工作时间写技术文档是很正常的，而作为高级程序员和系统分析员，这个比例还要高很多。缺乏文档，一个软件系统就缺乏生命力，在未来的查错，升级以及模块的复用时就都会遇到极大的麻烦。
规范化，标准化的代码编写习惯：
作为一些外国知名软件公司的规矩，代码的变量命名，代码内注释格式，甚至嵌套中行缩进的长度和函数间的空行数字都有明确规定，良好的编写习惯，不但有助于代码的移植和纠错，也有助于不同技术人员之间的协作。
需求理解能力：
作为程序员需要评估该模块在系统运营中所处的环境，将要受到的负荷压力以及各种潜在的危险和恶意攻击的可能性。就这一点，一个成熟的程序员至少需要2到3年的项目研发和跟踪经验才有可能有心得。
复用性，模块化思维能力：
复用性设计，模块化思维就是要程序员在完成任何一个功能模块或函数的时候，要多想一些，不要局限在完成当前任务的简单思路上，想想看该模块是否可以脱离这个系统存在，是否可以通过简单的修改参数的方式在其他系统和应用环境下直接引用，这样就能极大避免重复性的开发工作。
测试习惯：
软件研发作为一项工程而言，一个很重要的特点就是问题发现的越早，解决的代价就越低，程序员在每段代码，每个子模块完成后进行认真的测试，就可以尽量将一些潜在的问题最早的发现和解决，这样对整体系统建设的效率和可靠性就有了最大的保证。
学习和总结的能力：
善于学习，对于任何职业而言，都是前进所必需的动力，对于程序员，这种要求就更加高了。但是学习也要找对目标，一些小coding fans们，他们也津津乐道于他们的学习能力，一会学会了asp，一会儿学会了php，一会儿学会了jsp，他们把这个作为炫耀的资本，盲目的追逐一些肤浅的，表面的东西和名词，做网络程序不懂通讯传输协议，做应用程序不懂中断向量处理，这样的技术人员，不管掌握了多少所谓的新语言，永远不会有质的提高。

4. 哎！做程序员一年了，感觉有的时候看不懂开发文档，感觉很枯燥老想着看视频入门我这种的是不是可以转行了

现在的你不是考虑转不转行的时候既然你已经坚持了一年那最起码基本的能力还是有的你夜深人静的时候好好想想吧任何行业起步都难难道你转行，头一年能乐得轻松自在嘛？编程工作第一年甚至第二年都是很西辛苦很痛苦的，哥们跟你说实话我也做了一年程序员今年干了别的行业才发现根本没我当初想的那么好也是从头开始和程序员头一年没差别所以我明年决定回到开发工作再干几年赚点资金再考虑搞别的

5. 程序员怎样规范编写接口文档

规范的事情当然要有专业的工具。推荐使用的是docway写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。

一些刚开始写接口文档的服务端同学，很容易按着代码的思路去编写接口文档，这让客户端同学或者是服务对接方技术人员经常吐槽，看不懂接口文档。这篇文章提供一个常规接口文档的编写方法，给大家参考。

一、请求参数

1. 请求方法

用于获取数据

POST

用于更新数据，可与PUT互换，语义上PUT支持幂等

用于新增数据，可与POST互换，语义上PUT支持幂等

DELETE

用于删除数据

其他

其他的请求方法在一般的接口中很少使用。如：PATCH HEAD OPTIONS

2. URL

url表示了接口的请求路径。路径中可以包含参数，称为地址参数，如**/user/{id}**，其中id作为一个参数。

3. HTTP Header

HTTP Header用于此次请求的基础信息，在接口文档中以K-V方式展示，其中Content-Type则是一个非常必要的header，它描述的请求体的数据类型。

常用的content-type：

application/x-www-form-urlencoded

请求参数使用“&”符号连接。

application/json

内容为json格式

application/xml

内容为xml格式

multipart/form-data

内容为多个数据组成，有分隔符隔开

4. HTTP Body

描述http body，依赖于body中具体的数据类型。如果body中的数据是对象类型。则需要描述对象中字段的名称、类型、长度、不能为空、默认值、说明。以表格的方式来表达最好。

示例：

五、接口工具

推荐使用的是http://docway.net（以前叫小幺鸡）写接口文档，方便保存和共享，支持导出PDF MARKDOWN，支持团队项目管理。

6. 作为程序员如何书写技术文档

按自己的喜好去写,没有具体的格式,不过要写名程序的用途,代码的函数使用方法,变量的意义等内容

7. C#初级程序员，怎么快速提高技能呢做技术牛人

1：团队精神和协作能力
把它作为基本素质，并不是不重要，恰恰相反，这是程序员应该具备的最基本的，也是最重要的安身立命之本。把高水平程序员说成独行侠的都是在呓语，任何个人的力量都是有限的，即便如linus这样的天才，也需要通过组成强大的团队来创造奇迹，那些遍布全球的为linux写核心的高手们，没有协作精神是不可想象的。独行侠可以作一些赚钱的小软件发点小财，但是一旦进入一些大系统的研发团队，进入商业化和产品化的开发任务，缺乏这种素质的人就完全不合格了。

2：文档习惯
说高水平程序员从来不写文档的肯定是乳臭未干的毛孩子，良好的文档是正规研发流程中非常重要的环节，作为代码程序员，30％的工作时间写技术文档是很正常的，而作为高级程序员和系统分析员，这个比例还要高很多。缺乏文档，一个软件系统就缺乏生命力，在未来的查错，升级以及模块的复用时就都会遇到极大的麻烦。

3：规范化，标准化的代码编写习惯
作为一些外国知名软件公司的规矩，代码的变量命名，代码内注释格式，甚至嵌套中行缩进的长度和函数间的空行数字都有明确规定，良好的编写习惯，不但有助于代码的移植和纠错，也有助于不同技术人员之间的协作。
有些coding fans叫嚣高水平程序员写的代码旁人从来看不懂，这种叫嚣只能证明他们自己压根不配自称程序员。代码具有良好的可读性，是程序员基本的素质需求。
再看看整个linux的搭建，没有规范化和标准化的代码习惯，全球的研发协作是绝对不可想象的。
4：需求理解能力
程序员需要理解一个模块的需求，很多小朋友写程序往往只关注一个功能需求，他们把性能指标全部归结到硬件，操作系统和开发环境上，而忽视了本身代码的性能考虑，有人曾经放言说写一个广告交换程序很简单，这种人从来不知道在百万甚至千万数量级的访问情况下的性能指标是如何实现的，对于这样的程序员，你给他深蓝那套系统，他也做不出太极链的并访能力。性能需求指标中，稳定性，并访支撑能力以及安全性都很重要，作为程序员需要评估该模块在系统运营中所处的环境，将要受到的负荷压力以及各种潜在的危险和恶意攻击的可能性。就这一点，一个成熟的程序员至少需要2到3年的项目研发和跟踪经验才有可能有心得。

5：复用性，模块化思维能力
经常可以听到一些程序员有这样的抱怨，写了几年程序，变成了熟练工，每天都是重复写一些没有任何新意的代码，这其实是中国软件人才最大浪费的地方，一些重复性工作变成了熟练程序员的主要工作，而这些，其实是完全可以避免的。
复用性设计，模块化思维就是要程序员在完成任何一个功能模块或函数的时候，要多想一些，不要局限在完成当前任务的简单思路上，想想看该模块是否可以脱离这个系统存在，是否可以通过简单的修改参数的方式在其他系统和应用环境下直接引用，这样就能极大避免重复性的开发工作，如果一个软件研发单位和工作组能够在每一次研发过程中都考虑到这些问题，那么程序员就不会在重复性的工作中耽误太多时间，就会有更多时间和精力投入到创新的代码工作中去。
一些好的程序模块代码，即便是70年代写成的，拿到现在放到一些系统里面作为功能模块都能适合的很好，而现在我看到的是，很多小公司软件一升级或改进就动辄全部代码重写，大部分重复性工作无谓的浪费了时间和精力。

6：测试习惯
作为一些商业化正规化的开发而言，专职的测试工程师是不可少的，但是并不是说有了专职的测试工程师程序员就可以不进行自测；软件研发作为一项工程而言，一个很重要的特点就是问题发现的越早，解决的代价就越低，程序员在每段代码，每个子模块完成后进行认真的测试，就可以尽量将一些潜在的问题最早的发现和解决，这样对整体系统建设的效率和可靠性就有了最大的保证。
测试工作实际上需要考虑两方面，一方面是正常调用的测试，也就是看程序是否能在正常调用下完成基本功能，这是最基本的测试职责，可惜在很多公司这成了唯一的测试任务，实际上还差的远那；第二方面就是异常调用的测试，比如高压力负荷下的稳定性测试，用户潜在的异常输入情况下的测试，整体系统局部故障情况下该模块受影响状况的测试，频发的异常请求阻塞资源时的模块稳定测试等等。当然并不是程序员要对自己的每段代码都需要进行这种完整测试，但是程序员必须清醒认识自己的代码任务在整体项目中的地位和各种性能需求，有针对性的进行相关测试并尽早发现和解决问题，当然这需要上面提到的需求理解能力。

7：学习和总结的能力
程序员是人才很容易被淘汰，很容易落伍的职业，因为一种技术可能仅仅在三两年内具有领先性，程序员如果想安身立命，就必须不断跟进新的技术，学习新的技能。
善于学习，对于任何职业而言，都是前进所必需的动力，对于程序员，这种要求就更加高了。但是学习也要找对目标，一些小coding fans们，他们也津津乐道于他们的学习能力，一会学会了asp，一会儿学会了php，一会儿学会了jsp，他们把这个作为炫耀的资本，盲目的追逐一些肤浅的，表面的东西和名词，做网络程序不懂通讯传输协议，做应用程序不懂中断向量处理，这样的技术人员，不管掌握了多少所谓的新语言，永远不会有质的提高。
善于总结，也是学习能力的一种体现，每次完成一个研发任务，完成一段代码，都应当有目的的跟踪该程序的应用状况和用户反馈，随时总结，找到自己的不足，这样逐步提高，一个程序员才可能成长起来。
一个不具备成长性的程序员，即便眼前看是个高手，建议也不要选用，因为他落伍的时候马上就到了。
具备以上全部素质的人，应当说是够格的程序员了，请注意以上的各种素质都不是由IQ决定的，也不是大学某些课本里可以学习到的，需要的仅仅是程序员对自己工作的认识，是一种意识上的问题。

那么作为高级程序员，以至于系统分析员，也就是对于一个程序项目的设计者而言，除了应该具备上述全部素质之外，还需要具备以下素质：

第一，需求分析能力
对于程序员而言，理解需求就可以完成合格的代码，但是对于研发项目的组织和管理者，他们不但要理解客户需求，更多时候还要自行制定一些需求，为什么这么说呢？
一般而言，进行研发任务，也许是客户提出需求，也许是市场和营销部门提出的需求，这时候对于研发部门，他们看到的不是一个完整的需求，通常而言，该需求仅仅是一些功能上的要求，或者更正规些，可能获得一个完整的用户视图；但是这都不够，因为客户由于非技术因素多一些，他们可能很难提出完整和清晰，或者说专业性的性能需求，但是对于项目组织者和规划者，他必须能够清醒认识到这些需求的存在并在完成需求分析报告的时候适当的提出，同时要完整和清晰的体现在设计说明书里面，以便于程序员编码时不会失去这些准则。
程序设计者必须正确理解用户需求所处的环境，并针对性做出需求的分析，举例而言，同样一个软件通过ASP租用方式发布和通过License方式发布，性能需求可能就是有区别的，前者强调的是更好的支撑能力和稳定性，而后者则可能更强调在各种平台下的普适性和安装使用的简捷性。

第二，项目设计方法和流程处理能力
程序设计者必须能够掌握不少于两到三种的项目设计方法（比如自顶至下的设计方法，比如快速原型法等等），并能够根据项目需求和资源搭配来选择合适的设计方法进行项目的整体设计。设计方法上选择不当，就会耽误研发周期，浪费研发资源，甚至影响研发效果。
一个程序设计者还需要把很多功夫用在流程图的设计和处理上，他需要做数据流图以确立数据词典；他需要加工逻辑流图以形成整体的系统处理流程。一个流程有问题的系统，就算代码多漂亮，每个模块多精致，也不会成为一个好的系统。当然，做好流程分析并选择好项目设计方法，都需要在需求分析能力上具有足够的把握。

第三，复用设计和模块化分解能力
这个似乎又是老调重谈，前面基本素质上不是已经说明了这个问题吗？
作为一个从事模块任务的程序员，他需要对他所面对的特定功能模块的复用性进行考虑，而作为一个系统分析人员，他要面对的问题复杂的多，需要对整体系统按照一种模块化的分析能力分解为很多可复用的功能模块和函数，并针对每一模块形成一个独立的设计需求。举个例子，好比是汽车生产，最早每辆汽车都是独立安装的，每个部件都是量身定做的，但是后来不一样了，机器化大生产了，一个汽车厂开始通过流水线来生产汽车，独立部件开始具有一定的复用性，在后来标准化成为大趋势，不同型号，品牌甚至不同厂商的汽车部件也可以进行方便的换装和升级，这时候，汽车生产的效率达到最大化。软件工程也是同样的道理，一个成熟的软件行业，在一些相关项目和系统中，不同的部件是可以随意换装的，比如微软的许多桌面软件，在很多操作模块（如打开文件，保存文件等等）都是复用的同一套功能模块，而这些接口又通过一些类库提供给了桌面应用程序开发者方便挂接，这就是复用化的模块设计明显的一个佐证。
将一个大型的，错综复杂的应用系统分解成一些相对独立的，具有高度复用性的，并能仅仅依靠几个参数完成数据联系的模块组合，是作为高级程序员和系统分析员一项最重要的工作，合适的项目设计方法，清晰的流程图，是实现这一目标的重要保证。

第四，整体项目评估能力
作为系统设计人员，必须能够从全局出发，对项目又整体的清醒认识，比如公司的资源配置是否合理和到位，比如工程进度安排是否能最大化体现效率又不至于无法按期完成。评估项目整体和各个模块的工作量，评估项目所需的资源，评估项目可能遇到的困难，都需要大量的经验积累，换言之，这是一种不断总结的累计才能达到的境界。在西方一些软件系统设计的带头人都是很年长的，比如4，50岁，甚至更老，他们在编码方面已经远远不如年轻人那样活络，但是就项目评估而言，他们几十年的经验积累就是最重要和宝贵的财富。中国缺这么一代程序员，主要还不是缺那种年纪的程序员，而是那种年纪的程序员基本上都是研究单位作出来的，都不是从专业的产品化软件研发作出来的，他们没有能积累那种产品化研发的经验，这也是没有办法的事情。
第五，团队组织管理能力
完成一个项目工程，需要团队的齐心协力，作为项目设计者或研发的主管人，就应当有能力最大化发挥团队的整体力量，技术管理由于其专业性质，不大同于一般的人事管理，因为这里面设计了一些技术性的指标和因素。
首先是工作的量化，没有量化就很难做到合适的绩效考核，而程序量化又不是简单的代码行数可以计算的，因此要求技术管理人员需要能真正评估一个模块的复杂性和工作量。
其次是对团队协作模式的调整，一般而言，程序开发的协作通常分为小组进行，小组有主程序员方式的，也有民主方式的，根据程序员之间的能力水平差距，以及根据项目研发的需求，选择合适的组队方式，并能将责权和成员的工作任务紧密结合，这样才能最大发挥组队的效率。
一个代码水平高的人，未必能成为一个合格的项目研发主管，这方面的能力欠缺往往是容易被忽视的。

综上可以看到，作为一个主管研发的负责人，一个项目设计者，所需要具备的素质和能力并不是程序代码编写的能力，当然一般情况下，一个程序员通过不断的总结提高达到了这种素质的时候，他所具有的代码编写能力也已经相当不简单了，但是请注意这里面的因果关系，一个高水平的项目设计者通常已经是代码编写相当优秀的人了，但是并不是一个代码相当优秀的程序员就可以胜任项目设计的工作，这里面存在的也不是智商和课本的问题，还是在于一个程序员在积累经验，逐步提升的时候没有意识到应当思考哪方面的东西，没有有意识的就项目的组织和复用设计进行揣摩，没有经常性的文档习惯和总结习惯，不改变这些，我们的合格的项目设计者还是非常欠缺。

另外，为防止有无聊的人和我较真，补充一点，本文针对目标是作商业化的软件项目和工程，那些科研机构的编程高手，比如算法高手，比如图象处理高手，他们的工作是研究课题而非直接完成商业软件（当然最终间接成为商业产品，比如微软研究院在作的研究课题），因此他们强调的素质可能是另外的东西，这些人（专家），并不能说是程序员，不能用程序员的标准去衡量。

最后补充一点东西，一个软件项目研发的设计流程是怎样的呢？以通常标准的设计方法为例，（不过笔者喜欢快速原型法）。

第一个步骤是市场调研，技术和市场要结合才能体现最大价值。

第二个步骤是需求分析，这个阶段需要出三样东西，用户视图，数据词典和用户操作手册。用户视图是该软件用户（包括终端用户和管理用户）所能看到的页面样式，这里面包含了很多操作方面的流程和条件。数据词典是指明数据逻辑关系并加以整理的东东，完成了数据词典，数据库的设计就完成了一半多。用户操作手册是指明了操作流程的说明书。请注意，用户操作流程和用户视图是由需求决定的，因此应该在软件设计之前完成，完成这些，就为程序研发提供了约束和准绳，很遗憾太多公司都不是这样做的，因果颠倒，顺序不分，开发工作和实际需求往往因此产生隔阂脱节的现象。
需求分析，除了以上工作，笔者以为作为项目设计者应当完整的做出项目的性能需求说明书，因为往往性能需求只有懂技术的人才可能理解，这就需要技术专家和需求方（客户或公司市场部门）能够有真正的沟通和了解。

第三个步骤是概要设计，将系统功能模块初步划分，并给出合理的研发流程和资源要求。作为快速原型设计方法，完成概要设计就可以进入编码阶段了，通常采用这种方法是因为涉及的研发任务属于新领域，技术主管人员一上来无法给出明确的详细设计说明书，但是并不是说详细设计说明书不重要，事实上快速原型法在完成原型代码后，根据评测结果和经验教训的总结，还要重新进行详细设计的步骤。
第四个步骤是详细设计，这是考验技术专家设计思维的重要关卡，详细设计说明书应当把具体的模块以最‘干净’的方式(黑箱结构）提供给编码者，使得系统整体模块化达到最大；一份好的详细设计说明书，可以使编码的复杂性减低到最低，实际上，严格的讲详细设计说明书应当把每个函数的每个参数的定义都精精细细的提供出来，从需求分析到概要设计到完成详细设计说明书，一个软件项目就应当说完成了一半了。换言之，一个大型软件系统在完成了一半的时候，其实还没有开始一行代码工作。那些把作软件的程序员简单理解为写代码的，就从根子上犯了错误了。

第五个步骤是编码，在规范化的研发流程中，编码工作在整个项目流程里最多不会超过1/2，通常在1/3的时间，所谓磨刀不误砍柴功，设计过程完成的好，编码效率就会极大提高，编码时不同模块之间的进度协调和协作是最需要小心的，也许一个小模块的问题就可能影响了整体进度，让很多程序员因此被迫停下工作等待，这种问题在很多研发过程中都出现过。编码时的相互沟通和应急的解决手段都是相当重要的，对于程序员而言，bug永远存在，你必须永远面对这个问题，大名鼎鼎的微软，可曾有连续三个月不发补丁的时候吗？从来没有！

第六个步骤是测试
测试有很多种：按照测试执行方，可以分为内部测试和外部测试；按照测试范围，可以分为模块测试和整体联调；按照测试条件，可以分为正常操作情况测试和异常情况测试；按照测试的输入范围，可以分为全覆盖测试和抽样测试。以上都很好理解，不再解释。
总之，测试同样是项目研发中一个相当重要的步骤，对于一个大型软件，3个月到1年的外部测试都是正常的，因为永远都会又不可预料的问题存在。
完成测试后，完成验收并完成最后的一些帮助文档，整体项目才算告一段落，当然日后少不了升级，修补等等工作，只要不是想通过一锤子买卖骗钱，就要不停的跟踪软件的运营状况并持续修补升级，知道这个软件被彻底淘汰为止。

写这些步骤算不上卖弄什么，因为实话讲我手边是一本《软件工程》，在大学里这是计算机专业的必修课程，但是我知道很多程序员似乎从来都只是热衷于什么《30天精通VC》之类的，他们有些和我一样游击队出身，没有正规学过这个专业，还有一些则早就在混够学分后就把这些真正有用的东西还给了老师。

网上现在也很浮躁，一些coding fans乱嚷嚷，混淆视听，实际上真正的技术专家很少在网上乱发帖子的，如笔者这样不知天高地厚的，其实实在是算不上什么高手，只不过看不惯这种对技术，对程序员的误解和胡说，只好挺身而出，做拨乱反正之言，也希望那些还沉迷于一些错误人士的coding fans们能认真想想，走到正途上，毕竟那些聪明的头脑还远远没有发挥应有的价值。

8. 程序员在上班时，允不允许大量的看说明文档来帮助写程序

程序员日常开发工作，基本是上离不开阅读文档，这也是很多程序员喜欢两个显示器的原因。

项目方面

技术方面
是不是很多人都认为，如果在开发过程中，还要不断地翻技术文档，说明他的开发能力不扎实。其实不是这样的。

首先IT行业技术升级换代的速度太快，当我们大多数公司还在用Java8的时候，Java11都已经出来了。如果非得要程序员熟知每一个类、每一个方法，是很不现实的。

很多时候我们只需要了解有这么一个东西，作用是干什么的，具体的细节可以在用的时候再去翻文档，比如方法名字是什么？参数有几个，都是什么类型的？

所以我们都习惯至少两个电脑屏幕，一个屏幕写代码，一个屏幕看文档；如果豪一些的话，再加一个屏幕展示日志信息。

看文档的屏幕要买竖屏！

我们团队
我这几年也带过几个团队，对于每个团队成员，我对他们的要求是：实现需求的前提下，最好能对所用的技术有一定的了解，千万不要从网上抄过来一段代码就用，这样是很危险的行为。所以鼓励大家多找一些资料，最好是阅读框架的官方文档。

现在的团队，我已经这样要求了：代码写累了，或者觉得自己没有状态写代码，可以找点儿自己有兴趣的技术文档学习学习，这个技术甚至是可以跟现在的项目没有关系的。

首先，我不是程序员，我是一个设计工作者，不过我来说一下我的观点：很多人以为程序员像电影里的一样，啪啪啪几下键盘，屏幕数据飕飕的变，其实真实情况是程序员写代码就像学生写作文，也会遇到不会的词语跟修辞手法，那这个时候就要停下来想一想，查一查，看看例子是怎样写的怎样用的，写错了还要划掉（删掉）再来，至于这个大量不大量看的情况，如果这个是个新手，那肯定是可以的，那如果是个老手，还需要大量时间查说明文档，那就说明这个项目肯定不会小，不是一两天能做完的，那一个用月做单位的项目，用一个天做单位的时间来查文档，不过分吧！程序员也是人，不是因为他的工作高端，就觉得这个人万能，他也会当机，要吃饭，要休息，也会忘记一些东西，所以请各位多多体谅，能一起工作实属不易，感恩2018，谢谢。

这个问题怎么说呢，开发过程中会遇到各种各样的问题，没有一个人是全能的，也没有人可以绝对的说自己在整个项目中不会遇到一点问题，不去查东西，自己大脑里的东西完全可以让我把这个项目测测底底的做完，并且没有任何bug。

上班的时间，也没有老板或者谁在后面一直看着你去做东西，大家都挺忙。文档是干嘛的，文档本身就是用来看的，甚至很多项目开始之前，总监都会让你去搜集一些这个项目可能会遇到的bug，可能会用到的效果，尽量在之前找到比较好用的插件，这样会节省很多时间，自己如果写代码的话不可能百分百的确定没有人和bug，但插件不一样很多插件都是前辈通过很长时间慢慢完善出来的插件，所以很多人才会用。所以你提问的可以肯定的回答你允许。

说个我遇到的2个真事吧，

第一个，公司找的外包公司写项目程序，已经要交付了，发现有几个功能没做，产品经理和开发那边都找我，我一个搞运维的又不懂，只能让他们去对开发文档，我也就顺便看了看，开发文档中明确的写明怎么做，然后就让他们就重新按开发文档继续写，

另一个，由于历史原因业务系统处于托管状态，只有部分参考文档可用，开发那边只能按当前已有文档进行开发参考，开发那边也一直在根据现有相关文档进行开发，杯具的是这帮子不仔细看，有问题总想着我能直接给他们答案，我也只是会用而已，开发我还真搞不来，然后和他们一起看开发文档，加密算法部分给她们指出后，问题解决了。

所以我觉得，开发团队在开发中很有必要阅读开发文档，这可以避免绕圈子，也会清楚开发文档中提供的内容。

程序员上班的主要工作就是看说明文档，根据说明文档编码。如果实在没有说明文档，有时还得亲自披挂上阵写说明文档。

写接口的有API文档，写通讯协议的有协议字段说明文档，写数据库的有数据库规范文档，

总之任何一个大公司文档扮演的一个至关重要的问题，因为形不成文档，公司管理就会陷入混乱不堪的局面，当某个核心员工离职后，下一个接盘的程序员会丈二和尚摸不着头脑，一头雾水，边填坑边骂娘，有了文档就可以看文档结合代码，了解其中模块逻辑以及结构，包括哪些坑不能踩等等好处。有些公司会专门有文档工程师这个职位来专门负责整理各种文档，并且保存在服务器上。

好的文档都是程序员等人智慧的结晶，是一盏指路明灯，是一条通往光明的道路。程序员不能看说明文档等于在黑暗里摸爬滚打，有了说明文档才迎来了黎明的曙光。

先说观点，我认为看文档没什么问题，但是“大量”这个程度很难衡量，按照需要看文档是个非常重要的事情。
需要花费时间的情况不需要花费大量时间的情况小结
在工作中阅读文档其实也是工作内容的一部分，而且现在大多数互联网公司都靠KPI进行考核，平时就算你把时间都用来看文档没关系，最后KPI没完成一样会被公司淘汰。所以公司不会阻拦你花费时间看文档，最多你老板会提醒你浪费这么多时间看文档而没有实际的产出会对你年终考核造成影响罢了。

题主对文档的定义不是很明确
第一个是需求说明文档
这个是在开发过程中必不可少的文档，只有清楚了开发需求，程序员高效率的开发，程序员一天的工作时间并不是都是在写代码，而是在看文档，了解需求，理清思路，只有什么都清楚了，写代码或许只要十几分钟。

再者对于一个项目新人来说不看文档了解需求，没人给你从头到尾的在讲一遍需求，你不看文档自己发挥？进入项目是和别人共同开发，你不肯能不顾及之前的代码规范。
第二个是开发文档
就拿微信开发来说，微信开发不是每个程序员必须会的东西，但是用到了怎么办，还不是去看他们的开发文档，只有将开发文档思路理清楚了，才可以进行下一步开发。
第三个是API文档
在前后端分离的开发模式中API文档是必不可少的文档。不看API不知道数据是什么样。也就是不可能顺利的和后端进行结合。

兄dei，假设你是程序员，你在写程序时，旁边会有人守着你吗？

假设你不是程序员，你在做本职工作时，旁边会有人守着你看你怎么做事吗？

答案肯定是没有的。谁会闲着招个人去监督你，看你用什么方式去完成给你的任务。

现在不管是大公司还是小公司，没有人会在意你怎么去完成你的工作，给你的任务，在很多时候，大家只关注结果。如果说有干预，最多只是实现的方式。像写程序，假设有个功能是即时通讯相关的，这种自己写需要的时间成本投入较高，那么很多公司就会选择采用市面上比较稳定的第三方平台。这算一种实现方式的干预。但是在接入的过程中，不会有人去管你是通过阅读第三方SDK文档，还是谷歌搜出来的，最后能达到预期效果就ok了

所以，其实你看不看大量文档，没有人会在乎，关键是你自己，建议自己写东西时，不要一味的复制粘贴，要有自己的想法。太依赖文档对于自己成长很不利

当然允许看文档。

要知道，随便哪个类库，都有无数的类和方法，每个方法又有若干参数，鬼知道它们都是什么意思，谁的脑子能记得那么多内容。别说是人家提供的类库，就是自己写的代码，过一段时间也不记得什么意思了。没有注释和文档，怎么看懂代码？

如果没有需求分析文档，程序员怎么理解正在开发的这个软件的基本业务流程？

如果没有架构设计文档，程序员怎么理解软件各个功能模块之间的功能与业务逻辑？

如果没有接口文档，那么多类和方法，都怎么调用，会返回什么值，难道靠猜？

……

在日常开发工作中，不仅允许看文档，还会强迫你写文档。如果你写的文档别人看不懂，别怪领导骂你不认真。文档对于软件开发的重要性是不言而喻的。

还有一个秘密告诉你，那些经常写文档的程序员，要比不写文档的程序员工资更高。

真的！！！

迎娶白富美，从会写文档开始！

毫无疑问是的。

对于程序员来说，在实际工作中进行代码编写和项目开发时，是离不开各种各样的文档的。文档包括：

不允许看说明文档，这基本上只会出现在面试或者考试中，为了考察程序员自身的编码能力，才要求脱离参考资料，利用自身的知识和技术来完成。

当然了，程序员工作中也不能只看文档，要是花费大量时间通读不必要的文档，工作可就做不完了。

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