写作是让高级和首席工程师与其他人区别开来的关键。它不仅仅是关于编写代码,还关于如何清晰、精确地传达复杂的技术概念、决策和推理。这是一种高效的专业能力,但在大多数工程师中,却严重欠缺。
当你是初级或中级工程师时,你的价值取决于你能实现什么。你编写代码,发布功能,修复 bug,你的影响力基本上与你的编码输出成比例。但是,当你晋升到高级职位时,情况就会改变。你对系统演进的影响力远远超出了你个人所构建的内容。你做出的架构决策会影响系统的发展,你会制定技术标准,审查代码,并写出对他人有影响的注释。
你不能再仅仅关注编码。你需要以一种能引起他人共鸣的方式传达你的想法、决策和推理。大多数工程师没有投入足够的时间来培养这项技能。例如,设计文档是一个很好的例子。好的设计文档可以改变团队对问题的看法,把失败转化为共享的学习经验,并得到非技术利益相关者的认可。
那么,什么样的设计文档才是好的呢?首先,它要以读者为中心。谁是目标读者,他们需要从文档中得到什么?面向同行工程师的文档与面向非技术利益相关者的文档是不同的。好的设计文档首先给出结论——忙碌的人只会阅读第一段,所以要让它有价值。不要提出没有推荐的选项;这通常是一种避免做出决定的方式。
好的技术写作也包括你故意省略的内容。解释为什么你拒绝了某个选项可以防止它在未来被再次提议。并且,文档要简短——目标是清晰,而不是全面。
要培养这种技能,你可以从为一个失败的项目写一篇事后分析报告开始。描述发生了什么,为什么会发生,以及如何防止它再次发生。这是工程组织中最有价值的技术写作形式之一。记录你的决策,写一份简短的架构决策记录,并限制在一页内,以强制清晰。为你的上一个项目写一个 README 文件,解释它的功能、如何运行以及背后的关键技术决策。
同时,你也可以尝试保持一个技术日记。每天花 15 分钟写下你解决了什么问题以及如何解决的。这可以帮助你培养通过写作表达技术推理的习惯,并建立一个对绩效评审或晋升申请有用的工作日志。
如果你想要建立工程深度,有资源可以帮助你。例如,Xeito 提供工具帮助你在西班牙和欧洲找到高级和首席工程师职位。但是,最终,你需要亲自付出努力来培养你的技术写作技能。
See what Xeito does end-to-end. Browse all features — application tracker, AI resume + cover letters, interview coach, 130+ job-board sync, built for remote-first developers.