Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

更新译文《“为什么”文档的重要性》 #6942

Merged
merged 10 commits into from
Apr 20, 2020
18 changes: 9 additions & 9 deletions TODO1/the-importance-of-why-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

我们中的许多人曾经盲目地遵循我们所被告知的模式,认为那一定是做这件事情的正确方式。我们就这样照做了,而没有怀疑那个模式对于我们所处的特殊情形是不是最佳选择,或者那个模式从一开始就不够好。

在我们盲目照做的时候,我们放弃了学习和深化理解、专心工作以及最终提高技术的机会。甚至我们为同事树立了另一个照做的先例,而不是鼓励他们深入钻研。
在我们盲目照做的时候,我们放弃了学习和深化理解、专心工作以及最终提高技术的机会。甚至我们为其他同事树立了另一个照做的先例,而不是鼓励他们深入钻研。

## 女孩和鱼

Expand All @@ -33,9 +33,9 @@

**——[ 来自 Ptex Group](https://ptexgroup.com/learned-story-fish/)**

女孩的妈妈切下了鱼的头和尾巴,因为她没有意识到小烤盘对曾祖母的约束才是需要这样做的原因。当她采用这个菜谱的时候,没有问为什么。曾祖母也没有意识到应该告诉她这样做的原因。于是这个女孩儿的妈妈虽然也能够做鱼,但是她做鱼的方式不是最优的。她在情况不明的时候做鱼
女孩的妈妈切下了鱼的头和尾巴,因为她没有意识到小烤盘对曾祖母的约束才是需要这样做的原因。当她采用这个菜谱的时候,没有问“为什么”。曾祖母也没有意识到应该告诉她这样做的原因。结果,这个女孩儿的妈妈虽然也能够做鱼,但是她做鱼的方式不是最优的。她是在不了解的情况下做的鱼

通过询问“为什么”,这个小女孩儿可以自信地改变菜谱,因为她知道现在已经没有了当初小烤盘的约束。
通过问“为什么”,这个小女孩儿可以自信地改变菜谱,因为她知道现在已经没有了当初小烤盘的约束。

---

Expand All @@ -58,16 +58,16 @@

在你编写代码的时候,一直问自己:

> 有没有一些影响我的工作的约束
> 是否有某些影响我工作的约束
>
> 我在做的事情中有没有需要解释才能完全明白的?

这些约束可能和这些事情有关:

* 紧迫的截止期限
* 项目所缺少的资源
* 时间紧迫
* 项目资源不足
* 我们想要缓解的已知缺陷。
* 用户流量的模式
* 用户流量模式

一些需要解释的编码方式可能是这样的:

Expand All @@ -87,8 +87,8 @@

#### 解释的案例

* 我们复制了博客模型,因为我们想要迁移到一个不向后兼容的模型
* 我们在这里避免使用常用的 API,因为已知这个 API 会在类似的用例里造成性能问题
* 我们复制了博客模型,因为我们想要迁移到一个向后不兼容的模型
* 我们在这里避免使用常用的 API,因为在我们这样的用例中,这个 API 会导致性能问题
* -$200 的特殊账户余额意味着这是一个员工账户。

## 如何更容易地发现“为什么”
Expand Down