首页 » 软件开发 » 为什么程序员都不写文档?(文档代码写作自己的编写)「程序员不喜欢写文档」

为什么程序员都不写文档?(文档代码写作自己的编写)「程序员不喜欢写文档」

雨夜梧桐 2024-07-23 22:04:55 软件开发 0

扫一扫用手机浏览

文章目录 [+]

写作从来都不是一件易事。
软件工程师与其他人一样,他们不愿意写文档,是因为想要写得条理清晰、简洁明了,实在是太难了。

写作是一项非常艰巨的任务。
我们必须清楚地组织自己的思想,然后经过检查和整理,最后再清楚地表达出来。
尽管最后的表达部分可以从某种程度上进行简化(取决于写作的质量),但是正确完成这三个步骤需要付出大量的努力。

在编程的世界中,面对所有问题,我们能够给出的最佳答案都是:“视具体情况而定”,一切都需要权衡取舍,但写作则更加复杂。
你需要预设上下文,证明决策的合理性,然后论证代码底层思想的推动力。
这样的文档只有编写得好才会有用,但写好太难了,所以往往根本做不到。
错误的代码仍然可以运行,但错误的文档则不会出现。

为什么程序员都不写文档?(文档代码写作自己的编写) 为什么程序员都不写文档?(文档代码写作自己的编写) 软件开发
(图片来自网络侵删)
没有文档代码也可以照常发布

即便开发人员不编写文档,他们仍然可以完成自己的工作。
没有文档也不会阻碍交付代码(至少不会马上有问题)。
没有文档记录的技术决策所造成的损害是累积性的。
就像技术负债一样,不会立即造成伤害。

就像我上面所说,写作主要是思考和分析问题。
大多数时候,编程只需要凭借自己的经验和判断。
一堆杂乱无章的代码照样可以运行,但是一堆乱七八糟的单词和段落则无法形成文章。
写作必须清晰才能发挥作用。
只要代码能够完成工作,就可以被接受(在某种程度上)。
而且,由于大多数组织只在乎产品的交付,因此凡是不会阻碍产品交付的工作都会被忽略。

为什么程序员都不写文档?(文档代码写作自己的编写) 为什么程序员都不写文档?(文档代码写作自己的编写) 软件开发
(图片来自网络侵删)
在编写代码之前,首先要编写文档。
除非代码改动非常小,否则每位工程师都应该写一份注释,说明他们将要进行的工作,并由团队的其他成员来实际执行。
经过详尽的讨论后,实际的代码改动就微不足道了。
简化文档的编写工作。
不要将文档的编写弄得过于复杂。
图表等花里胡哨的东西可以先放一放。
你只需要简单地写下你的想法、所做的事情以及原因。
即使文档只能为现在和将来的团队其他成员提供基本的说明,也非常有价值。

私我 “资料” 获取!

标签:

相关文章

小K五国语言,跨文化沟通的桥梁,小k salt。

随着全球化的发展,跨文化沟通显得尤为重要。在这个多元化的时代,语言成为了沟通的障碍,而小K五国语言则成为了跨越障碍的桥梁。本文将从...

软件开发 2024-12-31 阅读0 评论0

IT机房,守护数字世界的坚实堡垒

随着科技的飞速发展,信息技术(IT)在现代社会中扮演着越来越重要的角色。IT机房作为承载着企业、政府及个人大量数据信息的核心场所,...

软件开发 2024-12-31 阅读0 评论0