我一直都觉得,文档和代码都写的非常棒的工程师,都值得大家好好珍惜。
其实代码跟文字表达能力,个人认为是相同的。可惜的是,很多工程师都能写出非常工整和优雅的代码,却不愿意花一点点时间在写文档这个事情上,当然也包括代码上的注释。
其实这是我认识的很多理工科男生的共同特点,大家往往都不喜欢写文档,甚至不屑于用代码以外的方式来表达。
我一直以来都是一个非常注重文档的人,为什么呢?可能最主要是我在成长道路上走了很多弯路,都是因为很多工程师和同事不愿意写文档,甚至是写不出来可读性很好的文档所导致的。
关于可读性,其实很容易理解,要讲清楚一个事情,不仅是用文字就能简单做好的,有时候配上一些形象的图,真的对理解大有裨益。另外就是切忌长篇大论,因为很多人的阅读耐性不会超过5分钟。
另外就是格式的问题了,我写文档以来,一直非常注意标点,中英文切换,段落等分隔等等,希望尽量做到对以前对以后都兼容,大家看到我不同时期的文档,都不会因为我的格式,让你在阅读文档的时候造成障碍。
所以同学们啊,好好珍惜你身边注重写文档的工程师吧,他一定是团队的奉献者,也是一个非常注重细节的人。
以上是来自我读了一篇又长又臭表达能力巨差的内部文档,看了三次都没完全看懂的操作的愤怒。