10x程序员工作法
郑晔
火币网首席架构师,前ThoughtWorks首席咨询师 ,TGO鲲鹏会会员
立即订阅
7969 人已学习
课程目录
已完结 56 讲
0/4登录后,你可以任选4讲全文学习。
开篇词 (1讲)
开篇词 | 程序员解决的问题,大多不是程序问题
免费
思考框架 (1讲)
01 | 10x程序员是如何思考的?
以终为始 (11讲)
02 | 以终为始:如何让你的努力不白费?
03 | DoD的价值:你完成了工作,为什么他们还不满意?
04 | 接到需求任务,你要先做哪件事?
05 | 持续集成:集成本身就是写代码的一个环节
06 | 精益创业:产品经理不靠谱,你该怎么办?
07 | 解决了很多技术问题,为什么你依然在“坑”里?
08 | 为什么说做事之前要先进行推演?
09 | 你的工作可以用数字衡量吗?
10 | 迭代0: 启动开发之前,你应该准备什么?
答疑解惑 | 如何管理你的上级?
划重点 | 关于“以终为始”,你要记住的9句话
任务分解 (11讲)
11 | 向埃隆·马斯克学习任务分解
12 | 测试也是程序员的事吗?
13 | 先写测试,就是测试驱动开发吗?
14 | 大师级程序员的工作秘笈
15 | 一起练习:手把手带你分解任务
16 | 为什么你的测试不够好?
17 | 程序员也可以“砍”需求吗?
18 | 需求管理:太多人给你安排任务,怎么办?
19 | 如何用最小的代价做产品?
答疑解惑 | 如何分解一个你不了解的技术任务?
划重点 | 关于“任务分解”,你要重点掌握哪些事?
沟通反馈 (12讲)
20 | 为什么世界和你的理解不一样
21 | 你的代码为谁而写?
22 | 轻量级沟通:你总是在开会吗?
23 | 可视化:一种更为直观的沟通方式
24 | 快速反馈:为什么你们公司总是做不好持续集成?
25 | 开发中的问题一再出现,应该怎么办?
26 | 作为程序员,你也应该聆听用户声音
用户故事 | 站在前人的肩膀上,领取属于你的高效工作秘籍
27 | 尽早暴露问题: 为什么被指责的总是你?
28 | 结构化:写文档也是一种学习方式
答疑解惑 | 持续集成,一条贯穿诸多实践的主线
划重点 | 一次关于“沟通反馈”主题内容的复盘
自动化 (12讲)
加餐 | 你真的了解重构吗?
29 | “懒惰”应该是所有程序员的骄傲
30 | 一个好的项目自动化应该是什么样子的?
31 | 程序员怎么学习运维知识?
32 | 持续交付:有持续集成就够了吗?
33 | 如何做好验收测试?
34 | 你的代码是怎么变混乱的?
35 | 总是在说MVC分层架构,但你真的理解分层吗?
36 | 为什么总有人觉得5万块钱可以做一个淘宝?
37 | 先做好DDD再谈微服务吧,那只是一种部署形式
答疑解惑 | 持续集成、持续交付,然后呢?
划重点 | “自动化”主题的重点内容回顾汇总
综合运用 (7讲)
38 | 新入职一家公司,怎么快速进入工作状态?
39 | 面对遗留系统,你应该这样做
40 | 我们应该如何保持竞争力?
答疑解惑 | 如何在实际工作中推行新观念?
划重点 | “综合运用”主题内容的全盘回顾
总复习 | 重新审视“最佳实践”
总复习 | 重新来“看书”
结束语 (1讲)
结束语 | 少做事,才能更有效地工作
10x程序员工作法
登录|注册

28 | 结构化:写文档也是一种学习方式

