济南达内IT培训
美国上市IT培训机构

13355319715

济南达内Java培训程序员写开发文档都有哪些好处

  • 时间:2022-03-22
  • 发布:济南达内
  • 来源:济南达内

软件开发文档是每一个软件开发项目都应该具备的一个开发工具,而今天我们就通过案例分析来了解一下,程序员写开发文档都有哪些好处。


 

不愿意写文档的原因

不愿意写文档,有几方面原因:

语文水平不好,一写就暴露了。写几句话都难,何况写一篇文章?但我强烈建议多写写就好。试想:如果缺乏清晰的表达能力,如何有条理说清楚工作成果,如何给自己争取升职加薪的机会呢?

团队氛围不提倡。别人不写文档,那自己就得抱着“我不入地狱谁入地狱”的心态,甚至还不讨好。本来是希望能帮助新手更好熟悉帮团队更好维护业务,有的TL可能会默认你的“英雄行径”,既不拥抱也不反对,有的可能还嫌“效率低,KPI做得不够好”。这种情形下,建议适量写,不要因为外在因素影响内在驱动,但也不要花费太多时间去对抗。

思维没转变过来。总觉得代码是一生产力。实际上,文档和代码都是表达,都是解决途径之一。能动嘴皮子解决的就不用代码解决,能用一行代码解决的就不动嘴皮子。千万不要以为对产品或提要求的人百依百顺就是真爱,别人就喜欢了。你做与不做,别人都有一样的烦恼,真爱是在博弈中产生的。不是所有代码都值得去写的。从某种意义来说,代码只是针对不同领域(今天是交易,明天是教育)写相似的for-if语句,代码技能并未有飞跃性提升,不若多拓展一些解决问题的途径,减少写不必写的代码。有时,说服力比写代码更厉害。

不够重视表达。程序开发,是集逻辑、设计与表达为一体的。表达是其中重要一部分。遗憾的是,很多国内程序员还不够重视表达部分。我想强调的是:表达沟通与写代码的技术技能同等重要!

惰性。优秀的程序员是懒惰的,尽可能避免低效的事情。因此,程序员大多不喜欢公文式的文档。但我想说:优秀的程序员也是反惰性的:当他意识到一件事的重要价值时,就会克制做这件事。写文档这事是反惰性的,然而人的原生特性是懒惰却非反惰性的。你看看JDK那些大牛的类注释写得多详细多工整!相比而言,一些程序员代码水平不怎样注释也不好好写。差距多大!

写文档的益处

不过,写文档是有多方面好处的:

正如一位答友所说:文档是极好的沉淀思路的方式。善于写清晰的文档也会有助于写清晰的代码。日积月累,你的思路会越来越清晰,内心亮堂。这不仅仅对于开发有益处。

帮忙团队更好地熟悉和维护业务,建立团队规约;尤其适合新入职同学更快地熟悉团队工作氛围和业务相关,更好地上手。

建立在团队和内网的好印象和影响力,与公司内的更多优秀工程师建立良好的技术交流渠道。

良好的技术博客能让你在候选者之间更容易脱颖而出。一个创作优美又有一定深度和广度的技术博客摆在面试官面前,是他难以抗拒的诱惑。

我现有公司CTO鼓励写文档。高级别管理者必须具备良好的文档编写能力。但不是那种公文式的文档,而是知识类工作紧密相关的文档。当大多数人都鼓励写下自己的工作所得和总结时,公司的文档空间就变成了一座知识宝库。你能从中获得很多的姿势。我有幸见证了这一点。

上一篇:济南java培训机构程序员职业发展趋势分析
下一篇:济南达内培训java编程软引用的应用场景都有哪些

马上预约七天免费体验课

姓名:

电话:

济南达内Java培训线程池技术特点与参数分析

济南达内Java培训Java编程变量与常量用法分析

济南达内电脑培训零基础学习Java编程需要掌握哪些知识点

济南达内IT培训Java编程内存模型基础知识分享

  • 添加老师微信

    回复关键字:视频资料

    免费领取 达内课程视频学习资料

  • 添加老师QQ

    老师QQ:3288711675

    免费领取达内课程视频学习资料

Copyright © 2018 Tedu.cn All Rights Reserved 京ICP备08000853号-56 京公网安备 11010802029508号 达内时代科技集团有限公司 版权所有

选择城市和中心
江西省

贵州省

广西省

海南省

达内教育

有位老师想和您聊一聊