28 | 结构化:写文档也是一种学习方式
郑晔
该思维导图由 AI 生成,仅供参考
你好,我是郑晔。
你写文档吗?我知道,你可能并不喜欢写文档,因为在你眼中,写文档是繁琐的,是旧时代软件工程的产物。
最开始我对写文档的印象也不好。
我的职业生涯是从一个通过了 CMM 5 级认证的大企业开始的。可能今天很多程序员已经对 CMM 感到陌生了,它是能力成熟度模型(Capability Maturity Model for Software)的缩写,用来评估一个组织的软件开发能力,曾在国内风靡一时,许多软件公司都以拥有 CMM 认证为努力方向。
在这个极其重视过程的企业里,文档是非常重要的一环。但我看到的真实场景却是,一个软件已经上线运行了,大家才开始为了应付过程纷纷补写文档。
每个部门都有专门的过程负责人,要求你严格按照格式写文档,保证字体字号的正确性。然后,用 A4 纸将文档打印出,封印在一个仓库里,再也无人问津。
然而,文档却是非常重要的。后来,我到过很多公司,凡是我能够比较快上手的,通常都是有比较详尽的文档,而那些文档缺失的公司,想要把信息梳理清楚,往往会花很长时间。
另外,我学习很多软件开发的相关知识,通常也是依赖各种各样的文档。对我们程序员这个走在时代前列的群体来说,大量阅读文档就是我们日常工作的一部分。
公开
同步至部落
取消
完成
0/2000
荧光笔
直线
曲线
笔记
复制
AI
- 深入了解
- 翻译
- 解释
- 总结
这篇文章以“无他,唯手熟尔”为题,强调了写作和公开演讲对于程序员学习和知识输出的重要性。作者指出,结构化知识对程序员至关重要,能提高学习效率。通过金字塔原理,提出了一种结构化知识的方法。文章还强调了知识输出的重要性,认为通过写作和演讲输出知识是获得反馈的有效方式。最后,鼓励读者通过结构化知识输出来提高自己的学习效率。文章内容深入浅出,强调了技术人员的知识输出和学习方法,对于提高读者的学习效率和知识结构化能力具有一定的指导意义。
仅可试看部分内容,如需阅读全部内容,请付费购买文章所属专栏
《10x 程序员工作法》,新⼈⾸单¥68
《10x 程序员工作法》,新⼈⾸单¥68
立即购买
© 版权归极客邦科技所有,未经许可不得传播售卖。 页面已增加防盗追踪,如有侵权极客邦将依法追究其法律责任。
登录 后留言
全部留言(45)
- 最新
- 精选
- Y024金字塔原理的四个基本原则:“结论先行”(一次表达只支持一个思想,且出现在开头)、“以上统下”(任一层次上的思想都必须是其下一层思想的总结概括)、“归类分组”(每组中的思想都必须属于同一范畴)和“逻辑递进”(每组中的思想都必须按照逻辑顺序排列)。前面两个特点是纵向结构之间的特点,后面两个特点则是横向结构之间的特点。以上内容收集整理自李忠秋老师的《结构思考力》,感兴趣的小伙伴可以看看。
作者回复: 多谢补充!
2019-03-09458 - 谭鹏写留言 也是一种输出吧. 确实,小组里我最先学习的react native,并且带领安卓组一起搭建 能各自积累各自组件,也能方便测试来测试的架构 ,相继作出了3个应用,然后 我们经理就让我给大家做培训,我以为我很深入了解了 ,结果写文档的时候发现自己无从下手,然后演讲的时候自己发现缺失了好多细节, 事后自己深刻总结了一下 ,发现是自己是平时不积累,临时抱佛脚,脑子里根本没有一个结构,还老是想一下子就能讲的很好。现在开始注意平时的积累了 ,比如看书的时候先花时间看目录 先搞懂脉络和结构
作者回复: 欢迎多留言!
2019-03-0820 - 西西弗与卡夫卡文档极其重要,有时候说半天,不如文字半篇。最近我常用来整理思路的文档模版是OKR结合影响地图。OKR用来描述战略目标和是否达成的衡量标准,而KR又成为影响地图的Why,接下来是Who,即那些会对KR产生正向反向影响的角色。然后是How,即这些角色要做哪些会影响KR。最后从中找出当前最有效的路径制定执行计划
作者回复: 很好的分享!
2019-03-0817 - David Mao非常同意文中的观点,学习知识最高的境界是输出。 1.结合隔壁《软件工程之美》的专栏,学习的四重境界,器->术->道->传道。输出实际是 四重境界里的最高境界:传道。 2.作为职场老司机,深有体会,想把自己以为很清楚的东西讲出来,让别人理解的很清楚,没那么简单, 尤其是把东西讲给非专业人士。 3.之前听到一个故事,国外某大公司在全球招募区块链运营主管,面试了很多人,99%的人把区块链讲给没听过的人都讲不清楚。 4.写作和演讲是持续输出最好的方式,因为在这个过程中和过程后,有很多未知的问题,对作者和演讲者是一个考验。
作者回复: 多谢分享!
2019-03-0913 - 张亚运无他,唯手熟尔很有启发,就像算法刷题,没有人只刷一遍就能成为高手的。高手都是again and again!!!
作者回复: 本专栏也值得反复刷,反复理解。:)
2020-01-089 - 蓝士钦大学的时候我也经常写blog,更多的是对新知识的笔记,很多都是模仿别人的金字塔做概括性总结,就好比我现在订阅的这个专栏,会把每一章的总结进行整理成精华。但是如果是自己创造性的文章就比较少,比如我想写jvm相关的blog,势必离不开其他人的blog作为参考,所写的某段文字必定是在某个地方看到的,写着写着感觉就快变成抄袭了,所以现在基本不更新blog了,只写自己可见的知识笔记了。知识点不适合创造,网上有太多相同的内容了。自己写的小工具更适合写成文章分享,看过去更有成就感。
作者回复: 多看书,网上的很多内容不太成体系。知识点的罗列意义不大,但自己把知识整理输出对自己意义很大。
2020-06-217 - Xunqf读书学习要记笔记,上学的时候就经常说“好记性不如烂笔头”,工作也是如此,每当到月底或者年底考评的时候,往往就记不得自己这个月或者这个季度以及今年都做了啥,好像什么都没做,但是又好像每天都很忙,总结很重要,做过的事情最好能形成文档!
作者回复: 这种总结有价值,但我更鼓励输出,可以得到反馈的那种。
2019-03-085 - 杨鹏Geek公开演讲,大家都会紧张。
作者回复: 克服之后,强大一大截。
2020-03-283 - pyhhou最近开始坚持每周写一篇跟技术相关的文章,也是不知道要写什么,有时写写算法,有时写写最近学到的东西,但是大多都只是简单描述一些知识点,还没有到发表自己深度看法的程度;即使这样,还是发现有时候看似自己熟悉的不能再熟悉的地方,详细描述起来也会有点纠结,纠结的是用词用句够不够简洁,别人能不能看完就知道这里讲的是什么,往往一篇 1,2 千字的文章要写上一整天,回头来看,需要改动的地方或是纠结的地方还是很多。看来还是写的不够,像老师说的,大量的练习是必要的;不知道坚持几年后,在写一篇类似的文章,会不会相比之前更加高效、清晰、明朗,自己会不会有不一样的感受和认知,感觉这是成长的必经之路
作者回复: 能够看到自己的不足是提高的前提,你已经在路上了。
2019-04-163 - lyning一般要写什么呢?哪些重要哪些不重要呢?
作者回复: 需要写什么,就写什么,想写什么,就写什么。
2019-03-213
收起评论