郑晔 2019-03-08
你写文档吗?我知道,你可能并不喜欢写文档,因为在你眼中,写文档是繁琐的,是旧时代软件工程的产物。
最开始我对写文档的印象也不好。
我的职业生涯是从一个通过了 CMM 5 级认证的大企业开始的。可能今天很多程序员已经对 CMM 感到陌生了,它是能力成熟度模型(Capability Maturity Model for Software)的缩写,用来评估一个组织的软件开发能力,曾在国内风靡一时,许多软件公司都以拥有 CMM 认证为努力方向。
在这个极其重视过程的企业里,文档是非常重要的一环。但我看到的真实场景却是,一个软件已经上线运行了,大家才开始为了应付过程纷纷补写文档。
每个部门都有专门的过程负责人,要求你严格按照格式写文档,保证字体字号的正确性。然后,用 A4 纸将文档打印出,封印在一个仓库里,再也无人问津。
然而,文档却是非常重要的。后来,我到过很多公司,凡是我能够比较快上手的,通常都是有比较详尽的文档,而那些文档缺失的公司,想要把信息梳理清楚,往往会花很长时间。
另外,我学习很多软件开发的相关知识,通常也是依赖各种各样的文档。对我们程序员这个走在时代前列的群体来说,大量阅读文档就是我们日常工作的一部分。
你发现矛盾了吗?一方面,我们讨厌写文档,另一方面,文档却对我们的工作学习有着不可忽视的作用。
取消
完成
0/1000字
划线
笔记
复制
© 版权归极客邦科技所有,未经许可不得传播售卖。 页面已增加防盗追踪,如有侵权极客邦将依法追究其法律责任。
该试读文章来自付费专栏《10x程序员工作法》,如需阅读全部文章,
请订阅文章所属专栏。
立即订阅
登录 后留言

