我写过技术文档,如果不把内容抽象成模型总结成公式,那样效率就太差了_风闻
九江月-华东黑鸭养殖中心技术顾问2020-09-16 10:14
作为做过程序设计,写过技术文档的人来说一下为什么会出现这个情况。编写教材和文档的人是非常熟悉其理论和内核的,就我开发了一套框架,我知道它内里有什么坑,要怎么避开它,但这些坑是适配问题带来的,不是我的框架本身的问题,所以我的文档上就不会写,写上去就显得非常啰嗦,但别人总会遇到这个问题的,于是就掉进坑了。举个最简单的例子,Windows系统是CRLF(回车换行),Linux系统则是LF(换行),mac系统则是CR(回车),所以同一个文件在不同的平台存放就会遇到文件md5不一致的问题,在校对的时候会出错,但我不会把这个情况在文档里写明,因为这个问题对我们来说是,常识。我写文档的时候,不可能从最最基本都问题写起的,要我跟你从打字机开始讲起,好好了解一下最早的拨号上网以及50hz的工频电流导致的必须使用两个占位符才能保证传输的准确性吗?那恐怕和我的文档确实是关系不大。我写是为了什么,是一本操作手册和说明文档,为了让人快速上手,理解运作的原理,我必须全部抽象成模型,总结成公式,我才能讲下去,而不是东一片西一片的,那样效率太差了。所以实际上我是能理解的,你看这个函数多漂亮多方便哦,如果你要靠自己去实现这个功能,我保证你得多花两百行,还不一定能搞定,为什么?因为我见识过二十多年前用古老的语言(vb)写的四万多行的地狱代码,然后要把这些东西搬迁到新的项目上,真就要死了,简直就像是在考古哦。所以一本教材,有些东西真的是觉得理所当然的(比如三角函数),如果连半角公式都看不懂,那这课还真就讲不了,还有一些呢,不讲可能确实难以理解,讲的话又牵扯太大,根本讲不完的,就像前端在ie时代为了给各种浏览器适配而不得不写的各种奇葩hack,你永远无法想象人类的智慧会用在什么地方,这个真就是变化太多了,需求的情况也非常复杂,不可能一一讲解的,只能举常见几个例子,但该被坑的地方还是得踩坑。
本评论由用户“北方不吃面男孩”推荐,来自《国外教材比国内教材更易懂的说法, 你怎么看?》一文。内容仅代表用户观点,标题为北方不吃面男孩用户添加,更多热乎讨论请移步原文。