示例文章,用于展示博客的排版、目录与代码高亮。文中情境为通用示例。
有时,写代码最困难的部分发生在编辑器打开之前。我们听到一句“加一个按钮”,看到一张界面草图,或者想把一项新技术放进产品。但这些都还不是问题本身。
从结果倒推
假设一个人说:“我希望能更快找到以前写过的笔记。”我们可以立刻做一个搜索框,也可以先看看他究竟在找什么:是记得标题的文章,还是只记得其中一句话?
两种情况看起来相近,实际需要的检索范围却不同。明确预期结果,才能判断一个功能有没有完成。
把约束写在选择之前
一个小型个人博客的约束很简单:只有一个作者、通过 Git 发布、读者无需登录。这些事实比选用哪个框架更早决定系统的形状。
| 已知事实 | 对设计的影响 |
|---|---|
| 内容在 Git 中创作 | 发布过程要可以重复执行 |
| 阅读统计在线产生 | 更新正文不能重置统计 |
| 搜索面向中英文内容 | 中文检索需要真实验证 |
边界说清楚后,许多不需要的功能自然就消失了。
让规则可以被验证
“更新文章时保留阅读量”比“做好数据同步”更明确。前者能够写成一条可以执行的测试:
await publish(article)
await recordView(article.slug)
await publish({ ...article, title: '一个更准确的标题' })
expect(await viewsOf(article.slug)).toBe(1)这里验证的是用户能观察到的规则。实现可以改变,规则应该保持。
留下决策的理由
代码能说明如何执行,注释更适合说明为什么如此。把内容与阅读统计分开,是因为它们来自不同的数据源,有不同的更新时机。
下一次遇到模糊需求时,先写下三句话:谁遇到了什么问题、完成之后会有什么不同、哪些条件必须保持。接下来的代码,通常就会更少,也更清楚。