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

程序员在上班时,允不允许大量的看说明文档来帮助写程序,第1张

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

项目方面

技术方面

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

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

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

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

看文档的屏幕要买竖屏!

我们团队

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

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

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

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

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

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

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

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

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

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

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

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

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

先说观点,我认为看文档没什么问题,但是“大量”这个程度很难衡量,按照需要看文档是个非常重要的事情。

需要花费时间的情况 不需要花费大量时间的情况 小结

在工作中阅读文档其实也是工作内容的一部分,而且现在大多数互联网公司都靠KPI进行考核,平时就算你把时间都用来看文档没关系,最后KPI没完成一样会被公司淘汰。所以公司不会阻拦你花费时间看文档,最多你老板会提醒你浪费这么多时间看文档而没有实际的产出会对你年终考核造成影响罢了。

题主对文档的定义不是很明确

第一个是需求说明文档

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

再者对于一个项目新人来说不看文档了解需求,没人给你从头到尾的在讲一遍需求,你不看文档自己发挥?进入项目是和别人共同开发,你不肯能不顾及之前的代码规范。

第二个是开发文档

就拿微信开发来说,微信开发不是每个程序员必须会的东西,但是用到了怎么办,还不是去看他们的开发文档,只有将开发文档思路理清楚了,才可以进行下一步开发。

第三个是API文档

在前后端分离的开发模式中API文档是必不可少的文档。不看API不知道数据是什么样。也就是不可能顺利的和后端进行结合。

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

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

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

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

当然允许看文档。

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

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

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

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

……

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

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

真的!!!

迎娶白富美,从会写文档开始!

这个问题要根据具体开发的功能模块来看,不过原则来说,花大量的时间看说明文档,至少给人的印象是经验不够丰富,开发能力有待提高。

具体来说,如果是普通的功能开发,技术挑战不大,这种如果还要看文档,会被认为是开发能力问题。如果是有一定的技术挑战,公司在这方面的积累比较少,开发团队也对此有共识,这种问题看文档无可厚非,当然如果能业余时间学习相关的知识,会给团队留下开发能力强的印象。对于一些前瞻性研究,公司没有任何技术积累,或者全新的技术方向,这个看说明文档是加分的,甚至可以要求公司购买相关书籍或者在线培训,当然,自己啃下来会更NB。

在软件项目开发过程中,应该按软件开发要求撰写十三类文档,文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性!\x0d\需求阶段\x0d\1、可行性分析报告\x0d\说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性,评述为了合理地达到开发目标可供选择的各种可能实施方案,说明并论证所选定实施方案的理由。\x0d\2、项目开发计划\x0d\为软件项目实施方案制订出具体计划,应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。\x0d\3、软件需求说明书(软件规格说明书)\x0d\对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的,也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求,为生成和维护系统数据文件做好准备。\x0d\设计阶段\x0d\4、概要设计说明书\x0d\该说明书是概要实际阶段的工作成果,它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等,为详细设计提供基础。\x0d\5、详细设计说明书\x0d\着重描述每一模块是怎样实现的,包括实现算法、逻辑流程等。\x0d\开发阶段\x0d\6、开发进度月报\x0d\该月报系软件人员按月向管理部门提交的项目进展情况报告,报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。\x0d\测试阶段\x0d\7、测试计划\x0d\为做好集成测试和验收测试,需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。\x0d\8、测试分析报告\x0d\测试工作完成以后,应提交测试计划执行情况的说明,对测试结果加以分析,并提出测试的结论意见。\x0d\收尾阶段\x0d\9、用户 *** 作手册\x0d\本手册详细描述软件的功能、性能和用户界面,使用户对如何使用该软件得到具体的了解,为 *** 作人员提供该软件各种运行情况的有关知识,特别是 *** 作方法的具体细节。\x0d\10、项目开发总结报告\x0d\软件项目开发完成以后,应与项目实施计划对照,总结实际执行的情况,如进度、成果、资源利用、成本和投入的人力,此外,还需对开发工作做出评价,总结出经验和教训。\x0d\11、软件维护手册\x0d\主要包括软件系统说明、程序模块说明、 *** 作环境、支持软件的说明、维护过程的说明,便于软件的维护。\x0d\维护阶段\x0d\12、软件问题报告\x0d\指出软件问题的登记情况,如日期、发现人、状态、问题所属模块等,为软\x0d\件修改提供准备文档。\x0d\13、软件修改报告\x0d\软件产品投入运行以后,发现了需对其进行修正、更改等问题,应将存在的问题、修改的考虑以及修改的影响作出详细的描述,提交审批。

如果项目真正按照软件工程化流程走的话,主要依据是软件任务书和需求规格说明。

软件任务书规定软件的运行环境,软件需要做什么,实现哪些功能,有哪些性能要求。软件任务书中对软件功能性能的要求采用的是日常人类语言描述,如“找到员工中年龄最大的一个”。

软件需求规格说明细化软件任务书,用具体的计算机专业术语描述软件的功能需求,并详细规定输入输出,如上述任务书中找到员工年龄最大的一个可以分解为一个功能需求:

输入 全体员工的年龄,员工数目小于1000个, 输入年龄为整形数,姓名为字符类型

输出 年龄最大的员工姓名

以上就是关于程序员在上班时,允不允许大量的看说明文档来帮助写程序全部的内容,包括:程序员在上班时,允不允许大量的看说明文档来帮助写程序、软件开发项目中,过程管理文档都包括什么、程序员进行程序设计的主要文档和依据是什么等相关内容解答,如果想了解更多相关内容,可以关注我们,你们的支持是我们更新的动力!

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

原文地址:https://54852.com/zz/9786323.html

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

发表评论

登录后才能评论

评论列表(0条)

    保存