为什么要不停的写文档

简介: 假期重新把之前在新浪博客里面的文字梳理了下,搬到这里。

好记性不与烂笔头,互联网blog就是烂笔头啊。
大学里、研究生期间,老师一直告诫我们要多写文档,在写的过程中发散思维、在写的过程中加深认识、在写的过程中全面回顾、若干月、年后再温习就知道自己是如何进步的。

ppt开始,老师告诉我们ppt如何整理、风格等等。
之后写专利,完整的30-60word页的专利,从格式到内容,从广泛搜集到慎重引用,从继承到不同。
之后写论文,自斟句琢,每一个地方所谓的大话、经典话、新话都应该注明出去,什么是自己的、什么是前人的要明确说明白,不要含糊其词、偷换内容、甚至剽窃,要尊重知识。
所有写的,最终要能讲出来,那时才真正进入你的脑子里,会一直保存的。
写文档其实更多的是给自己看的,当然如果好的文档不妨分享出来。

经历过,就一直保留着思考、总结的习惯。入职后,对文档又有新的认识了。
对于团队内部,尽管内部沟通相对外部沟通成本低,但是如果有文档沟通效率无疑更加高效。
更重要的我理解文档的重要性是:
一个产品尤其是积累了好几年的产品,应该形成历史文档,这样一来避免单点效应,避免团队出现所谓缺一不可的人,而且来新人加入,学习成本明显降低,进度更快。自己从新人走过来,感触最深。

对于团队外部,给业务方的文档,虚实都要。虚的可能是宏观的、拔高的、价值方面的,实的就是具体怎么使用、使用的帮助文档、深入了解的帮助文档等。

对于个人,当不停的将平凡的细节汇总、整理、归纳,自然会对一个问题的解决转为一类问题的解决,真正看清楚来龙去脉,尽管很多场景没有那么多的时间去思考为什么,完成任务优先。
另外,坚信前3年工作的深入性、接触面、系统性、底层性、专一性、继承性,注定影响后续的工作发展和规划。

快餐式的产品、快速迭代的产品、带病前进的系统,似乎淘汰的都是低价值的,不适应发展的,我到觉得知晓该技术的过去,才能真正体会该技术的现在和未来。当然不是什么都知道就好,重要的还是专注领域相关的、工作的主体任务相关的。

文档只是写给自己的,顺带分享出去。这是我的起点,适合自己的习惯而以,别无它由。
当然有人是为了KPI、为了某些个人利益而写文档,不反对这种驱动,关键是分享出来的知识有价值就好!

目录
相关文章
|
2月前
|
XML 算法 Java
如何写出让同事无法维护的代码
如何写出让同事无法维护的代码
|
开发者
试着做点儿有趣的事情
一个游戏怎样才算是做完了?这是个因人而异的问题。有些游戏还没有做出来就做完了,因为开发者不想再做了。有的游戏看上去做完了,但是后续还在不停的更新,那我们就说这个游戏其实还没有做完。至于如何算是做完了,我觉得这应该交由该游戏的制作者来决定。
80 0
|
小程序 开发工具
彻底搞清微信小游戏开发中的循环的使用
本文主要内容为游戏开发中常用的循环的使用方法。 如果你没有任何的游戏开发经验,欢迎阅读我的“人人都能做游戏”系列教程,它会手把手的教你做出自己的第一个小游戏。
162 0
不用费劲,这5款效率工具为你解决学习工作烦恼
今天我要向大家推荐5款超级好用的效率软件,无论是在学习还是办公中都能够极大地提高效率。这些软件可以帮助你解决许多问题,而且每个都是真正的神器。
142 0
不用费劲,这5款效率工具为你解决学习工作烦恼
|
前端开发 JavaScript Android开发
总会用到的前端小姿势
工作中总结的一些常见的前端问题处理方案,持续总结与记录,上班才能更愉快地摸鱼(划掉)
|
芯片
程序人生 - 手上总有静电该怎么处理?
程序人生 - 手上总有静电该怎么处理?
135 0
程序人生 - 手上总有静电该怎么处理?
|
JSON Java 测试技术
如何写出让人抓狂的代码?
如何写出让人抓狂的代码?
如何写出让人抓狂的代码?
|
开发工具
彻底搞清微信小游戏开发中的循环的使用(上)
循环是游戏开发中一定会用到的逻辑,不论是你想控制移动,或者进行遍历,亦或者不停的去执行某一段逻辑,都需要使用循环。那么对于循环的使用你彻底了解了吗?今天这篇文章就帮助你彻底的弄懂微信小游戏开发中的循环的用法。
145 0
彻底搞清微信小游戏开发中的循环的使用(上)
彻底搞清微信小游戏开发中的循环的使用(下)
循环是游戏开发中一定会用到的逻辑,不论是你想控制移动,或者进行遍历,亦或者不停的去执行某一段逻辑,都需要使用循环。那么对于循环的使用你彻底了解了吗?今天这篇文章就帮助你彻底的弄懂微信小游戏开发中的循环的用法。
323 0
彻底搞清微信小游戏开发中的循环的使用(下)
|
JavaScript 算法 API
让你瞬间提高工作效率的常用js函数汇总(持续更新)
本文总结了项目开发过程中常用的js函数和正则,意在提高大家平时的开发效率,具体内容如下: 1. 常用的正则校验 2. 常用的设备检测方式 3. 常用的日期时间函数 4. 跨端事件处理 5. js移动端适配方案 6. xss预防方式 7. 常用的js算法(防抖,截流,去重,排序,模板渲染,观察者...)
136 0