注意文档中的时间术语:时间的参考点是什么?

Explore workouts, and achieving AB Data
Post Reply
jrineakter
Posts: 830
Joined: Thu Jan 02, 2025 7:04 am

注意文档中的时间术语:时间的参考点是什么?

Post by jrineakter »

在功能提案或拉取请求等文档中,使用提及时间点的词语时要小心,因为隐含的参考点并不总是很清楚。

例如,拉取请求中可能有如下讨论:

第一个人:“如果文件丢失了,会发生什么?”

第二个人:“目前,如果文件丢失,系统就会崩溃。”

这里的“目前”所指的含义有些模糊。

“目前在 repo 中”:就目前情况而言(在我进行更改之前),如果文件丢失,它就会崩溃。
“当前处于拉取请求中”:如果您使用拉取请求中的更改进行构建,则如果文件丢失,它会崩溃。(在我进行更改之前它没有崩溃。)
功能提案文档中也存在类似的模糊性。

将会有一种方法可以逆转中子流的极性。

将来时的参照点是什么?

该特征提案包括一种反转中子流极性的方法:“现在”是系统今天的状态,没有该特征。
未来的功能提案将包括一种反 总裁电子邮件列表 转中子流极性的方法:“现在”是初始功能完成后(但在后续功能实现之前)的系统状态。
“目前”一词在功能提案文档中获得了另一种可能的含义。

“目前正在实施”:如果您在我们的趣味分支中试用该功能,它会崩溃。(我们计划修复此问题,但这就是它在当今趣味分支中的行为方式。)
我只是要求在使用时间副词时要清楚。不同的读者对参考点可能有不同的假设。

附加闲聊:时间术语还有另一个问题,那就是在长期文档中使用“最近”之类的术语。在撰写文档时,时间术语可能有意义,但几个月或几年过去后,“最近”就不那么近了。

例如,在一个内部 wiki 上,有这样一条评论:

最近对 X 进行了更改,从而改变了 Y 的管理方式。如果您有 Y,则需要对现有的 Y 执行 Z 更新。

我有一个 Y,我担心必须更新 Z。但后来我查看了 wiki 历史记录,发现那句话是几个月前添加的。¹ 所以它并不是最近才添加的。特别是,我几天前才创建了我的 Y,所以我不需要更新 Z。我的 Y 是已更新的。

¹ 是否有一些wiki blame命令可以让您查看谁最后更改了 MediaWiki wiki 中的句子?

雷蒙德参与 Windows 的开发已有 30 多年。2003 年,他创办了一个名为 The Old New Thing 的网站,该网站的受欢迎程度远远超出了他的想象,这一发展至今仍让他感到毛骨悚然。该网站催生了一本书,巧合的是,这本书也名为 The Old New Thing(Addison Wesley 2007)。他偶尔会出现在 Windows Dev Docs Twitter 帐户上,讲述一些毫无用处的故事。

9 条评论
参与讨论。


排序方式 :
最新

凯文·诺里斯 2025 年 1 月 23 日 0

关于 MediaWiki “责备” 工具:维基媒体基金会已经开发了多种具有类似功能的工具,但它们看起来都相当复杂,而且我不确定它们是否适合用于您自己的私人 wiki 的自托管。搜索 [mediawiki 责备] 了解详细信息。

登录进行投票或回复

彼得·卡德莱克 13 小时前 0


登录进行投票或回复

Martin Ba 2天前 1

我想说,相对时间参考很麻烦,但真正让我抓狂的是文章/(产品)文档中根本没有绝对的时间参考。

你获得了一个有趣文章的链接,但没有任何内联或标题信息表明这篇文章是何时撰写或发布的。
然后你必须四处寻找元数据或使用 Wayback Machine 来找出这条特定信息首次出现的时间。
这种情况太常见了。
登录进行投票或回复

Simon Farnsworth 2 天前 ·已编辑 0

这让我想起了您的之前的帖子“论将产品功能命名为‘新’的危险”,其中各种评论者都举了一些被称为“新”的东西的例子,但实际上,它们已经不再是新的了。

我最喜欢的是 Daniel Rose 的地区 - 德国的一部分,有“alte Neubaugebiet”和“neue Neubaugebiet” - 即“旧新开发区”和“新新开发区”。但也有新学院(牛津最古老的学院之一,牛津 75% 的学院都比新学院新)和 Altneu Schul(旧新犹太教堂),
Post Reply