做了两年后端,我越来越觉得:写代码和写文章是同一件事。
它们共用同一套底层能力
- 都要先想清楚「读者是谁」;
- 都要有清晰的结构:开头、主干、收尾;
- 都要砍掉废话,让重点自己说话。
一个好的函数,和不好的段落,毛病往往是一样的:嵌套太深、命名含糊、一个职责里塞了三件事。
我给自己定的几条规则
- 先列骨架,再填肉。 写文章前先写三个小标题,写代码前先写函数签名。
- 一段只讲一件事。 像
if里只放一个判断那样纯粹。 - 写完朗读一遍。 读着拗口的地方,大概率是结构有问题。
一个意外的收获
坚持写下来之后,我发现自己写 commit message 都变清楚了。以前是 fix bug,现在是 fix: 修正 context 取消后 goroutine 仍泄漏。半年后回看,省下的时间比写文档花的时间多得多。
所以如果你和我一样是「技术人」,别把写作当成另一门手艺。它就是你手里那把已经很顺手的刀,只不过换了个切削的对象。