嗯,说人话,多么质朴的三个字,但实际做起来,个人觉得还是蛮难的,我在技术角度讲解问题或者传递信息的时候,虽然已经努力化繁为简,但依然还是偶尔会忘记“说人话”。
之所以写这篇文章,也是因为最近碰到驻地同事使用我做的自助诊断系统,其中有一个系统过滤的日志输出:currentMaxEpisodeIndex=0, excluded.
。
这在我看来非常容易理解,最大集数是0,作为电视剧剧集来说,这数据是有问题的,所以过滤掉了。但这条记录,在使用者眼中,就没那么简单了,就算是根据驼峰拆开了单词,就算对业务了解颇深,也还是会觉得这日志是多么的生涩难懂。
思来想去,不用说,下个版本这个输出增补上必要的文字说明。考虑到收获的话,以后的所有输出,都应当考虑输出机器和人类都能理解的描述字段。
如本文对您有用,打赏、点赞或留言 将是对我最好的支持~
尊重他人劳动成果,转载请务必附上原文链接,我将感激不尽。
留言