管理感悟:掌握写文档的技能
红朝儒生
2016-5-3
关键字:管理 文档 程序员
简介:程序是汝之工作产出,文档亦是。写好文档,是每个管理者、程序高手的必备技能。
吾在软件行业混了这么多年,经历多,感受也多。其中一个比较深刻的体会是:很少有程序员掌握写文档的技能。
什么叫写文档的技能?吾以为有几层含义:
写什么样子的文档。是文章?表格?幻灯片?
文档的基本概念。比如,要有作者、时间,合理分段(段落不要太长),开头缩进,使用表格表达某些内容。这些是小学生就应该掌握的技能,大多数程序员都不会。
使用必要的文档技术,比如:项目编号,缩进,标题,目录,页眉页脚,自选图形等,字体段落。
吾自认写文档的技能实在一般。而在工作中,很少有同事能写出让吾满意的文档。这说明什么?说明这些文档实在是……不入流,不合格,不规范。吾以前在中兴,专门开过一个“格式优良”的课程,本希望越来越多程序员能学习,结果开过一次。
有程序员就问了,吾写好程序即可,这文档写好了有什么好处?
其实程序跟文档是有类似性的。文档组织不好,程序也很难组织好。
文档是表达汝之思路和内容的。好文档别人看了明白;差文档看了直摇头,有损个人技术威信。
程序是汝之工作产出,文档亦是。
写好文档,是每个管理者、程序高手的必备技能。除非汝只想原地踏步。
掌握好了写文档技能,不仅更美观,也不容易出错。比如项目编号,不会的人手工调整,非常容易出错。
所以,每个程序员必须掌握写文档的技能。
这里需要指出:掌握写文档技能,写出格式优良、规范整齐的文档,是每个人都能够做到的;而内容和组成,则受限于个人水平而定,是难以学习的。