原文链接: https://geekplux.com/newsletters/22
这是 GeekPlux Lab 第二十三期,每期都会同步发布在我博客的周刊页面。目前已经有 2587 个同学订阅了本周刊,也欢迎你邮箱订阅,可以第一时间收到更新推送。
这周我来分享我最近的一些收获。
文档先行
这两周的工作异常顺利,因为基本上都在写代码,而前几周则在不停的梳理需求和整理文档。这次的任务我是文档先行,在文档中把技术方案和可能性都列出来后交给小组 review,通过多次讨论、不断整理出各种边界情况后,再逐一列出解决方案。最后觉得几乎能想的都想到之后才开始写代码,编码体验几乎是一马平川。
文档先行还有几个好处是:
- 在编码结束需要提供文档(包括各种架构图)的时候,直接就有现成的,只需要略微修改措辞和概述
- 因为经过小组多次讨论,所以全小组都做到了 knowledge share,每个人都知道这个项目怎么回事,为什么要这么设计,上下文很清晰
- 因为大家都知道项目的上下文,所以 code review 顺畅无比
- 整个文档的修改过程,就是初版的 CHANGELOG
其实这才是学生时代课本中讲到的软件工程方式,但这么多年鲜有实践的机会。在整个项目做完之后,我把项目概述、文档总结、codebase、项目管理条目、OKR 条目等一并整理发给老板,感觉他很满意。我也是从今年开始着重开始思考一个程序员和一个工程师的区别,可能前者像一个泥瓦匠,而后者更像一个建筑师。为此我最近也在阅读一些相关的书籍以及文章,这里推荐:
- Staff Engineer – 这是 Will Larson 的一本书,我刚读了不到一半,也是别人推荐给我的,在此我再五星推荐给各位。这个网页版本和电子书内容差不多。
- [What does sponsorship look like](https://l…
本文转自: https://geekplux.com/newsletters/22
本站仅做收录,版权归原作者所有。