HackerTube English?
软件边界与变化 →

交接以后,怎样查回一项决定的来由?

从注释里的设计理由走到工作记录里的操作和结果,看看接手的人能从哪一处开始复查。

本文的问题 · 1
  1. 把理由和运行记录留在哪里?

把理由和运行记录留在哪里?

Bryan Cantrill 说,注释可以留下当初为什么采用某种做法。Literate Devops 的作者把调查缘由、执行过的代码和结果放在同一份 Org Mode 文档里,同事可以追到数据如何产生、后来怎么用。

交接时,挑一条日后可能需要重新考虑的决定,看看接手的人能否分别找到当时的理由和可以复查的操作记录。前者说明团队当时的判断,后者让新维护者有办法复查这项判断的依据。

原文与时间戳 · 2
they explain not only what's going on but they give you a narrative as to why
Monktoberfest 2016: Bryan Cantrill - Oral Tradition in Software Engineering · ▶ 43:46–43:54
a thread of data generation and Usage
Literate Devops with Emacs · ▶ 14:42–14:52

读完再想一步

选一段你维护的代码,把当初的理由和后来能重做的检查分别找出来。哪一个还需要问原作者?