减少错误,逆向思考的工作方法

不知道目的地的情况下走路,谁也不愿全力前进。

我们从亚马逊的内部新闻稿开始,聊聊为什么要写README文档,它的意义何在。

亚马逊的内部新闻稿

亚马逊有一个传统,如果员工想给贝佐斯或高管提议做一件事,首先要写一篇关于这件事的新闻稿,因为是你要将一个新东西带到这个世界,你要全面思考它的未来。

写内部新闻稿实质就是基于户需求开发,它也是推动亚马逊成长的强大力量。在亚马逊工作3年多时间的布朗回忆说:

那是给我留下深刻印象的事情之一。 如果某人提出一个有趣的想法,如果他们说「哇,我会发现这是有用的」,然后紧跟着的问题就是「会有客户发现这是有用的吗?」

通过写新闻稿,让项目发起人以终为始,逆向推理——从客户和市场开始,以结果为导向思考整件事。如果不能想清楚产品卖点,为用户解决什么问题,提供什么价值,通常新闻稿也会写的很艰难。

我们习惯的思维方式是正向的,从现在到未来,自内向外,由我及他——我有什么优势,我能提供什么资源。不习惯从用户需求角度思考,对方需要什么,我要解决什么问题。

关于怎样写内部新闻稿,下方参考资料中有一篇文章,感兴趣可以看看。今天我介绍的重点是相同原理的方法——工程师为开发程序模块而创作的 README(自述)文档。你可以将README文档理解成工程师写给其他工程师的新闻稿。

README 的由来

README(读我)最早可追溯到1970年前,那时的打孔卡片上的便签纸上就写着“READ ME!”。

一位网友认为“README”可能来自《爱丽丝漫游仙境》,因为其中一瓶药水和一个月饼上分别贴着“DRINK ME”(喝我)和“EAT ME”(吃我)的标签。

README 自出现就全部大写,大写目的是醒目,提醒关注。让使用者注意——看我,看我,这是下一步行动前要知道的重要信息。这份至关重要的文档要实现什么功能及遵循哪些原则呢?

README 为谁而写

README文档的第一读者是创作者自己,然后才是使用者与项目合作者,对创作者有更重要意义。

创作者:全面思考

自述文档首先是备忘,如果没有它,创作者过段时间看那些功能代码,自己也会觉得陌生。

其次,它帮助完成信息闭环,在撰写自述文档时,你会思考整个项目的来龙去脉,尽早发现可能出现的错误。

所以,README文档在动手写代码前就应形成一个初始版本,为未来的工作一个参照。当你想增加新东西时,先 Read README,避免为错误的,没人使用的功能而劳作。

使用者:了解功能

如果你的工作有一份清晰的自述文档,其他要调用你模块的工程师,就不需要阅读你的源代码也能立即抓住你的精妙想法。

自述文档就是一份简历,优秀的简历能增加模块的使用率,帮助使用者快速上手,让你的工作发挥更大的价值。

合作者:有效协作

如果你跟其他人一同工作,提前让他们知道你要实现的功能和提供的接口,他们就不需要等你实现后才能开展工作,你们可以并行工作。

如果没有说明文档,你们还会对同一问题反复讨论而没有结果。当每个人都有一个写出来的想法时,大家可以在一起交流与迭代。

README创作原则

基于上面说明,一份自述文档要做的是:

  1. 告诉他们这是什么 (使用场景)

  2. 告诉他们在实际使用中是什么样子

  3. 告诉他们使用的方法

  4. 告诉他们其它相关的细节

在创作你的README文档时,下面原则是有指导意义的:

1.保持简短、直观

没有人会读长长的自述文档,要尽可能的简短,细节在单独的页面补充。除了简短还要直观。为了让读者更容易阅读,你可以用图片,功能截图,Gif 动画,文字等多种格式。

2.借鉴优秀的做法

所有的坏东西各有各的坏,所有的好东西都有相同的特点,以史为鉴,学习别人的格式,让你少走弯路。

3.符合认知漏斗

自述文档应该符合「认知漏斗」——立起来的上宽下小的漏斗。最前面的信息最宽泛——用一句话介绍功能亮点。

越往下越具体,只有非常感兴趣的人才会关注下面的内容,要将细节放在下方,这样也为其他人节省时间。

