技术书写的跟说明书那么枯燥是一种劣势吗?

王福强

2024-05-05


之前有为老板跟我抱怨说,技术书写的都tmd跟说明书似的,枯燥无趣,就tmd不配叫写书…

嗯,怎么说呢,当时我也没咋在意,事后想想,其实,这或许就是技术书的特点。

精确,能够指导学习的人重现,这其实是技术书或者技术文档自身存在的价值。

我记得很多年前成哥跟我提到他在华为时候的经历,说那时候华为对文档也需要进行测试(不单单只是对代码进行测试哟), 而对文档进行测试的标准就是,找第三方或者不熟悉的人按照文档操作,只要能操作成功(复现),就算测试通过,否则打回重写。这其实是体现技术书/技术文档价值的最好案例。

虽然技术书籍里也会通过类比、引经据典、穿插作者所思所想,但再怎么丰满,也不如小说甚至玄幻小说让人读起来那么嘿,毕竟,受众群体就不一样。

有差异才是常态, Different is good, 每个行业或者事物存在的背后,自然是有其自己的底层逻辑在的。

恰好吃饭的时候脑子里胡思乱想,不知道因为哪个点跳到这块儿了,所以,简单码字记录下, 个人想法不一定对。


>>>>>> 更多阅读 <<<<<<


「福强私学」来一个?

「福强私学」, 一部沉淀了个人成长、技术与架构、组织与管理以及商业上的方法与心法的百科全书。

footer img for kb.afoo.me

开天窗,拉认知,订阅「福报」,即刻拥有自己的全模态人工智能。

订阅「福报」