如果难以阅读,就难以构建

发布: (2025年12月3日 GMT+8 02:00)
6 min read
原文: Dev.to

Source: Dev.to

Hello, I’m Maneshwar. I’m working on FreeDevTools online — a free, open‑source hub where developers can quickly find and use tools without the hassle of searching all over the internet.

在 1979 年,新加坡总理李光耀谈到了政府中使用清晰、简洁英文的重要性。几十年后,这句话同样适用于今天的技术和软件世界。

技术领域的沟通问题

我们的行业构建了复杂的系统——分布式服务、微服务、机器学习流水线、云基础设施、可扩展架构。但虽然技术呈指数级发展,沟通质量却往往没有同步提升。

我们都见过这种情况:

  • PRD 和 RFC 里充斥着没人懂的行话
  • 工程邮件和 Slack 讨论串往往写得比实际需要的长一倍
  • 文档解释了所有内容,却没有说明你真正需要的东西
  • Pull Request 的描述只有“fix”,代码改动却有 400 行

我们过度赞美聪明,却忽视了清晰。

清晰推动团队前进,复杂拖慢进度。
“不要靠使用大词来取悦他人;用思想的清晰来打动人心。” — 李光耀

把“政府”换成“软件工程”,依然成立。

写作要让任何人都能懂

在撰写设计文档、入职指南,甚至提交信息时:

  • 假设读者对背景一无所知
  • 用最简单的词表达你的意思
  • 去掉形容词和冗余内容
  • 拆分长句
  • 用具体的陈述取代模糊的说法

如果你的文字需要解码才能理解,那已经失败了。

好测试: 一个新实习生能在一次阅读后理解核心思想吗? 如果不能,就重写。

糟糕的写作会毁掉开发速度

李光耀曾举例官员写的令人困惑的句子——虽然语法正确,却逻辑毫无意义。我们在技术领域也常用类似的废话:

  • “我们应该在跨职能服务层之间利用战略协同效应。”
  • “通过异步并行化并发保证来优化系统吞吐量。”
  • “需要进行架构重构以实现可扩展的弹性。”

这到底是什么意思?

更好的表达方式:

  • “两个团队可以共享同一个服务,而不是各自重复工作。”
  • “并行运行任务,让系统更快完成。”
  • “重新设计,使其在流量增加时不会崩溃。”

如果你的想法足够强大,就不需要华丽的装饰。

写作 = 思考

如果思考不清晰,就写不出清晰的文字。如果你难以用简单的方式解释某件事,说明你还没有真正弄懂它。写作迫使我们澄清思路,这也是为什么最优秀的工程师往往能产出出色文档的原因。

让反馈成为常态

李光耀曾让助理帮他纠正文字。工程团队也需要同样的文化:

  • 对不清晰的 PR 描述提出评论(比如问:“这是什么意思?”)
  • 指出歧义之处
  • 鼓励重新写作

不是挑刺,而是防止后期混乱。开放的沟通加速进展,沉默则会扼杀它。

为什么这对软件的未来至关重要

随着公司规模扩大,沟通才是真正的瓶颈,而不是计算能力。代码可以重构,基础设施可以升级。浪费在相互理解上的时间是技术行业最昂贵的成本。行业需要少一些华丽词藻,多一些清晰思考——少一些“复杂崇拜”,多一些简洁。

结论

写作时要做到:

  • 人人都能理解
  • 想法显而易见
  • 零歧义
  • 目的明确

因为在技术领域,就像在政府一样:

如果我们不能清晰沟通,就无法一起打造伟大的事物。

保持清晰,保持简洁

FreeDevTools

👉 查看: FreeDevTools

欢迎任何反馈或贡献者!它是在线的、开源的,随时可以使用。

⭐ 在 GitHub 上给它加星: freedevtools

Back to Blog

相关文章

阅读更多 »

开发者影响的6种类型

1. Shipping Features, Bugs, and Technical Work 它是什么:您构建的功能、您修复的 bug、以及部署到生产环境的技术工作。 为什么重要:...