如何进行真正有效果的review (评审)? 能不开的会是坚决不能开的

入职不久的一位研发同学希望能组织一个会议讨论评审他做的设计,我告诉他,你先看一下我写的一篇公司内部博客。今天把我写的这篇内部博客公开出来,希望能给业内的研发同学特别是研发负责人一点启发。

我们在实际工作中,经常要做各种review (评审), 包括设计、代码、文档等等。大家习惯性的做法,是召集相关的人开会,内容的负责人会走读一次,介绍一下,为什么这么做,这么写,然后汇集大家的意见做些调整。通过多年的实践,我认为这套方法是走过场的,是形式主义的review,难以达到review的目的。表现在几个方面:

  1. review的人没有做充足准备,思路只能跟着主讲人的思路跑,发现的问题往往是违反规范,或其他显而易见的问题;

  2. review的人提的问题是现场提的,不是经过思考提出来的,因此有可能是不完整的,甚至不合逻辑或错误的;

  3. 参与开会的人,很多是心不在焉的,整个会议是一句话都不说的,完全没有产出。

那么怎么做有效果的review呢?我们需要做到以下几点:

  1. 内容负责人提前准备好内容:对照<Amazon 的秘密管理武器 - 「6页备忘录」> 检查一下内容是否满足要求。对于特别具体的文档,比如背景、解决的问题或需求大家都十分清晰的,准备的内容可以直奔主题(但建议用参考文档的方式放在内容最后,以免有不熟悉了解的人)

  2. 在Confluence的文档里直接@,或飞书通知相关的人进行review,并给出需要收到review回复的时间。

  3. 所有需要review的人,在指定的时间之前,仔细阅读内容,将自己的反馈直接写在 confluence或飞书文档上。

  4. 内容负责人收到review反馈后,看反馈的意见是否可以接受或持不同意见。对于可以接受的,直接接受,更新内容。对于不接受的,或有疑惑的,可以在confluence或飞书里互动,但互动回合不宜超过3次,过多的话,最好语音沟通,或进行会议。

  5. 内容负责人如果觉得大家的反馈都被吸收、或疑惑都已经解决、澄清,那么无需组织任何会议,review就完成了。

  6. 如果有书面交流争执不下或模糊不清的,再决定召开会议。召集会议,参会的人,是必须已经提供过书面反馈意见的。没有提过意见的,不应该邀请参会。

原则上,任何交流沟通都应该遵循《如何高效的沟通交流》里定的原则,而且要以书面文字为主,万不得已,不采用会议方式。

这么review的好处是:

  1. 每个人是真正的review了,而且反馈、互动在系统里都有记录;

  2. 任何时候,任何人都可以参与进讨论,而且不会讨论重复的问题;

  3. 尽可能不组织会议,这样便于远程办公,便于不同时区的人协同工作;

  4. 避免滥竽充数,只听不出的人参加会议。

那么有人总认为,只有会议、语音才能给大家解释清楚自己做的工作、文档、设计或代码,这是错误的认识。任何一项工作、文档、设计等等就必须用文字或代码清晰的、逻辑的表达,只要有模糊不清的地方,一定是自己没有想清楚。你可以明确告知大家,某一块没有想清楚,还模糊,求助大家,或等自己想明白,再清晰的用文字表达,之后请大家review。

陶建辉

2021年10月18日于北京


18559bc1213f24ee6a14f68b5d46f556.png点击阅读原文,体验拥抱开源的TDengine!

  • 1
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 3
    评论
代码review评审表记录是一种用于记录程序代码评审过程中出现的问题和建议的工具。它可以帮助团队成员在进行代码评审进行有条理的记录,并提供参考便于后续的修改和改进。 评审表记录的内容通常包括以下几个方面: 1. 代码规范:记录代码是否符合团队所规定的编码规范,例如命名规范、注释规范、代码缩进等,以确保代码的可读性和可维护性。 2. 功能实现:记录代码是否按照需求文档中所描述的功能进行实现,是否有功能上的遗漏或错误。 3. 错误处理:记录代码中是否考虑到了可能出现的边界条件和异常情况,并做了相应的错误处理。 4. 性能优化:记录代码是否存在性能瓶颈或潜在的性能问题,并提供相应的优化建议。 5. 可测试性:记录代码是否易于单元测试和集成测试,并提供测试覆盖率和测试用例的建议。 6. 可扩展性:记录代码的可扩展性,即代码是否易于进行功能扩展和维护。 评审表记录的格式通常是表格形式,其中包括问题描述、问题所在的代码位置以及建议的修改或改进方式。评审表记录还可以包括评审人员的姓名和评审日期等信息。 通过记录评审表,可以将代码评审过程中发现的问题和建议进行整理和归档,便于发人员在后续的修改和改进过程中参考。同时,也可以作为发团队的经验总结,为日后的项目发提供借鉴和指导。总之,评审表记录是促进代码质量提升和团队合作的重要工具。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值