哈哈小说
第 8 卷 · 把电搬下来 · 第 260 章 · 37 段 · 0 字

版本

v1.1更新的第二天,卫越发来一条消息:「「关于本报告」你有没有想过做版本记录?」

陆衍在想别的事,「什么意思,」他说。

「就是每次这个文件有变动,记一条:改了什么,因为什么改,」卫越说,「我们代码仓库里所有东西都有这个,说明文件没有。」

「说明文件,」陆衍说,「没想到。」

「我觉得应该有,」卫越说,「尤其是像这次——v1.1那一段加进去,是因为连思妍法务问了那个问题。这个原因,值得记。」


陆衍把这个放在心里想了一下。

「关于本报告」这份文件,从冯树提议写、陆衍起草三稿、三段话定稿,到v1.1加第四段——每一次变动背后都有一个原因,都有某个具体的事让他们看见原来写得不够清楚。

这些原因,如果不记,以后只会知道文件现在是什么样,不知道它为什么是现在这个样子。

插图

「好,做,」陆衍说,「从v1.1开始倒着记——v1.0的时候写了什么为什么,v1.1加了什么为什么。」

「我做个格式,」卫越说,「你来写内容。」


格式来得很快,卫越用文档模板做的,两栏:「版本/日期」和「改动原因」,底下是「本次改动内容」。

陆衍先写v1.0:

「v1.0 | 三段话初稿。原因:冯树建议写一份说清楚工具做什么不做什么的说明,供内部统一口径。三稿才定:第一稿技术术语堆砌,第二稿「全面覆盖」是谎,第三稿改为明确说「不做什么」——「不推断原因」「不替代专业判断」「不出具法律意见」。」

然后写v1.1:

「v1.1 | 第三段后加第四段。原因:连思妍来电,她的法务把「报告是起点」读成「还有第二份报告会来」。原文三段话说了工具不做什么,但没有说清楚「接下来由谁来做判断」。加了第四段:「后续判断、决策及处置行动由委托方独立作出;工具不提供处置建议,不参与后续处理流程。」」

插图

写完发给冯树看。

冯树看了半天,「你这个「原因」那栏,」他说,「每条都是因为有人问了什么,或者有人读出了不同的意思——不是你自己坐在那里想出来的。」

「对,」陆衍说。

「那这个记录,」冯树说,「本质上是在记一件事:谁的什么问题、让这份说明比之前更清楚了。」

陆衍把这个想了一下,「这个记录,」他说,「应该和说明文件放在一起,附在后面,不只是内部留档。」

「客户看,」冯树说,不是问句。

「对,」陆衍说,「他们在用这个工具,这个工具的说明文件是怎么来的,他们应该知道——不是「青舟的说明很完整」,是「说明是用了以后发现问题、发现了改、这样变成现在这个」。」

冯树停了一会儿,「这个我没有想到,」他说,「你说一下你的逻辑。」

插图

「一份文件的可信度,」陆衍说,「不只来自它现在写了什么,也来自它为什么是现在这样而不是别的样子——它的改动历史说明它是被真实使用、真实发现问题、真实修正过来的,不是一开始就写出来的完美文档。完美文档让人不信,有过改动记录的文档让人知道它是真实的。」

「对,」冯树说,「一份从来没改过的说明,可能是从来没有人真的看过它;一份有改动记录的说明,是有人用了、有人问了、然后改了。」

「法务那条是这个工具第一条真实用户给的改动,」陆衍说,「他不知道自己做了这件事,但他做了。」

冯树停了一会儿,「你去和连思妍说一声,」他说,「告诉她法务那个问题变成了版本记录里的第一条。」

陆衍给连思妍发了消息,把这件事说了。

连思妍回:「他大概想不到。我替他谢谢你们记下来。」


陆衍让卫越把改动记录格式化好,和「关于本报告」说明文件一起,作为附件,之后发报告的时候一同附上——不强制要求客户看,但放在那里,想看的人能看到。

插图

卫越做完发来截图,「你看一下,」他说,「排版是附在「关于本报告」后面一页,标题「说明文件改动记录」,表格两行——v1.0是三段话,v1.1加了第四段,各一行原因说明。」

陆衍看了看,「好,」他说,「就这样。」


晚上,陆衍在本子里写了几行:

v1.0写了什么,v1.1加了什么——都知道了。但为什么是这两个版本,不是别的,这个「为什么」在改动记录里。

工具不只是现在的状态,是走到现在这个状态的路。说明文件也是。

连思妍法务那个问题,变成了第一条记录。他问「还有第二份报告要来吗」,他不知道他在问一个重要的问题,但他是。

他合上本子,屉子里那份改动记录还开着,两行,v1.0和v1.1,各自一个原因。以后如果还有第三行,第四行,也是因为有人读了、问了、让这个文件变得更清楚。