为什么要不停的写文档

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

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

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

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

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

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

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

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

目录
相关文章
|
3月前
|
数据采集 存储 JSON
推荐3款自动爬虫神器,再也不用手撸代码了
推荐3款自动爬虫神器,再也不用手撸代码了
|
消息中间件 前端开发 调度
C++20 协程——你还只是听过?觉得没时间了解,这里可以帮到你。五分钟 从没听过到使用的帮助手册
来源:协程是在C++20 标准中提出的一个新的工具。 它突破传统的程序在cpu中来回切换时需要更新和恢复PCB资源现场的耗时操作(多进程)或者COW(低级调度)操作时间。
206 0
|
6月前
|
算法
重要的话说三遍 (2016)
重要的话说三遍 (2016)
40 0
|
6月前
|
JavaScript API
【源码共读】组件太多,重复工作量大?这次一行命令带你解放双手!
【源码共读】组件太多,重复工作量大?这次一行命令带你解放双手!
70 0
|
开发者
试着做点儿有趣的事情
一个游戏怎样才算是做完了?这是个因人而异的问题。有些游戏还没有做出来就做完了,因为开发者不想再做了。有的游戏看上去做完了,但是后续还在不停的更新,那我们就说这个游戏其实还没有做完。至于如何算是做完了,我觉得这应该交由该游戏的制作者来决定。
89 0
|
芯片
程序人生 - 手上总有静电该怎么处理?
程序人生 - 手上总有静电该怎么处理?
143 0
程序人生 - 手上总有静电该怎么处理?
|
架构师 Dubbo Java
耗时两周手撸了一个 RPC 轮子,是驴子是马拉出来遛遛
耗时两周手撸了一个 RPC 轮子,是驴子是马拉出来遛遛
耗时两周手撸了一个 RPC 轮子,是驴子是马拉出来遛遛
|
JSON Java 测试技术
如何写出让人抓狂的代码?
如何写出让人抓狂的代码?
如何写出让人抓狂的代码?
|
Ubuntu Linux 数据安全/隐私保护
同事的一个动作,让我熬夜的工作全部白费…….
xtrlock 工具在大多数 Linux 发行版软件库里,我们可以直接使用对应的发行版的包管理器来安装它。 在 Debian,Ubuntu,Linux Mint上可直接使用 apt-get 命令安装
331 0
同事的一个动作,让我熬夜的工作全部白费…….
|
程序员 开发者
如何写出让同事膜拜的漂亮代码?
“代码千万行,注释第一行;编程不规范,同事两行泪”;"道路千万条,安全第一条。代码不规范,亲人两行泪。"在技术圈广为盛传,可见代码不规范让程序员们是多么的头痛。
1457 0