精选留言(25)

  • 极客不落🐒
    金字塔原理的四个基本原则:“结论先行”(一次表达只支持一个思想,且出现在开头)、“以上统下”(任一层次上的思想都必须是其下一层思想的总结概括)、“归类分组”(每组中的思想都必须属于同一范畴)和“逻辑递进”(每组中的思想都必须按照逻辑顺序排列)。前面两个特点是纵向结构之间的特点,后面两个特点则是横向结构之间的特点。以上内容收集整理自李忠秋老师的《结构思考力》,感兴趣的小伙伴可以看看。

    作者回复: 多谢补充!

    2019-03-09
    1
    9
  • 西西弗与卡夫卡
    文档极其重要,有时候说半天,不如文字半篇。最近我常用来整理思路的文档模版是OKR结合影响地图。OKR用来描述战略目标和是否达成的衡量标准,而KR又成为影响地图的Why,接下来是Who,即那些会对KR产生正向反向影响的角色。然后是How,即这些角色要做哪些会影响KR。最后从中找出当前最有效的路径制定执行计划

    作者回复: 很好的分享!

    2019-03-08
    8
  • 谭鹏
    写留言 也是一种输出吧.
    确实,小组里我最先学习的react native,并且带领安卓组一起搭建 能各自积累各自组件,也能方便测试来测试的架构 ,相继作出了3个应用,然后 我们经理就让我给大家做培训,我以为我很深入了解了 ,结果写文档的时候发现自己无从下手,然后演讲的时候自己发现缺失了好多细节, 事后自己深刻总结了一下 ,发现是自己是平时不积累,临时抱佛脚,脑子里根本没有一个结构,还老是想一下子就能讲的很好。现在开始注意平时的积累了 ,比如看书的时候先花时间看目录 先搞懂脉络和结构

    作者回复: 欢迎多留言!

    2019-03-08
    5
  • David Mao
    非常同意文中的观点,学习知识最高的境界是输出。
    1.结合隔壁《软件工程之美》的专栏,学习的四重境界,器->术->道->传道。输出实际是
    四重境界里的最高境界:传道。
    2.作为职场老司机,深有体会,想把自己以为很清楚的东西讲出来,让别人理解的很清楚,没那么简单,
    尤其是把东西讲给非专业人士。
    3.之前听到一个故事,国外某大公司在全球招募区块链运营主管,面试了很多人,99%的人把区块链讲给没听过的人都讲不清楚。
    4.写作和演讲是持续输出最好的方式,因为在这个过程中和过程后,有很多未知的问题,对作者和演讲者是一个考验。

    作者回复: 多谢分享!

    2019-03-09
    4
  • 陈斯佳
    老师的一句“无他,唯手熟耳”道出了把知识变成能力的关键点。知识不是力量,习惯才是力量。你只有把这些知识,经过不断的刻意练习,把它融入到你的一言一行中,才会真正的产生力量。
    2019-06-05
    1
  • 饭℡特稀♥
    文档是有,很多,很乱,公司很多文档描述的类、方法啊再代码都搜索不到,这样的文档真的很坑啊!

    作者回复: 用文档注释代码在我看来是一件很坑的事,最好的代码应该是自注释的。

    2019-04-24
    1
  • kevin
    从为什么写文档难,到输出可以更好的提升自己和组织知识,以及通过金字塔原理来组织结构,郑老师的分析讲解太棒了

    作者回复: 你已经看到了知识结构。

    2019-04-10
    1
  • lyning
    一般要写什么呢?哪些重要哪些不重要呢?

    作者回复: 需要写什么,就写什么,想写什么,就写什么。

    2019-03-21
    1
  • Xunqf
    读书学习要记笔记,上学的时候就经常说“好记性不如烂笔头”,工作也是如此,每当到月底或者年底考评的时候,往往就记不得自己这个月或者这个季度以及今年都做了啥,好像什么都没做,但是又好像每天都很忙,总结很重要,做过的事情最好能形成文档!

    作者回复: 这种总结有价值,但我更鼓励输出,可以得到反馈的那种。

    2019-03-08
    1
  • 风翱
    一是技术分享,二是代码审核时候的讲解说明。

    作者回复: 技术分享可以多做,自己最受益。

    2019-03-08
    1
  • One day
    今天记住了,多输出,让知识结构化,多练习,无他,唯手熟尔。另外可否有机会拜读老师的blog呢

    作者回复: 有一件悲伤的事情,我blog的站点悄无声息地关闭了,我都没来得及备份。

    2019-03-08
    1
  • 丁丁历险记
    开发界很痛苦的两件事,一代码开发完了,被要求写文档。二 接手一个项目,没有文档。
    读文档已成为日常必备。
    写文档的难点
     1 很多人回避写文档的真正原因是,他掌握的内容不能很好地结构化。
       将零散的知识结构化,有很多种方式,但输出是非常关键的一环。
    懂和能输出是两个境界。
    知识结构重要性。 微服务, unix只做一件事,把他做好。

    知识对外输出是重要的反馈方式。 费曼学习法。

    大神 输出很强。
    金子塔原理。

    作者的经历,正向循环。
    常年坚持对外输出。
    2019-11-17
  • 长期规划
    写文档的确很好
    1 使自己知识系统化,结构化,文档一般是树状,可以用思维导图进一步精炼
    2 信息传播,同时也能提升自己写作甚至演讲水平,提升影响力。写出来的东西最好分享出来,这样别人能帮人改进,交流碰撞会让自己受益匪浅,也增强在公司,行业的影响力
    2019-09-06
  • 春之绿野
    这篇真是赞,解答了我对文档的全部疑惑。刚好正在得到看有效训练你的结构化思维的课,配合服用效果更佳
    2019-09-04
  • 陈斯佳
    老师,问您一个问题,你平常每天大概花多少时间用来输出写技术博客?我现在感觉每天扣除上班睡觉学英语的时间,基本都没剩多少时间了……

    作者回复: 我的时间也不多,主要是利用周末休息时间写一些东西。

    2019-08-20
  • leslie
    做了多年:其实发现虽然电脑里有一堆之前自己的coding,但是却都只是用到时去翻找;其实欠缺的是定期的整理汇总,不断的定期总结-一段时间后再看一定会发现自己的纰漏。
    前进中看过去的自己:现在的自己和过去的做对比-对比中前进。
    2019-05-27
  • pyhhou
    最近开始坚持每周写一篇跟技术相关的文章,也是不知道要写什么,有时写写算法,有时写写最近学到的东西,但是大多都只是简单描述一些知识点,还没有到发表自己深度看法的程度;即使这样,还是发现有时候看似自己熟悉的不能再熟悉的地方,详细描述起来也会有点纠结,纠结的是用词用句够不够简洁,别人能不能看完就知道这里讲的是什么,往往一篇 1,2 千字的文章要写上一整天,回头来看,需要改动的地方或是纠结的地方还是很多。看来还是写的不够,像老师说的,大量的练习是必要的;不知道坚持几年后,在写一篇类似的文章,会不会相比之前更加高效、清晰、明朗,自己会不会有不一样的感受和认知,感觉这是成长的必经之路

    作者回复: 能够看到自己的不足是提高的前提,你已经在路上了。

    2019-04-16
  • 李冬杰
    讨厌写文档,讨厌别人不写文档,唉……

    作者回复: 哈哈哈,是这个道理。

    2019-03-19
  • 小白菜
    对啊,其实输出有好几种方式,写文章是比较有用的一种方式,方便别人也能收获自己
    2019-03-12
  • 目前组织内的文字性输出平台主要在企业微信中的乐问和乐享;说话方式的是部门内定期的主题分享,鼓励说出来和问出来,旨在要求分享者认真准备,聆听者认真思考。金字塔是个值得推广的材料组织方法,对写对说都适用,另一个需要锻炼的是对不同背景人群的演讲,尤其程序员,习惯一上来就是细节,对于业务线上的同事就效果不佳,要是对客户就更那啥了~

    作者回复: 先鼓励大家尝试输出,再帮他们改进。

    2019-03-10
收起评论
25
返回
顶部