小结

芒格在不同场合多次强调反过来想,总是反过来想,我们就能减少很多不必要的错误。养成反过来想的习惯,能让我们抓住重点而解决问题。

当我们做一件事时,不妨想象已经实现,创作README文档,从后往前推,这一思考习惯让我们少犯错误,少做无用功。

相关文章

将芒格思维模型融入日常行动,卡片盒项目的自述文档

参考资料:

亚马逊内部新闻稿

https://www.huxiu.com/article/113502.html

README 驱动开发

https://tom.preston-werner.com/2010/08/23/readme-driven-development.html

README的艺术

https://github.com/noffle/art-of-readme#readme

(0)

相关推荐

  • 油管 YouTube 可能成为亚马逊的新竞争对手

    新冠肺炎疫情不但助长了网购风气和企业数字化转型,连大公司也会想利用这个时机抢占新市场.这个大公司不是别人,正是全世界最大的公司 – 谷歌. 据报,谷歌已经计划将YouTube开辟电子商务新功能,将通过 ...

  • 学会逆向思考,扶摇生财思维

    一 人都是有期望心理的.刚着手一件事就想马上能见到很高的正向回馈. 这是正常的,但是不正常的是开始着手的时候没有一点点方向和计划. 这就导致了很多时候试错时间和成本成倍的增加. 所以学会逆向思维就显得 ...

  • 打通赚钱任督二脉的一个方法,学会逆向思考,举一反三

    说真的,在网上找个靠得住的老师不容易. 穷人会教你如何节俭生活,富人会教你如何奢侈,坏人会教你如何欺抗拐骗,牌友的人只会催你打牌,酒友的人只会催你喝酒.跟什么样的人为伍,你注定要成为什么样的人. 人生 ...

  • 馨月说财经:货币国际化问题需要逆向思考

    国内当前在人民币国际化问题上几乎是一面倒的看法,都认为人民币国际化是中国长期发展的必选路径,这种思潮虽然符合我国经济发展的需要,但我认为在人民币国际化的问题上也应多做一些逆向的思考,通过顺逆双向与多向 ...

  • 股市:独立逆向思考,以价值为本,关注周期,逆市布局,才有机会获得长期的超额收益

    长期而言,投资股票是保持现金购买力的最佳渠道. 一,股市行情 1,截至6月7日,沪深两市两融余额达到17362亿元,创下自2015年7月上旬以来的新高:截至6月8日,融资余额为15857亿元,同样创下 ...

  • 逆向思考:鸡蛋怎么吃最不健康?

    蛋类是优质蛋白质的最佳来源之一,其中还含有12种维生素和多种矿物质,少量的omega-3脂肪酸,大量的卵磷脂,还有叶黄素.玉米黄素.甜菜碱等很多保健成分.除了胆固醇高点之外,蛋类简直是无可挑剔的食物. ...

  • 逆向思考:文明程度相近的地外文明处于何位置才能探测到地球

    majer @ 2021.06.25 , 14:38 如果其他恒星系中存在外星文明,他们是否能够探测到我们?这是与当前搜寻地外文明的方式完全相反的思路,但却不一定能轻松给出答案. 尽管如此,一支天文学 ...

  • 逆向思考:基金圈的夫妻档居然都很优秀

    我11月的时候写了一个文章,叫<逆向思考:历史上有过老鼠仓的基金产品居然业绩普遍还行? >,最近因为几个看好的基金经理全被限购,不由得让我开始想其他的办法解决,比如找同一个公司的基金经理( ...

  • 鬼谷子劝世良言:学会逆向思考,真正的聪明人都明白的大智慧!

    所谓的聪明人,往往是不安常理出牌. 一 三国的历史,其实比<三国演义>更精彩.有一年,张邈背叛了曹操,投靠了吕布.这事本来在风云变幻的三国时代是件再正常不过的事情,可是曹操的一家老小在张邈 ...

  • 屠格涅夫《爱之路》的逆向思考

    读大学时在每月10元生活费中省吃俭用买了一本屠格涅夫诗集,当时就被看着像散文的诗歌<爱之路>所感动,请允许我复制这首短诗:"一切感情都可以导致爱情,导致热烈爱慕,一切的感情:憎恨 ...