为什么要不停的写文档

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

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

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

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

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

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

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

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

目录
相关文章
|
Java 程序员
IT学不好没什么,大不了躺平
IT学不好没什么,大不了躺平
|
监控 关系型数据库 MySQL
C#程序发布时,一定要好好地保护,不然你会后悔的
C#程序发布时,一定要好好地保护,不然你会后悔的
104 0
|
SQL 存储 安全
又有程序员删库跑路?还好我早有准备
又有程序员删库跑路?还好我早有准备
94 0
|
程序员 C语言 C++
轻轻松松几分钟,看完锤爆流程控制结构。
轻轻松松几分钟,看完锤爆流程控制结构。
|
芯片
程序人生 - 手上总有静电该怎么处理?
程序人生 - 手上总有静电该怎么处理?
159 0
程序人生 - 手上总有静电该怎么处理?
|
前端开发 JavaScript Android开发
总会用到的前端小姿势
工作中总结的一些常见的前端问题处理方案,持续总结与记录,上班才能更愉快地摸鱼(划掉)
|
存储 编解码 自然语言处理
每次阅读外文技术资料都头疼,终于知道原因了。
每次阅读外文技术资料都头疼,终于知道原因了。
每次阅读外文技术资料都头疼,终于知道原因了。
|
人工智能 安全 数据挖掘
这么一搞,再也不怕线程打架了
假如我们需要处理一个文本文件,里面有 100万行数据,需要对每条数据做处理,比如将每行数据的数字做一个运算,放入到另一个文件里。
152 0
这么一搞,再也不怕线程打架了
致老友-有时候我词不达意 但我真的很开心生活有你
前段时间,可能是因为长期久坐的原因,屁股上长了坐板疮,加上每天上下班都是骑共享单车的原因,也没有好好地注意,身体终于垮了,伤口也有了感染,一个礼拜都...
156 0
|
SQL 关系型数据库 MySQL
妈妈再也不用担心我把数据弄丢了
数据是现代大小厂的重要资产,保护和恢复数据成为了重要的技能, 最近几年,常有一些无良程序员删库跑路的情况,不仅给所在企业更是给自己造成重大的损失。 另外,即使不是故意的情况下,也会因为疏忽造成数据误操作,是一件及麻烦又头疼的事情……
156 0

热门文章

最新文章