美文网首页
文档之殇

文档之殇

作者: 杨少侠 | 来源:发表于2020-03-17 23:27 被阅读0次

    说起写文档,我相信这是许多程序员的噩梦。宁敲千行码,不碰一文档。很不巧,复工后到现在,一直在写文档,头大了,人瘦了。讲真,我真讨厌写文档,特别是这种 XXX 设计文档。

    在刚开始写的时候,照着样板罗列了大纲,学习了一下如何制作目录,挑容易的部分硬着头皮慢慢磨,经常卡住,毫无往日写文章的顺手感。需要画流程图,因为环境限制,无法用心仪的工具制作,得知同事是通过 PPT 制作的,研究了一下,大开眼界,靠着刚开始的兴趣和干劲做了不少图。

    上一次写类似的文档,还是在大学,上个年代初的事情了。在软件工程领域,设计文档要早于编码实现,但是不论是在学校,还是在工作中,真实的情况恰恰相反,都是先实现功能,后补文档。这样子,反而加剧了我对文档的忽视和厌恶,让我觉得这类文档不过是形式主义的体现。

    但是经过这些天集中式地书写文档,我对写文档这件事有了更清晰的认识。不想写文档的真实原因有二,其一、对自己所写的程序没有非常清晰透彻的掌握,以至于在编写文档的时候要花不少时间进行逻辑的梳理。其二、写文档的经验不足,对相关文档的规范和内容格式没有充分的了解,对相关软件的使用不够熟练,又希望自己能把文档写得足够好。对于第一点,自己的逻辑还有漏洞,反映到程序上,就可能会产生 bug。对自身的要求就是以后开发之前,画流程图,写相应的文档,不仅是为了梳理逻辑,也是为了以后写文档之需。对于第二点,毛主席在《对晋绥日报编辑人员的谈话》中说到「要使不懂得变成懂得,就要去做去看,这就是学习」、「没有经验,就难免要犯错误。从没有经验到有经验,要有一个过程」。所以解决的办法,就是多学多写,多思多改,耐下心来做细致的工作,不要总幻想着干大事。

    其实,哪里是对写文档厌恶,只是无法接受和面对自己的表现差而已。写了这些年的程序,技术一般般,也没有非常厌恶和沮丧,而文档没写过几次,就如此沮丧和讨厌了,这岂不是双标?更何况写文档也是开发的一部分,把开发简单地看做写代码,是一个非常严重的疏忽。

    这次的文档事件让我觉察到,自己对职业所具备的能力没有清晰的认识,以至于在遇到一些问题的时候,相关技能水平不足,但是又期望得到一个好的结果,这就会有矛盾产生,对自身也是一种打击。再准确点讲,就是对自身职业的了解很模糊,没有一个清晰的职业发展规划。只是从自身经验出发,盲目地进行学习,这是犯了经验主义和盲动主义错误,说明自己是脱离了客观实际的。

    日常生活工作中,书写的形式还有许多,比如简历、申请转正、离职申请、请假申请、各类邮件、书评、影评、自我介绍等等,这些很常见,也很重要,但是我却没有足够的练习。可能是我把写作看的太过狭隘,忽视了日常实用文体的练习,自以为平时的文字写的还凑合,就能在其余方面也得心应手。真到了实际应用时,就会产生心理落差,发现完全不是这样子。

    最后以《毛选》中的一段话作为结尾:「手里拿着扫帚就要研究扫的办法,不要躺在床上,以为会来一阵什么大风,把灰尘统统刮掉。我们马克思主义者是革命的现实主义者,绝不作空想。」

    相关文章

      网友评论

          本文标题:文档之殇

          本文链接:https://www.haomeiwen.com/subject/esrfyhtx.html