2022W23 - 乐高与鹦鹉螺
2022-06-14 22:27:15

忙到脱发的一周,想到要写周报还是尽量看了点东西。

Documenting code

继续读 Five strategies for documenting code,有两个 approach 很有启发:「乐高」和「鹦鹉螺」。

乐高

「乐高」的方式是指从底层开始逐级往上构建代码,有点像是在拼乐高。典型代表是 Ebay 的教程,大致是五个步骤:

  1. 准备环境和基础代码。

  2. 添加调用第一个 API 的代码,展示结果。

  3. 添加调用第二个 API 的代码,展示结果。

  4. 添加用户界面的 HTML 和 JS。

  5. 运行代码。

「乐高」方式的难点在于 TW 可能没有开发者所遵循的 build-up logic。SME 提供了已完成的代码后,你往往只能线性地理解代码,无法将它逆向地拆解成基础的乐高 block。

鹦鹉螺

「鹦鹉螺」是另一种逻辑。想象一下「鹦鹉螺」的形状:从最简单、最核心的 pattern 开始,让用户了解到最简单的代码逻辑,然后循序渐进地让代码变多变复杂。

Nautilus

「鹦鹉螺」的形状让人想到斐波那契数列。这不就是技术传播内核的 metaphor:start small and gradually grow larger and larger as needed.

这里可以把教人读代码(documenting code)想像成是教人画画——你要说这个我可不困了——当你要教一个新手如何画出一副蒙娜丽莎,你不会告诉他从画布顶部开始,一路画到画布底部,which is absolutely nuts。

Mona Lisa

合理的思路是首先做基础的抓型,画出一个代表头部的椭圆,按比例画出躯干的外部线条,其次把较大的五官/肢体部分的形状细化出来。完成抓型之后,根据透视和人体结构调整细节,等比例基本没问题了,就开始刻画细节。有了勾线精草之后再考虑上色。没有人会一上来就铺色,画她的眼睛👀。

Documenting code 的思路也是如此,先打好地基,再添加细节。当用户学会最简单的逻辑 pattern 后,ta 就能将简单的逻辑扩展为更复杂的解决方案。然鹅识别出最核心的逻辑对 TW 就很难了。

API stylebook

发现一个超有用的网站 API stylebook,这里收集了一些优秀的 API Design Guidelines,包括 Atlassian、Google、Microsoft、Heroku 等等。

这得好好学学

Protocol buffers

因为 API reference 的上游涉及到 protobuf 文件,而我对这个东西一无所知,所以周末读了下官方文档

protocol buffers 是一种跨语言、跨平台的序列化结构化数据的可扩展机制。它与 JSON 类似,但它更轻量、快速,可以生成原生语言约束(native language bindings)。

读了,但完全没读懂。

租房

周末约中介线上看房,租到了非常满意的小房子。看了一整天出租屋改造视频,我已经迫不及待了XD。

新学到的省钱小技巧:在闲鱼搜索关键词民宿倒闭,能买到很多便宜美貌的家具和软装(x

画画

随机抽取一个幸运 tony,给我剪了个头,大概有五六年没有这么短过了。

剪头后想了想人画不同步了浑身不舒服(???),又重新画了个头像。很久没动笔了,还是要说,CSP 笔刷 yyds。

头像变了

旧头像参考 Notion,新头像参考一位不认识的韩国画师


发完版了,我又好了。

魔都迁徙计划进度条:◾️◾️◾️◾️◾️◾️◾️◾️◾️▫,就差人没去了。

新的城市,新的房间,新的头像(?),小黄要开始新生活了。